CHAILink SDK  Version 1.3
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
CLC_Fct_TextMessage.h File Reference

Go to the source code of this file.

Data Structures

struct  CPTEXTMSG
 This structure stores data from a text message. More...
 

Macros

#define TEXTMESSAGE_PROFILEBITS   8
 

Enumerations

enum  TextProfiles {
  TP_None = 0x0000, TP_VoiceIDAvailable = 0x0001, TP_AutomationAvailable = 0x0002, TP_IndexAvailable = 0x0004,
  TP_PreLoad = 0x0010, TP_Trigger = 0x0040
}
 Text profiles. More...
 

Functions

void TextMessage_Clear (CPTEXTMSG *const pTextMessageData)
 Clear text message structure. More...
 
Profile handling
CPUINT16 TextMessage_GetProfiles (CPTEXTMSG const *const pTextMessageData)
 Get text message profiles. More...
 
Index handling
CPBOOLEAN TextMessage_IsIndexAvailable (CPTEXTMSG const *const pTextMessageData)
 Is Index available. More...
 
void TextMessage_SetIndex (CPTEXTMSG *const pTextMessageData, CPUINT16 const wIndex)
 Set index. More...
 
CPUINT16 TextMessage_GetIndex (CPTEXTMSG const *const pTextMessageData)
 Get Index. More...
 
Automation handling
CPBOOLEAN TextMessage_IsAutomationAvailable (CPTEXTMSG const *const pTextMessageData)
 Is Automation available. More...
 
void TextMessage_SetAutomationState (CPTEXTMSG *const pTextMessageData, PerformanceMessageAutomationStates const eValue)
 Set Automation State. More...
 
PerformanceMessageAutomationStates TextMessage_GetAutomationState (CPTEXTMSG const *const pTextMessageData)
 Get Automation State. More...
 
void TextMessage_SetAutomationTouch (CPTEXTMSG *const pTextMessageData, CPBOOLEAN const fValue)
 Set Automation Touch. More...
 
CPBOOLEAN TextMessage_GetAutomationTouch (CPTEXTMSG const *const pTextMessageData)
 Get Automation Touch. More...
 
void TextMessage_SetAutomationWTE (CPTEXTMSG *const pTextMessageData, CPBOOLEAN const fValue)
 Set Automation WTE. More...
 
CPBOOLEAN TextMessage_GetAutomationWTE (CPTEXTMSG const *const pTextMessageData)
 Get Automation WTE. More...
 
Voice ID handling
CPBOOLEAN TextMessage_IsVoiceIDAvailable (CPTEXTMSG const *const pTextMessageData)
 Is Voice ID available. More...
 
void TextMessage_SetVoiceID (CPTEXTMSG *const pTextMessageData, CPUINT16 const wVoiceID)
 Set Voice ID. More...
 
CPUINT16 TextMessage_GetVoiceID (CPTEXTMSG const *const pTextMessageData)
 Get Voice ID. More...
 
Transaction handling
void TextMessage_SetTransaction (CPTEXTMSG *const pTextMessageData, TransactionModes const eMode)
 Set Profile Transaction. More...
 
TransactionModes TextMessage_GetTransaction (CPTEXTMSG const *const pTextMessageData)
 Get Profile Transaction. More...
 
void TextMessage_SetPreLoad (CPTEXTMSG *const pTextMessageData, CPBOOLEAN const fValue)
 Set profile PreLoad. More...
 
CPBOOLEAN TextMessage_GetPreLoad (CPTEXTMSG const *const pTextMessageData)
 Get profile PreLoad. More...
 
void TextMessage_SetTrigger (CPTEXTMSG *const pTextMessageData, CPBOOLEAN const fValue)
 Set profile Trigger. More...
 
CPBOOLEAN TextMessage_GetTrigger (CPTEXTMSG const *const pTextMessageData)
 Get profile Trigger. More...