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

Go to the source code of this file.

Data Structures

struct  CPEVENTMSG
 This structure stores data from an event message. More...
 

Macros

#define EVENTMESSAGE_PROFILEBITS   8
 

Enumerations

enum  EventProfiles {
  EP_None = 0x0000, EP_VoiceIDAvailable = 0x0001, EP_ImpulseAvailable = 0x0002, EP_ToneAvailable = 0x0004,
  EP_WaveSettingAvailable = 0x0008, EP_OffsetTone = 0x0010, EP_NoteOff2NoteOnVel0 = 0x8000
}
 Event profiles. More...
 

Functions

void EventMessage_Clear (CPEVENTMSG *const pEventMessageData)
 Clear event message structure. More...
 
Profile handling
CPUINT16 EventMessage_GetProfiles (CPEVENTMSG const *const pEventMessageData)
 Get event message profiles. More...
 
void EventMessage_SetGate (CPEVENTMSG *const pEventMessageData, EventGateModes const gate)
 Set profiles gate. More...
 
EventGateModes EventMessage_GetGate (CPEVENTMSG const *const pEventMessageData)
 Get profiles gate. More...
 
void EventMessage_SetOffsetTone (CPEVENTMSG *const pEventMessageData, CPBOOLEAN const fValue)
 Set profiles offset tone. More...
 
CPBOOLEAN EventMessage_GetOffsetTone (CPEVENTMSG const *const pEventMessageData)
 Get profiles offset tone. More...
 
Wave Setting handling
CPBOOLEAN EventMessage_IsWaveSettingAvailable (CPEVENTMSG const *const pEventMessageData)
 Is Wave Setting available. More...
 
void EventMessage_SetWaveSettingStartPoint (CPEVENTMSG *const pEventMessageData, CPUINT16 const wValue)
 Set Wave Setting Start Point. More...
 
CPUINT16 EventMessage_GetWaveSettingStartPoint (CPEVENTMSG const *const pEventMessageData)
 Get Wave Setting Start Point. More...
 
void EventMessage_SetWaveSettingBoundaries (CPEVENTMSG *const pEventMessageData, EventWaveBoundaries const values)
 Set Wave Setting Boundaries. More...
 
EventWaveBoundaries EventMessage_GetWaveSettingBoundaries (CPEVENTMSG const *const pEventMessageData)
 Get Wave Setting Boundaries. More...
 
void EventMessage_SetWaveSettingReset (CPEVENTMSG *const pEventMessageData, CPBOOLEAN const fValue)
 Set Wave Setting Reset. More...
 
CPBOOLEAN EventMessage_GetWaveSettingReset (CPEVENTMSG const *const pEventMessageData)
 Get Wave Setting Reset. More...
 
Impulse handling
CPBOOLEAN EventMessage_IsImpulseAvailable (CPEVENTMSG const *const pEventMessageData)
 Is Impulse available. More...
 
void EventMessage_SetImpulse (CPEVENTMSG *const pEventMessageData, CPUINT16 const wImpulse)
 Set Impulse. More...
 
CPUINT16 EventMessage_GetImpulse (CPEVENTMSG const *const pEventMessageData)
 Get Impulse. More...
 
Tone handling
CPBOOLEAN EventMessage_IsToneAvailable (CPEVENTMSG const *const pEventMessageData)
 Is Tone available. More...
 
void EventMessage_SetTone (CPEVENTMSG *const pEventMessageData, CPUINT16 const wTone)
 Set Tone. More...
 
CPUINT16 EventMessage_GetTone (CPEVENTMSG const *const pEventMessageData)
 Get Tone. More...
 
Voice ID handling
CPBOOLEAN EventMessage_IsVoiceIDAvailable (CPEVENTMSG const *const pEventMessageData)
 Is Voice ID available. More...
 
void EventMessage_SetVoiceID (CPEVENTMSG *const pEventMessageData, CPUINT16 const wVoiceID)
 Set Voice ID. More...
 
CPUINT16 EventMessage_GetVoiceID (CPEVENTMSG const *const pEventMessageData)
 Get Voice ID. More...
 
Transaction handling
void EventMessage_SetTransaction (CPEVENTMSG *const pEventMessageData, TransactionModes const mode)
 Set Profile Transaction. More...
 
TransactionModes EventMessage_GetTransaction (CPEVENTMSG const *const pEventMessageData)
 Get Profile Transaction. More...