CLC_Fct_Output.h

Go to the documentation of this file.

//*********************************************************
// File:            CLC_Fct_Output.h
// Project:         CopperLan CHAILink Client SDK
// Version:         1.3
// Release Date:    2014/04/15
//*********************************************************

/********************************************************************
Software License Agreement:  CHAILink Client source code

The software supplied herewith by Klavis Technology (the “Company”) is intended and
supplied to you, the Company’s customer, for use solely and exclusively on embedded
CopperLan products needing a CHAILink Client. 
 The software is owned by the Company and/or its supplier, and is protected 
 under applicable copyright laws. All rights are reserved. Any use in violation of the 
 foregoing restrictions may subject the user to criminal sanctions under applicable laws,
as well as to civil liability for the breach of the terms and conditions of this license.

THIS SOFTWARE MUST REMAIN UNMODIFIED. NO WARRANTIES, WHETHER EXPRESS, 
 IMPLIED OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF 
 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE
IN CASE OF SOURCE CODE CHANGE BY THE CUSTOMER. IN CASE OF SUCH CHANGE, THE
COMPANY SHALL NOT BE LIABLE FOR SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
OF ANY KIND.
********************************************************************/

#ifndef _CLC_FCT_OUTPUT_H_
#define _CLC_FCT_OUTPUT_H_

