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

Go to the source code of this file.

Data Structures

struct  CPMODIFIERMSG
 This structure stores data from a modifier message. More...
 

Macros

#define MODIFIERMESSAGE_PROFILEBITS   8
 

Enumerations

enum  ModifierProfiles {
  MP_None = 0x0000, MP_VoiceIDAvailable = 0x0001, MP_AutomationAvailable = 0x0002, MP_IndexAvailable = 0x0004,
  MP_MorphAvailable = 0x0008, MP_PreLoad = 0x0010, MP_Relative = 0x0020, MP_Trigger = 0x0040,
  MP_RelativeOneWay = 0x0100
}
 Modifier profiles. More...
 

Functions

void ModifierMessage_Clear (CPMODIFIERMSG *const pModifierMessageData)
 Clear modifier message structure. More...
 
Profile handling
CPUINT16 ModifierMessage_GetProfiles (CPMODIFIERMSG const *const pModifierMessageData)
 Get modifier message profiles. More...
 
void ModifierMessage_SetSourceType (CPMODIFIERMSG *const pModifierMessageData, PerformanceMessageSources const source)
 Set the Source type Tells about the message's kind of source. More...
 
PerformanceMessageSources ModifierMessage_GetSourceType (CPMODIFIERMSG const *const pModifierMessageData)
 Get the Source type Tells about the message's kind of source. More...
 
void ModifierMessage_SetRelativeMode (CPMODIFIERMSG *const pModifierMessageData, RelativeMode const mode)
 Specifies if the value is relative or not. If the value is relative, it can be casted as an int16. Generally used by push buttons and rotary encoders. More...
 
RelativeMode ModifierMessage_GetRelativeMode (CPMODIFIERMSG const *const pModifierMessageData)
 Get profile relative. More...
 
void ModifierMessage_SetPreLoad (CPMODIFIERMSG *const pModifierMessageData, CPBOOLEAN const fValue)
 Set profile PreLoad. More...
 
CPBOOLEAN ModifierMessage_GetPreLoad (CPMODIFIERMSG const *const pModifierMessageData)
 Get profile PreLoad. More...
 
void ModifierMessage_SetTrigger (CPMODIFIERMSG *const pModifierMessageData, CPBOOLEAN const fValue)
 Set profile Trigger. More...
 
CPBOOLEAN ModifierMessage_GetTrigger (CPMODIFIERMSG const *const pModifierMessageData)
 Get profile Trigger. More...
 
Index handling
CPBOOLEAN ModifierMessage_IsIndexAvailable (CPMODIFIERMSG const *const pModifierMessageData)
 Is Index available. More...
 
void ModifierMessage_SetIndex (CPMODIFIERMSG *const pModifierMessageData, CPUINT16 const wIndex)
 Set index. More...
 
CPUINT16 ModifierMessage_GetIndex (CPMODIFIERMSG const *const pModifierMessageData)
 Get Index. More...
 
Automation handling
CPBOOLEAN ModifierMessage_IsAutomationAvailable (CPMODIFIERMSG const *const pModifierMessageData)
 Is Automation available. More...
 
void ModifierMessage_SetAutomationState (CPMODIFIERMSG *const pModifierMessageData, PerformanceMessageAutomationStates const state)
 Set Automation State. More...
 
PerformanceMessageAutomationStates ModifierMessage_GetAutomationState (CPMODIFIERMSG const *const pModifierMessageData)
 Get Automation State. More...
 
void ModifierMessage_SetAutomationTouch (CPMODIFIERMSG *const pModifierMessageData, CPBOOLEAN const fValue)
 Set Automation Touch. More...
 
CPBOOLEAN ModifierMessage_GetAutomationTouch (CPMODIFIERMSG const *const pModifierMessageData)
 Get Automation Touch. More...
 
void ModifierMessage_SetAutomationWTE (CPMODIFIERMSG *const pModifierMessageData, CPBOOLEAN const fValue)
 Set Automation WTE. More...
 
CPBOOLEAN ModifierMessage_GetAutomationWTE (CPMODIFIERMSG const *const pModifierMessageData)
 Get Automation WTE. More...
 
Morph handling
CPBOOLEAN ModifierMessage_IsMorphAvailable (CPMODIFIERMSG const *const pModifierMessageData)
 Is Morph available. More...
 
void ModifierMessage_SetMorph (CPMODIFIERMSG *const pModifierMessageData, CPUINT16 const wValue)
 Set Morph. More...
 
CPUINT16 ModifierMessage_GetMorph (CPMODIFIERMSG const *const pModifierMessageData)
 Get Morph value. More...
 
Voice ID handling
CPBOOLEAN ModifierMessage_IsVoiceIDAvailable (CPMODIFIERMSG const *const pModifierMessageData)
 Is Voice ID available. More...
 
void ModifierMessage_SetVoiceID (CPMODIFIERMSG *const pModifierMessageData, CPUINT16 const wVoiceID)
 Set Voice ID. More...
 
CPUINT16 ModifierMessage_GetVoiceID (CPMODIFIERMSG const *const pModifierMessageData)
 Get Voice ID. More...
 
Transaction handling
void ModifierMessage_SetTransaction (CPMODIFIERMSG *const pModifierMessageData, TransactionModes const mode)
 Set Profile Transaction. More...
 
TransactionModes ModifierMessage_GetTransaction (CPMODIFIERMSG const *const pModifierMessageData)
 Get Profile Transaction. More...