CLC_Fct_Input.h

Go to the documentation of this file.

//*********************************************************
// File:            CLC_Fct_Input.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_INPUT_H_
#define _CLC_FCT_INPUT_H_

#ifdef __cplusplus
extern "C" {
#endif

#if defined(ENABLE_INPUT)


    CLC_SDK_API CLC_ErrorCode Input_RegisterNotificationHandler(
        CPHOBJECT const hInput);

    CLC_SDK_API CLC_ErrorCode Input_UnregisterNotificationHandler(
        CPHOBJECT const hInput);

#if defined(ENABLE_CLOCK)
    CLC_SDK_API CLC_ErrorCode Input_RegisterClockListenerControlNotificationHandler(
        CPHOBJECT const hInput);

    CLC_SDK_API CLC_ErrorCode Input_UnregisterClockListenerControlNotificationHandler(
        CPHOBJECT const hInput);
#endif // defined(ENABLE_CLOCK)

#if defined(ENABLE_PARAMETER)
    CLC_SDK_API CLC_ErrorCode Input_RegisterParameterNotificationHandler(
        CPHOBJECT const hInput);

    CLC_SDK_API CLC_ErrorCode Input_UnregisterParameterNotificationHandler(
        CPHOBJECT const hInput);
#endif // defined(ENABLE_PARAMETER)

    CLC_SDK_API CLC_ErrorCode Input_ActivateMessageTimestamp(
        CPHOBJECT const hInput, 
        CPBOOLEAN const fTimestamp);
#endif // defined(ENABLE_INPUT)


    CLC_SDK_API CLC_ErrorCode Input_GetInfo(
        CPHOBJECT const hInput, 
        CPINPUTINFO * const pInputInfo);

    CLC_SDK_API CLC_ErrorCode Input_GetName(
        CPHOBJECT const hInput, 
        CPCHAR8 const ** const putf8Name);

    CLC_SDK_API CLC_ErrorCode Input_SetName(
        CPHOBJECT const hInput, 
        CPCHAR8 const * const utf8Name);

    CLC_SDK_API CLC_ErrorCode Input_GetPath(
        CPHOBJECT const hInput, 
        CPCHAR8 const ** const putf8Path);

    CLC_SDK_API CLC_ErrorCode Input_SetSectionID(
        CPHOBJECT const hInput, 
        CPSECTIONID const * const pSectionID);

    CLC_SDK_API CLC_ErrorCode Input_SetCapabilities(
        CPHOBJECT const hInput, 
        InOutCapabilities const inputCaps);

    CLC_SDK_API CPBOOLEAN InputOutput_IsCompatibleWith( 
        InOutCapabilities const inputCaps, 
        InOutCapabilities const outputCaps );



    CLC_SDK_API CLC_ErrorCode Input_RemoveSource(
        CPHOBJECT const hInput, 
        CPENDPOINT const * const pSource);

    CLC_SDK_API CLC_ErrorCode Input_GetSource(
        CPHOBJECT const hInput,
        CPUINT16 const wSourceIndex,
        CPENDPOINT * const pEndpoint);




    CLC_SDK_API CLC_ErrorCode Input_AddModifierParameter(
        CPHOBJECT const hInput, 
        CPCHAR8 const * const utf8Name,
        CPUINT16 const wMsgNum,
        CPHOBJECT const hIndexList,
        CPUINT16 const wMidPointValue,
        CPCHAR8 const * const utf8LabelMin,
        CPCHAR8 const * const utf8LabelMidPoint,
        CPCHAR8 const * const utf8LabelMax,
        DataTypes const preferredDataType,
        CPUINT16 const wGroup,
        ModifierInformationProfiles const informationProfiles,
        ControllerTypes const preferredControllerType,
        CPUINT32 const dwParameterUserData,
        CPHOBJECT * const phParameter);

    CLC_SDK_API CLC_ErrorCode Input_AddSelectorParameter(
        CPHOBJECT const hInput, 
        CPCHAR8 const * const utf8Name,
        CPUINT16 const wMsgNum,
        CPHOBJECT const hIndexList,
        CPHOBJECT const hSelectorItemList,
        CPUINT16 const wGroup,
        SelectorInformationProfiles const informationProfiles,
        ControllerTypes const preferredControllerType,
        CPUINT32 const dwParameterUserData,
        CPHOBJECT * const phParameter);

    CLC_SDK_API CLC_ErrorCode Input_AddTextParameter(
        CPHOBJECT const hInput, 
        CPCHAR8 const * const utf8Name,
        CPUINT16 const wMsgNum,
        CPHOBJECT const hIndexList,
        CPUINT16 const wGroup,
        TextInformationProfiles const informationProfiles,
        ControllerTypes const preferredControllerType,
        CPUINT32 const dwParameterUserData,
        CPHOBJECT * const phParameter);

    CLC_SDK_API CLC_ErrorCode Input_AddTitleParameter(
        CPHOBJECT const hInput, 
        CPCHAR8 const * const utf8Text,
        CPUINT16 const wGroup);

    CLC_SDK_API CLC_ErrorCode Input_ClearParameterDefinition(
        CPHOBJECT const hInput);

    CLC_SDK_API CLC_ErrorCode Input_RefreshParameterDefinition(
        CPHOBJECT const hInput);

    CLC_SDK_API CLC_ErrorCode Parameter_RefreshCurrentModifierParameterValue(
        CPHOBJECT const hParameter,
        CPUINT16 const wIndex, 
        CPVALUE const * const pValue,
        CPCHAR8 const * const utf8ValueText,
        RefreshValueAttributes const attributes);

    CLC_SDK_API CLC_ErrorCode Parameter_RefreshCurrentSelectorParameterValue(
        CPHOBJECT const hParameter,
        CPUINT16 const wIndex, 
        CPUINT16 const wValue,
        RefreshValueAttributes const attributes);

    CLC_SDK_API CLC_ErrorCode Parameter_RefreshCurrentTextParameterValue(
        CPHOBJECT const hParameter,
        CPUINT16 const wIndex, 
        CPCHAR8 const * const utf8ValueText,
        RefreshValueAttributes const attributes);

    CLC_SDK_API CLC_ErrorCode Parameter_DeclareParameterChanged(
        CPHOBJECT const hParameter,
        CPUINT16 const wIndex,
        CPUINT16 const wRawValue);

    CLC_SDK_API CLC_ErrorCode Parameter_AddModifierSupportedDataType(
        CPHOBJECT const hParameter,
        DataTypes const dataType,
        CPVALUE const * const pMinValue,
        CPVALUE const * const pMidValue,
        CPVALUE const * const pMaxValue);



    CLC_SDK_API CLC_ErrorCode Input_Signal(
        CPHOBJECT const hInput, 
        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 Input_DataConsumed(
        CPHOBJECT const hInput);




    CLC_SDK_API CLC_ErrorCode Input_Clock_Set(
        CPHOBJECT const hInput, 
        CPUINT8 const bCPQNMultiplier);



#ifdef __cplusplus
}
#endif

#endif // _CLC_FCT_INPUT_H_