#ifdef __cplusplus
extern "C" {
#endif



CLC_SDK_API CLC_ErrorCode BaseOutput_GetInfo(
    CPHOBJECT const hBaseOutput, 
    CPBASEOUTPUTINFO * const pBaseOutputInfo);

CLC_SDK_API CPBOOLEAN BaseOutput_IsCompatibleWith(
    InOutCapabilities const inCaps, 
    InOutCapabilities const outCaps);

CLC_SDK_API CLC_ErrorCode BaseOutput_GetName(
    CPHOBJECT const hBaseOutput, 
    CPCHAR8 const ** const putf8Name);

CLC_SDK_API CLC_ErrorCode BaseOutput_SetName(
    CPHOBJECT const hBaseOutput, 
    CPCHAR8 const * const utf8Name);

CLC_SDK_API CLC_ErrorCode BaseOutput_SetSectionID(
    CPHOBJECT const hBaseOutput, 
    CPSECTIONID const * const pSectionID);



CLC_SDK_API CLC_ErrorCode BaseOutput_EnableSendingDuringGlobalLearning(
    CPHOBJECT const hBaseOutput, 
    CPBOOLEAN const fEnable);


CLC_SDK_API CLC_ErrorCode BaseOutput_ClearTimeStamp(
    CPHOBJECT const hBaseOutput);

CLC_SDK_API CLC_ErrorCode BaseOutput_SetTimeStampOffline(
    CPHOBJECT const hBaseOutput);

CLC_SDK_API CLC_ErrorCode BaseOutput_SetTimeStampSongPosition(
    CPHOBJECT const hBaseOutput, 
    SongPosition const position);

CLC_SDK_API CLC_ErrorCode BaseOutput_SetTimeStampSystemTime(
    CPHOBJECT const hBaseOutput, 
    SystemTime const time);

CLC_SDK_API CLC_ErrorCode BaseOutput_SetTimeStampSystemTimeFromGlobalSynchronizedTime(
    CPHOBJECT const hBaseOutput);

CLC_SDK_API CLC_ErrorCode BaseOutput_EnableAutoTimeStampOnRecording(
    CPHOBJECT const hBaseOutput,
    CPBOOLEAN const fEnable);


CLC_SDK_API CLC_ErrorCode BaseOutput_QueryCurrentParameterValues(
    CPHOBJECT const hBaseOutput);

CLC_SDK_API CLC_ErrorCode BaseOutput_QueryCurrentParameterValue(
    CPHOBJECT const hBaseOutput,
    CPPARAMETERID const * const pParamID);




#if defined(ENABLE_OUTPUT)

CLC_SDK_API CLC_ErrorCode Output_RegisterNotificationHandler(
    CPHOBJECT const hOutput);

CLC_SDK_API CLC_ErrorCode Output_UnregisterNotificationHandler(
    CPHOBJECT const hOutput);

#if defined(ENABLE_CLOCK)
CLC_SDK_API CLC_ErrorCode Output_RegisterClockGeneratorNotificationHandler(
    CPHOBJECT const hOutput);

CLC_SDK_API CLC_ErrorCode Output_UnregisterClockGeneratorNotificationHandler(
    CPHOBJECT const hOutput);
#endif // defined(ENABLE_CLOCK)

#endif // defined(ENABLE_OUTPUT)



CLC_SDK_API CLC_ErrorCode Output_SetCapabilities(
    CPHOBJECT const hOutput, 
    InOutCapabilities const outputCaps);


CLC_SDK_API CLC_ErrorCode Output_Clock_Set(
    CPHOBJECT const hOutput,
    CPUINT16 const wBPM,
    CPUINT8 const bCPQNMultiplier);

CLC_SDK_API CLC_ErrorCode Output_Clock_Tick(
    CPHOBJECT const hOutput, 
    CPUINT16 const wTickCount);

CLC_SDK_API CLC_ErrorCode Output_Clock_SetControllerInput(
    CPHOBJECT const hOutput, 
    CPHOBJECT const hInput);


CLC_SDK_API CLC_ErrorCode Output_Clock_GeneratorCommand(
    CPHOBJECT const hOutput, 
    ClockGeneratorCommands const cmd);

CLC_SDK_API CLC_ErrorCode Output_Clock_RunFromStart(
    CPHOBJECT const hOutput, 
    CPBOOLEAN const fDispatchToAllListeners);

CLC_SDK_API CLC_ErrorCode Output_Clock_Run(
    CPHOBJECT const hOutput, 
    CPBOOLEAN const fDispatchToAllListeners);

CLC_SDK_API CLC_ErrorCode Output_Clock_Stop(
    CPHOBJECT const hOutput, 
    CPBOOLEAN const fDispatchToAllListeners);

CLC_SDK_API CLC_ErrorCode Output_Clock_SetPositionImmediate(
    CPHOBJECT const hOutput, 
    CPBOOLEAN const fDispatchToAllListeners, 
    CPUINT32 const dwPosition);

CLC_SDK_API CLC_ErrorCode Output_Clock_SetPositionPrepare(
    CPHOBJECT const hOutput, 
    CPBOOLEAN const fDispatchToAllListeners, 
    CPUINT32 const dwPosition);

CLC_SDK_API CLC_ErrorCode Output_Clock_SetPositionTrigger(
    CPHOBJECT const hOutput, 
    CPBOOLEAN const fDispatchToAllListeners);

CLC_SDK_API CLC_ErrorCode Output_Clock_FillIn(
    CPHOBJECT const hOutput, 
    CPBOOLEAN const fDispatchToAllListeners);

CLC_SDK_API CLC_ErrorCode Output_Clock_State(
    CPHOBJECT const hOutput, 
    CPBOOLEAN const fDispatchToAllListeners, 
    CPBOOLEAN const fState);


CLC_SDK_API CLC_ErrorCode Output_ClearDestinations(
    CPHOBJECT const hOutput);

CLC_SDK_API CLC_ErrorCode Output_AddDestination(
    CPHOBJECT const hOutput, 
    CPENDPOINT const * const pDestination);

CLC_SDK_API CLC_ErrorCode Output_RemoveDestination(
    CPHOBJECT const hOutput, 
    CPENDPOINT const * const pDestination);

CLC_SDK_API CLC_ErrorCode Output_RemoveDestinationByIndex(
    CPHOBJECT const hOutput, 
    CPUINT16 const wDestinationIndex);

CLC_SDK_API CLC_ErrorCode Output_GetDestination(
    CPHOBJECT const hOutput, 
    CPUINT16 const wDestinationIndex, 
    CPENDPOINT * const pDestination);



CLC_SDK_API CLC_ErrorCode Output_IsReadyToSend(
    CPHOBJECT const hOutput, 
    CPBOOLEAN * const pfIsReady);

CLC_SDK_API CLC_ErrorCode Output_Send(
    CPHOBJECT const hOutput, 
    CPHOOKEDOBJECT const hMessage, 
    CPBOOLEAN const fFlush);

CLC_SDK_API CLC_ErrorCode Output_SendModifierMessage(
    CPHOBJECT const hOutput, 
    CPMODIFIERMSG const * const pMessageData, 
    CPBOOLEAN const fFlush);

CLC_SDK_API CLC_ErrorCode Output_SendEventMessage(
    CPHOBJECT const hOutput, 
    CPEVENTMSG const * const pMessageData, 
    CPBOOLEAN const fFlush);

CLC_SDK_API CLC_ErrorCode Output_SendSelectorMessage(
    CPHOBJECT const hOutput, 
    CPSELECTORMSG const * const pMessageData, 
    CPBOOLEAN const fFlush);

CLC_SDK_API CLC_ErrorCode Output_SendTextMessage(
    CPHOBJECT const hOutput, 
    CPTEXTMSG const * const pMessageData, 
    CPBOOLEAN const fFlush);

CLC_SDK_API CLC_ErrorCode Output_SendTextMessage(
    CPHOBJECT const hOutput, 
    CPTEXTMSG const * const pMessageData, 
    CPBOOLEAN const fFlush);

CLC_SDK_API CLC_ErrorCode Output_SendMIDISysExMessage(
    CPHOBJECT const hOutput, 
    CPBOOLEAN const fIsLastBlock, 
    CPUINT8 const bSize, 
    CPUINT8 const * const pData, 
    CPBOOLEAN const fFlush);

CLC_SDK_API CLC_ErrorCode Output_Flush(
    CPHOBJECT const hOutput);

CLC_SDK_API CLC_ErrorCode Output_Signal(
    CPHOBJECT const hOutput,
    CPUINT16 const wSignalNumber,
    CPUINT16 const wOptionalData0,
    CPUINT16 const wOptionalData1,
    CPUINT16 const wOptionalData2,
    CPUINT16 const wOptionalData3,
    CPCHAR8 const * const utf8OptionalData,
    CPENDPOINT const * const pOptionalEndPoint);



CLC_SDK_API CLC_ErrorCode Controller_GetInfo(
    CPHOBJECT const hController, 
    CPCONTROLLERINFO * const pControllerInfo);

CLC_SDK_API CLC_ErrorCode Controller_QueryParameterPath(
    CPHOBJECT const hController);


#if defined(ENABLE_CONTROLLER)
CLC_SDK_API CLC_ErrorCode Controller_RegisterNotificationHandler(
    CPHOBJECT const hController);

CLC_SDK_API CLC_ErrorCode Controller_UnregisterNotificationHandler(
    CPHOBJECT const hController);
#endif // defined(ENABLE_CONTROLLER)


CLC_SDK_API CLC_ErrorCode Controller_Assign(
    CPHOBJECT const hController, 
    CPCONTROLLERASSIGNMENT const * const pAssignment);

CLC_SDK_API CLC_ErrorCode Controller_Unassign(
    CPHOBJECT const hController);

CLC_SDK_API CLC_ErrorCode Controller_EnterLearningMode(
    CPHOBJECT const hController);

CLC_SDK_API CLC_ErrorCode Controller_SendValue(
    CPHOBJECT const hController, 
    CPUINT16 const wValue,
    ControllerSendModes const mode);

CLC_SDK_API CLC_ErrorCode Controller_SendValueWithAutomation(
    CPHOBJECT const hController, 
    CPUINT16 const wValue,
    ControllerSendModes const mode,
    CPBOOLEAN const fWriteToEnd,
    CPBOOLEAN const fTouch,
    PerformanceMessageAutomationStates const state);

CLC_SDK_API CLC_ErrorCode Controller_SendTextValue(
    CPHOBJECT const hController, 
    CPCHAR8 const * const utf8Value);

//  is a Selector and if the value is not relative.
CLC_SDK_API CLC_ErrorCode Controller_SendTextValueWithAutomation(
    CPHOBJECT const hController, 
    CPCHAR8 const * const utf8Value,
    CPBOOLEAN const fWriteToEnd,
    CPBOOLEAN const fTouch,
    PerformanceMessageAutomationStates const state);

CLC_SDK_API CLC_ErrorCode Controller_SendDown(
    CPHOBJECT const hController);

CLC_SDK_API CLC_ErrorCode Controller_SendUp(
    CPHOBJECT const hController);

CLC_SDK_API CLC_ErrorCode Controller_QueryParameterValue(
    CPHOBJECT const hController);




#ifdef __cplusplus
}
#endif

#endif // _CLC_FCT_OUTPUT_H_