CHAILink SDK  Version 1.3
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages

List of all Controller functions. More...

Output Identity Handling

CLC_ErrorCode Controller_GetInfo (CPHOBJECT const hController, CPCONTROLLERINFO *const pControllerInfo)
 Get Controller Information. More...
 
CLC_ErrorCode Controller_QueryParameterPath (CPHOBJECT const hController)
 Queries the currently assigned parameter path. This is an asynchronous operation, the notification NH_CONTROLLER_ONPARAMETERPATHREPLY will be called later. More...
 

Event handling

CLC_ErrorCode Controller_RegisterNotificationHandler (CPHOBJECT const hController)
 Register notification handler for a controller. More...
 
CLC_ErrorCode Controller_UnregisterNotificationHandler (CPHOBJECT const hController)
 Unregister notification handler for a Controller. More...
 

Controller management

CLC_ErrorCode Controller_Assign (CPHOBJECT const hController, CPCONTROLLERASSIGNMENT const *const pAssignment)
 Assign the controller. More...
 
CLC_ErrorCode Controller_Unassign (CPHOBJECT const hController)
 Unassign the controller, back to the preferred settings. More...
 
CLC_ErrorCode Controller_EnterLearningMode (CPHOBJECT const hController)
 Enter learning mode. On success, the notification handler NH_CHAI_NOTIFICATION is called signaling CNT_GlobalLearningModeRunning If a Learning is requested but already in progress, the method returns ERR_GlobalLearningRunning. More...
 
CLC_ErrorCode Controller_SendValue (CPHOBJECT const hController, CPUINT16 const wValue, ControllerSendModes const mode)
 Send a value using the assigned message. If the assigned message is a Selector, the value is sent in proportional mode (see SelectorMessage_SetProportionalValue) More...
 
CLC_ErrorCode Controller_SendValueWithAutomation (CPHOBJECT const hController, CPUINT16 const wValue, ControllerSendModes const mode, CPBOOLEAN const fWriteToEnd, CPBOOLEAN const fTouch, PerformanceMessageAutomationStates const state)
 Send a value using the assigned message, specifying automation The value is sent in proportional mode (see SelectorMessage_SetProportionalValue) if the assigned message is a Selector and if the value is not relative. More...
 
CLC_ErrorCode Controller_SendTextValue (CPHOBJECT const hController, CPCHAR8 const *const utf8Value)
 Send a text value using the assigned message (only for controllers assigned to text parameter) More...
 
CLC_ErrorCode Controller_SendTextValueWithAutomation (CPHOBJECT const hController, CPCHAR8 const *const utf8Value, CPBOOLEAN const fWriteToEnd, CPBOOLEAN const fTouch, PerformanceMessageAutomationStates const state)
 Send a value using the assigned message, specifying automation (only for controllers assigned to text parameter) The value is sent in proportional mode (see CPNS::ISelectorMessage::SetProportionalValue) if the assigned message. More...
 
CLC_ErrorCode Controller_SendDown (CPHOBJECT const hController)
 Send the message related to the button down action, if any. If the controller has been assigned with a selector: More...
 
CLC_ErrorCode Controller_SendUp (CPHOBJECT const hController)
 Send the message related to the button up action, if any. If the controller has been assigned with a selector: More...
 
CLC_ErrorCode Controller_QueryParameterValue (CPHOBJECT const hController)
 Send a query of current parameter value update This is an asynchronous operation, the notification NH_CONTROLLER_REFRESHCURRENTMODIFIERPARAMVALUE, NH_CONTROLLER_REFRESHCURRENTSELECTORPARAMVALUE or NH_CONTROLLER_REFRESHCURRENTTEXTPARAMVALUE will be called later. More...
 

Detailed Description

List of all Controller functions.