CLC_Fct_TextMessage.h

Go to the documentation of this file.

//*********************************************************
// File:            CLC_Fct_TextMessage.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_TEXTMESSAGE_H_
#define _CLC_FCT_TEXTMESSAGE_H_

#ifdef __cplusplus
extern "C" {
#endif

#define TEXTMESSAGE_PROFILEBITS     8

typedef enum 
{
    TP_None                     = 0x0000,
    TP_VoiceIDAvailable         = 0x0001,
    TP_AutomationAvailable      = 0x0002,
    TP_IndexAvailable           = 0x0004,
    TP_PreLoad                  = 0x0010,
    TP_Trigger                  = 0x0040
}TextProfiles;  

typedef struct
{
    CPUINT16 wNumber;

    CPUINT16 wProfiles;

    CPCHAR8 * utf8Value;

    union
    {
        CPUINT16        DataArray[TEXTMESSAGE_PROFILEBITS];       
        struct
        {
            CPUINT16    wTransaction;
            CPUINT16    wVoiceID;
            CPUINT16    wAutomation;
            CPUINT16    wIndex;

            CPUINT16    w_Reserved_;
            CPUINT16    w_Reserved1_;
            CPUINT16    w_Reserved2_;
            CPUINT16    w_Reserved3_;
        } Discrete;                 
    } Profile;
} CPTEXTMSG;


CLC_SDK_API void TextMessage_Clear(
    CPTEXTMSG * const pTextMessageData );


CLC_SDK_API CPUINT16 TextMessage_GetProfiles(
    CPTEXTMSG const * const pTextMessageData );


CLC_SDK_API CPBOOLEAN TextMessage_IsIndexAvailable(
    CPTEXTMSG const * const pTextMessageData );

CLC_SDK_API void TextMessage_SetIndex(
    CPTEXTMSG * const pTextMessageData,
    CPUINT16 const wIndex );

CLC_SDK_API CPUINT16 TextMessage_GetIndex(
    CPTEXTMSG const * const pTextMessageData );


CLC_SDK_API CPBOOLEAN TextMessage_IsAutomationAvailable(
    CPTEXTMSG const * const pTextMessageData );

CLC_SDK_API void TextMessage_SetAutomationState(
    CPTEXTMSG* const pTextMessageData,
    PerformanceMessageAutomationStates const eValue );

CLC_SDK_API PerformanceMessageAutomationStates TextMessage_GetAutomationState(
    CPTEXTMSG const * const pTextMessageData );

CLC_SDK_API void TextMessage_SetAutomationTouch(
    CPTEXTMSG* const pTextMessageData,
    CPBOOLEAN const fValue );

CLC_SDK_API CPBOOLEAN TextMessage_GetAutomationTouch(
    CPTEXTMSG const * const pTextMessageData );

CLC_SDK_API void TextMessage_SetAutomationWTE(
    CPTEXTMSG* const pTextMessageData,
    CPBOOLEAN const fValue );

CLC_SDK_API CPBOOLEAN TextMessage_GetAutomationWTE(
    CPTEXTMSG const * const pTextMessageData );


CLC_SDK_API CPBOOLEAN TextMessage_IsVoiceIDAvailable(
    CPTEXTMSG const * const pTextMessageData );

CLC_SDK_API void TextMessage_SetVoiceID(
    CPTEXTMSG* const pTextMessageData,
    CPUINT16 const wVoiceID );

CLC_SDK_API CPUINT16 TextMessage_GetVoiceID(
    CPTEXTMSG const * const pTextMessageData );


CLC_SDK_API void TextMessage_SetTransaction( 
    CPTEXTMSG* const pTextMessageData,
    TransactionModes const eMode );

CLC_SDK_API TransactionModes TextMessage_GetTransaction(
    CPTEXTMSG const * const pTextMessageData );

CLC_SDK_API void TextMessage_SetPreLoad(
    CPTEXTMSG* const pTextMessageData,
    CPBOOLEAN const fValue );

CLC_SDK_API CPBOOLEAN TextMessage_GetPreLoad(
    CPTEXTMSG const * const pTextMessageData );

CLC_SDK_API void TextMessage_SetTrigger(
    CPTEXTMSG* const pTextMessageData,
    CPBOOLEAN const fValue );

CLC_SDK_API CPBOOLEAN TextMessage_GetTrigger(
    CPTEXTMSG const * const pTextMessageData );



#ifdef __cplusplus
}
#endif

#endif // _CLC_FCT_TEXTMESSAGE_H_