CLC_Fct_SelectorMessage.h

Go to the documentation of this file.

//*********************************************************
// File:            CLC_Fct_SelectorMessage.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_SELECTIRMESSAGE_H_
#define _CLC_FCT_SELECTIRMESSAGE_H_

#ifdef __cplusplus
extern "C" {
#endif

#define SELECTORMESSAGE_PROFILEBITS     8

typedef enum
{
    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,
}SelectorProfiles;

typedef struct
{
    CPUINT16 wNumber;
    CPUINT16 wValue;

    CPUINT16 wProfiles;
    union
    {
        CPUINT16        DataArray[SELECTORMESSAGE_PROFILEBITS];
        struct
        {
            CPUINT16    wTransaction;
            CPUINT16    wVoiceID;
            CPUINT16    wAutomation;
            CPUINT16    wIndex;
            CPUINT16    wSource;
            CPUINT16    wMorph;

            CPUINT16    w_Reserved_;
            CPUINT16    w_Reserved1_;
        } Discrete;
    } Profile;

    CPUINT16 wReserved;    
} CPSELECTORMSG;


CLC_SDK_API void SelectorMessage_Clear(
    CPSELECTORMSG * const pSelectorMessageData);


CLC_SDK_API CPUINT16 SelectorMessage_GetProfiles(
    CPSELECTORMSG const * const pSelectorMessageData);

CLC_SDK_API void SelectorMessage_SetSourceType(
    CPSELECTORMSG * const pSelectorMessageData, 
    PerformanceMessageSources const source);

CLC_SDK_API PerformanceMessageSources SelectorMessage_GetSourceType(
    CPSELECTORMSG const * const pSelectorMessageData);

CLC_SDK_API void SelectorMessage_SetRelativeMode(
    CPSELECTORMSG * const pSelectorMessageData,
    RelativeMode const mode );

CLC_SDK_API RelativeMode SelectorMessage_GetRelativeMode(
    CPSELECTORMSG const * const pSelectorMessageData );

CLC_SDK_API void SelectorMessage_SetPreLoad(
    CPSELECTORMSG * const pSelectorMessageData,
    CPBOOLEAN const fValue );

CLC_SDK_API CPBOOLEAN SelectorMessage_GetPreLoad(
    CPSELECTORMSG const * const pSelectorMessageData );

CLC_SDK_API void SelectorMessage_SetTrigger(
    CPSELECTORMSG * const pSelectorMessageData,
    CPBOOLEAN const fValue );

CLC_SDK_API CPBOOLEAN SelectorMessage_GetTrigger(
    CPSELECTORMSG const * const pSelectorMessageData );

CLC_SDK_API CPBOOLEAN SelectorMessage_GetProportionalValue(
    CPSELECTORMSG const * const pSelectorMessageData);

CLC_SDK_API void SelectorMessage_SetProportionalValue(
    CPSELECTORMSG * const pSelectorMessageData);



CLC_SDK_API CPBOOLEAN SelectorMessage_IsIndexAvailable(
    CPSELECTORMSG const * const pSelectorMessageData );

CLC_SDK_API void SelectorMessage_SetIndex(
    CPSELECTORMSG * const pSelectorMessageData,
    CPUINT16 const wIndex );

CLC_SDK_API CPUINT16 SelectorMessage_GetIndex(
    CPSELECTORMSG const * const pSelectorMessageData );


CLC_SDK_API CPBOOLEAN SelectorMessage_IsAutomationAvailable(
    CPSELECTORMSG const * const pSelectorMessageData );

CLC_SDK_API void SelectorMessage_SetAutomationState(
    CPSELECTORMSG * const pSelectorMessageData,
    PerformanceMessageAutomationStates const state );

CLC_SDK_API PerformanceMessageAutomationStates SelectorMessage_GetAutomationState(
    CPSELECTORMSG const * const pSelectorMessageData );

CLC_SDK_API void SelectorMessage_SetAutomationTouch(
    CPSELECTORMSG * const pSelectorMessageData,
    CPBOOLEAN const fValue );

CLC_SDK_API CPBOOLEAN SelectorMessage_GetAutomationTouch(
    CPSELECTORMSG const * const pSelectorMessageData );

CLC_SDK_API void SelectorMessage_SetAutomationWTE(
    CPSELECTORMSG * const pSelectorMessageData,
    CPBOOLEAN const fValue );

CLC_SDK_API CPBOOLEAN SelectorMessage_GetAutomationWTE(
    CPSELECTORMSG const * const pSelectorMessageData );


CLC_SDK_API CPBOOLEAN SelectorMessage_IsMorphAvailable(
    CPSELECTORMSG const * const pSelectorMessageData );

CLC_SDK_API void SelectorMessage_SetMorph(
    CPSELECTORMSG * const pSelectorMessageData,
    CPUINT16 const wValue );

CLC_SDK_API CPUINT16 SelectorMessage_GetMorph(
    CPSELECTORMSG const * const pSelectorMessageData );


CLC_SDK_API CPBOOLEAN SelectorMessage_IsVoiceIDAvailable(
    CPSELECTORMSG const * const pSelectorMessageData );

CLC_SDK_API void SelectorMessage_SetVoiceID(
    CPSELECTORMSG * const pSelectorMessageData,
    CPUINT16 const wVoiceID );

CLC_SDK_API CPUINT16 SelectorMessage_GetVoiceID(
    CPSELECTORMSG const * const pSelectorMessageData );


CLC_SDK_API void SelectorMessage_SetTransaction( 
    CPSELECTORMSG * const pSelectorMessageData,
    TransactionModes const mode );

CLC_SDK_API TransactionModes SelectorMessage_GetTransaction(
    CPSELECTORMSG const * const pSelectorMessageData );



#ifdef __cplusplus
}
#endif

#endif // _CLC_FCT_SELECTIRMESSAGE_H_