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

Go to the source code of this file.

Data Structures

struct  CPSELECTORMSG
 This structure stores data from a selector message. More...
 

Macros

#define SELECTORMESSAGE_PROFILEBITS   8
 

Enumerations

enum  SelectorProfiles {
  SP_None = 0x0000, SP_VoiceIDAvailable = 0x0001, SP_AutomationAvailable = 0x0002, SP_IndexAvailable = 0x0004,
  SP_MorphAvailable = 0x0008, SP_PreLoad = 0x0010, SP_Relative = 0x0020, SP_Trigger = 0x0040,
  SP_ProportionalValue = 0x0080, SP_RelativeOneWay = 0x0100
}
 Selector profiles. More...
 

Functions

void SelectorMessage_Clear (CPSELECTORMSG *const pSelectorMessageData)
 Clear selector message structure. More...
 
Profile handling
CPUINT16 SelectorMessage_GetProfiles (CPSELECTORMSG const *const pSelectorMessageData)
 Get selector message profiles. More...
 
void SelectorMessage_SetSourceType (CPSELECTORMSG *const pSelectorMessageData, PerformanceMessageSources const source)
 Set profile source. More...
 
PerformanceMessageSources SelectorMessage_GetSourceType (CPSELECTORMSG const *const pSelectorMessageData)
 Get profile source. More...
 
void SelectorMessage_SetRelativeMode (CPSELECTORMSG *const pSelectorMessageData, RelativeMode const mode)
 Specifies if the value is relative or not. If the value is relative, it can be casted as an int16. More...
 
RelativeMode SelectorMessage_GetRelativeMode (CPSELECTORMSG const *const pSelectorMessageData)
 Get profile relative. More...
 
void SelectorMessage_SetPreLoad (CPSELECTORMSG *const pSelectorMessageData, CPBOOLEAN const fValue)
 Set profile PreLoad. More...
 
CPBOOLEAN SelectorMessage_GetPreLoad (CPSELECTORMSG const *const pSelectorMessageData)
 Get profile PreLoad. More...
 
void SelectorMessage_SetTrigger (CPSELECTORMSG *const pSelectorMessageData, CPBOOLEAN const fValue)
 Set profile Trigger. More...
 
CPBOOLEAN SelectorMessage_GetTrigger (CPSELECTORMSG const *const pSelectorMessageData)
 Get profile Trigger. More...
 
CPBOOLEAN SelectorMessage_GetProportionalValue (CPSELECTORMSG const *const pSelectorMessageData)
 Check if the value is proportional (0x0000 - 0xFFFF) More...
 
void SelectorMessage_SetProportionalValue (CPSELECTORMSG *const pSelectorMessageData)
 Specify that the value is proportional. 0x0000: first item ... 0xFFFF: last item. More...
 
Index handling
CPBOOLEAN SelectorMessage_IsIndexAvailable (CPSELECTORMSG const *const pSelectorMessageData)
 Is Index available. More...
 
void SelectorMessage_SetIndex (CPSELECTORMSG *const pSelectorMessageData, CPUINT16 const wIndex)
 Set index. More...
 
CPUINT16 SelectorMessage_GetIndex (CPSELECTORMSG const *const pSelectorMessageData)
 Get Index. More...
 
Automation handling
CPBOOLEAN SelectorMessage_IsAutomationAvailable (CPSELECTORMSG const *const pSelectorMessageData)
 Is Automation available. More...
 
void SelectorMessage_SetAutomationState (CPSELECTORMSG *const pSelectorMessageData, PerformanceMessageAutomationStates const state)
 Set Automation State. More...
 
PerformanceMessageAutomationStates SelectorMessage_GetAutomationState (CPSELECTORMSG const *const pSelectorMessageData)
 Get Automation State. More...
 
void SelectorMessage_SetAutomationTouch (CPSELECTORMSG *const pSelectorMessageData, CPBOOLEAN const fValue)
 Set Automation Touch. More...
 
CPBOOLEAN SelectorMessage_GetAutomationTouch (CPSELECTORMSG const *const pSelectorMessageData)
 Get Automation Touch. More...
 
void SelectorMessage_SetAutomationWTE (CPSELECTORMSG *const pSelectorMessageData, CPBOOLEAN const fValue)
 Set Automation WTE. More...
 
CPBOOLEAN SelectorMessage_GetAutomationWTE (CPSELECTORMSG const *const pSelectorMessageData)
 Get Automation WTE. More...
 
Morph handling
CPBOOLEAN SelectorMessage_IsMorphAvailable (CPSELECTORMSG const *const pSelectorMessageData)
 Is Morph available. More...
 
void SelectorMessage_SetMorph (CPSELECTORMSG *const pSelectorMessageData, CPUINT16 const wValue)
 Set Morph. More...
 
CPUINT16 SelectorMessage_GetMorph (CPSELECTORMSG const *const pSelectorMessageData)
 Get Morph value. More...
 
Voice ID handling
CPBOOLEAN SelectorMessage_IsVoiceIDAvailable (CPSELECTORMSG const *const pSelectorMessageData)
 Is Voice ID available. More...
 
void SelectorMessage_SetVoiceID (CPSELECTORMSG *const pSelectorMessageData, CPUINT16 const wVoiceID)
 Set Voice ID. More...
 
CPUINT16 SelectorMessage_GetVoiceID (CPSELECTORMSG const *const pSelectorMessageData)
 Get Voice ID. More...
 
Transaction handling
void SelectorMessage_SetTransaction (CPSELECTORMSG *const pSelectorMessageData, TransactionModes const mode)
 Set Profile Transaction. More...
 
TransactionModes SelectorMessage_GetTransaction (CPSELECTORMSG const *const pSelectorMessageData)
 Get Profile Transaction. More...