CLC_Fct_VMIDILink.h

Go to the documentation of this file.

//*********************************************************
// File:            CLC_Fct_VMIDILink.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_VMIDILINK_H_
#define _CLC_FCT_VMIDILINK_H_

#ifdef __cplusplus
extern "C" {
#endif


#if defined(ENABLE_DEVICE_VMIDILINKIN)
CLC_SDK_API CLC_ErrorCode VMIDILinkIn_RegisterNotificationHandler(
    CPHOBJECT const hVMIDILinkIn);

CLC_SDK_API CLC_ErrorCode VMIDILinkIn_UnregisterNotificationHandler(
    CPHOBJECT const hVMIDILinkIn);
#endif



#if defined(ENABLE_DEVICE_VMIDILINKOUT)
CLC_SDK_API CLC_ErrorCode VMIDILinkOut_RegisterNotificationHandler(
    CPHOBJECT const hVMIDILinkOut);

CLC_SDK_API CLC_ErrorCode VMIDILinkOut_UnregisterNotificationHandler(
    CPHOBJECT const hVMIDILinkOut);
#endif

CLC_SDK_API CLC_ErrorCode VMIDILinkOut_SendEventToChannel(
    CPHOBJECT const hVMIDILinkOut,
    CPUINT8 const bChannel,
    CPEVENTMSG const * const pMessageData);

CLC_SDK_API CLC_ErrorCode VMIDILinkOut_SendModifierToChannel(
    CPHOBJECT const hVMIDILinkOut,
    CPUINT8 const bChannel,
    CPMODIFIERMSG const * const pMessageData);

CLC_SDK_API CLC_ErrorCode VMIDILinkOut_SendSelectorToChannel(
    CPHOBJECT const hVMIDILinkOut,
    CPUINT8 const bChannel,
    CPSELECTORMSG const * const pMessageData);

CLC_SDK_API CLC_ErrorCode VMIDILinkOut_Clock_Tick(
    CPHOBJECT const hVMIDILinkOut);

CLC_SDK_API CLC_ErrorCode VMIDILinkOut_Clock_RunFromStart(
    CPHOBJECT const hVMIDILinkOut);

CLC_SDK_API CLC_ErrorCode VMIDILinkOut_Clock_Stop(
    CPHOBJECT const hVMIDILinkOut);

CLC_SDK_API CLC_ErrorCode VMIDILinkOut_Clock_Run(
    CPHOBJECT const hVMIDILinkOut);



#if defined(ENABLE_DEVICE_VMIDILINKIN)
CLC_SDK_API CLC_ErrorCode VMIDILinkHybrid_RegisterVMIDILinkInNotificationHandler(
    CPHOBJECT const hVMIDILinkHybrid);

CLC_SDK_API CLC_ErrorCode VMIDILinkHybrid_UnregisterVMIDILinkInNotificationHandler(
    CPHOBJECT const hVMIDILinkHybrid);
#endif

#if defined(ENABLE_DEVICE_VMIDILINKOUT)
CLC_SDK_API CLC_ErrorCode VMIDILinkHybrid_RegisterVMIDILinkOutNotificationHandler(
    CPHOBJECT const hVMIDILinkHybrid);

CLC_SDK_API CLC_ErrorCode VMIDILinkHybrid_UnregisterVMIDILinkOutNotificationHandler(
    CPHOBJECT const hVMIDILinkHybrid);
#endif

CLC_SDK_API CLC_ErrorCode VMIDILinkHybrid_SendEventToChannel(
    CPHOBJECT const hVMIDILinkHybrid,
    CPUINT8 const bChannel,
    CPEVENTMSG const * const pMessageData);

CLC_SDK_API CLC_ErrorCode VMIDILinkHybrid_SendModifierToChannel(
    CPHOBJECT const hVMIDILinkHybrid,
    CPUINT8 const bChannel,
    CPMODIFIERMSG const * const pMessageData);

CLC_SDK_API CLC_ErrorCode VMIDILinkHybrid_SendSelectorToChannel(
    CPHOBJECT const hVMIDILinkHybrid,
    CPUINT8 const bChannel,
    CPSELECTORMSG const * const pMessageData);

CLC_SDK_API CLC_ErrorCode VMIDILinkHybrid_Clock_RunFromStart(
    CPHOBJECT const hVMIDILinkHybrid);

CLC_SDK_API CLC_ErrorCode VMIDILinkHybrid_Clock_Stop(
    CPHOBJECT const hVMIDILinkHybrid);

CLC_SDK_API CLC_ErrorCode VMIDILinkHybrid_Clock_Run(
    CPHOBJECT const hVMIDILinkHybrid);


#ifdef __cplusplus
}
#endif

#endif // _CLC_FCT_VMIDILINK_H_