CHAILink SDK  Version 1.3
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
CLCm_Defines.h
Go to the documentation of this file.
1 //*********************************************************
2 // File: CLCm_Defines.h
3 // Project: CopperLan CHAILink SDK Common Part
4 // For Client & Server
5 // Version: 1.3
6 // Release Date: 2014/04/15
7 //*********************************************************
8 
9 /********************************************************************
10 Software License Agreement: CHAILink Client source code
11 
12 The software supplied herewith by Klavis Technology (the “Company”) is intended and
13 supplied to you, the Company’s customer, for use solely and exclusively on embedded
14 CopperLan products needing a CHAILink Client.
15  The software is owned by the Company and/or its supplier, and is protected
16  under applicable copyright laws. All rights are reserved. Any use in violation of the
17  foregoing restrictions may subject the user to criminal sanctions under applicable laws,
18 as well as to civil liability for the breach of the terms and conditions of this license.
19 
20 THIS SOFTWARE MUST REMAIN UNMODIFIED. NO WARRANTIES, WHETHER EXPRESS,
21  IMPLIED OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF
22  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE
23 IN CASE OF SOURCE CODE CHANGE BY THE CUSTOMER. IN CASE OF SUCH CHANGE, THE
24 COMPANY SHALL NOT BE LIABLE FOR SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
25 OF ANY KIND.
26 ********************************************************************/
27 
28 #ifndef __CLCM_CLDEFINES_H__
29 #define __CLCM_CLDEFINES_H__
30 
31 #include "CLCm_Types.h"
32 
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36 
37 
39 typedef enum
40 {
41  CLM_Client = 0x0100,
42  CLM_Server = 0x0200,
43  CLM_General = 0x0300,
44  CLM_HookedObject = 0x0400,
45  CLM_Async = 0x0500,
46  CLM_CHAI = 0x0600,
47  CLM_RemoteDevice = 0x0700,
48  CLM_LocalDevice = 0x0800,
49  CLM_CP2MIDI = 0x0900,
50  CLM_MIDI2CP = 0x0A00,
51  CLM_HybridMIDI = 0x0B00,
52  CLM_Input = 0x0C00,
53  CLM_BaseOutput = 0x0D00,
54  CLM_Output = 0x0E00,
55  CLM_Controller = 0x0F00,
56  CLM_Pipe = 0x1000,
57  CLM_SharedDisplay = 0x1100,
58  CLM_SharedDisplayClient = 0x1200,
59  CLM_InputParameter = 0x1300,
60  CLM_VMIDILinkIn = 0x1400,
61  CLM_VMIDILinkOut = 0x1500,
62  CLM_VMIDILinkHybrid = 0x1600,
63  CLM_DataTransferMessage = 0x2000,
64  CLM_TransportProtocol = 0x3000,
65  _CLM_Mask_ = 0x3F00,
66 
67  CLM_CmdFromClient = 0x0000,
68  CLM_CmdFromServer = 0x4000,
69  _CLM_CmdFromMask_ = 0x4000,
70 
71  CLM_NeedResponse = 0x8000
72 } CLC_Modules;
73 
75 
76 typedef enum
77 {
78  CLMID_HOOKEDOBJECT_ACQUIRE = 0x00 | CLM_HookedObject | CLM_NeedResponse,
79  CLMID_HOOKEDOBJECT_RELEASE = 0x01 | CLM_HookedObject | CLM_NeedResponse,
80  CLMID_HOOKEDOBJECT_GETHOOKCOUNTER = 0x02 | CLM_HookedObject | CLM_NeedResponse,
81 
82  CLMID_ASYNC_CANCELCURRENTCALL = 0x00 | CLM_Async | CLM_NeedResponse,
83 
84  CLMID_CHAI_GETVERSION = 0x00 | CLM_CHAI | CLM_NeedResponse,
85  CLMID_CHAI_SETAPPLICATIONNAME = 0x01 | CLM_CHAI | CLM_NeedResponse,
86  CLMID_CHAI_REGISTERNOTIFICATIONHANDLER = 0x08 | CLM_CHAI | CLM_NeedResponse,
87  CLMID_CHAI_GETGLOBALSYNCHRONIZEDTIME = 0x10 | CLM_CHAI | CLM_NeedResponse,
88  CLMID_CHAI_ISGLOBALSYNCHRONIZEDTIMEREFERENCE = 0x11 | CLM_CHAI | CLM_NeedResponse,
89  CLMID_CHAI_REDECLAREALLDEVICES = 0x20 | CLM_CHAI | CLM_NeedResponse,
90  CLMID_CHAI_ADDDEVICE = 0x21 | CLM_CHAI | CLM_NeedResponse,
91  CLMID_CHAI_REMOVELOCALDEVICE = 0x22 | CLM_CHAI | CLM_NeedResponse,
92  CLMID_CHAI_CONNECT = 0x30 | CLM_CHAI | CLM_NeedResponse,
93  CLMID_CHAI_DISCONNECT = 0x31 | CLM_CHAI | CLM_NeedResponse,
94  CLMID_CHAI_ISCONNECTED = 0x32 | CLM_CHAI | CLM_NeedResponse,
95  CLMID_CHAI_SETCHAIGROUPS = 0x38 | CLM_CHAI | CLM_NeedResponse,
96  CLMID_CHAI_GETCHAIGROUPS = 0x39 | CLM_CHAI | CLM_NeedResponse,
97  CLMID_CHAI_REMOTEDEVICE_FINDFIRST_ASYNC = 0x40 | CLM_CHAI | CLM_NeedResponse,
98  CLMID_CHAI_REMOTEDEVICE_FINDNEXT_ASYNC = 0x41 | CLM_CHAI | CLM_NeedResponse,
99  CLMID_CHAI_REMOTEDEVICE_FINDPREV_ASYNC = 0x42 | CLM_CHAI | CLM_NeedResponse,
100  CLMID_CHAI_REGISTERGLOBALTIMER = 0x50 | CLM_CHAI | CLM_NeedResponse,
101  CLMID_CHAI_WARNING_SEND = 0x60 | CLM_CHAI | CLM_NeedResponse,
102  CLMID_CHAI_REGISTERSIGNALNOTIFICATIONHANDLER = 0x70 | CLM_CHAI | CLM_NeedResponse,
103  CLMID_CHAI_SIGNALDIRECT = 0x71 | CLM_CHAI | CLM_NeedResponse,
104  CLMID_CHAI_SIGNALBROADCAST = 0x72 | CLM_CHAI | CLM_NeedResponse,
105  CLMID_CHAI_CREATEREMOTEDEVICEFROMLOCALDEVICE = 0x80 | CLM_CHAI | CLM_NeedResponse,
106  CLMID_CHAI_CREATEREMOTEDEVICE = 0x81 | CLM_CHAI | CLM_NeedResponse,
107  CLMID_CHAI_CREATEDATATRANSFERMESSAGE = 0x88 | CLM_CHAI | CLM_NeedResponse,
108  CLMID_CHAI_SETFLOWCONTROLINCOMINGCAPACITY = 0x90 | CLM_CHAI | CLM_NeedResponse,
109  CLMID_CHAI_ENTERSNAPSHOTSAVINGMODE = 0xA0 | CLM_CHAI | CLM_NeedResponse,
110  CLMID_CHAI_ENTERSNAPSHOTRESTOREMODE = 0xA1 | CLM_CHAI | CLM_NeedResponse,
111  CLMID_CHAI_LEAVESNAPSHOTMODE = 0xA2 | CLM_CHAI | CLM_NeedResponse,
112  CLMID_CHAI_GETCURRENTSNAPSHOTMODE = 0xA3 | CLM_CHAI | CLM_NeedResponse,
113  CLMID_CHAI_CREATEINDEXLIST = 0xB0 | CLM_CHAI | CLM_NeedResponse,
114  CLMID_CHAI_ADDINDEXLISTITEMS = 0xB1 | CLM_CHAI | CLM_NeedResponse,
115  CLMID_CHAI_REMOVEINDEXLIST = 0xB2 | CLM_CHAI | CLM_NeedResponse,
116  CLMID_CHAI_CREATESELECTORLIST = 0xB8 | CLM_CHAI | CLM_NeedResponse,
117  CLMID_CHAI_ADDSELECTORLISTITEMS = 0xB9 | CLM_CHAI | CLM_NeedResponse,
118  CLMID_CHAI_REMOVESELECTORLIST = 0xBA | CLM_CHAI | CLM_NeedResponse,
119  CLMID_CHAI_UPDATESELECTORLIST = 0xBB | CLM_CHAI | CLM_NeedResponse,
120 
121  CLMID_REMOTEDEVICE_GETPROPERTIES = 0x00 | CLM_RemoteDevice | CLM_NeedResponse,
122  CLMID_REMOTEDEVICE_GETSTATUS = 0x01 | CLM_RemoteDevice | CLM_NeedResponse,
123  CLMID_REMOTEDEVICE_GENERICCHANGE = 0x08 | CLM_RemoteDevice | CLM_NeedResponse,
124  CLMID_REMOTEDEVICE_GETNAME_ASYNC = 0x10 | CLM_RemoteDevice | CLM_NeedResponse,
125  CLMID_REMOTEDEVICE_GETPROPERTY_ASYNC = 0x11 | CLM_RemoteDevice | CLM_NeedResponse,
126  CLMID_REMOTEDEVICE_GETINPUTINFO_ASYNC = 0x12 | CLM_RemoteDevice | CLM_NeedResponse,
127  CLMID_REMOTEDEVICE_GETOUTPUTINFO_ASYNC = 0x13 | CLM_RemoteDevice | CLM_NeedResponse,
128  CLMID_REMOTEDEVICE_CLEARALLDESTINATIONS = 0x20 | CLM_RemoteDevice | CLM_NeedResponse,
129  CLMID_REMOTEDEVICE_CLEARDESTINATIONS = 0x21 | CLM_RemoteDevice | CLM_NeedResponse,
130  CLMID_REMOTEDEVICE_GETDESTINATION_ASYNC = 0x22 | CLM_RemoteDevice | CLM_NeedResponse,
131  CLMID_REMOTEDEVICE_GETDETAILEDDESTINATION_ASYNC = 0x23 | CLM_RemoteDevice | CLM_NeedResponse,
132  CLMID_REMOTEDEVICE_GETDESTINATIONCOUNT_ASYNC = 0x24 | CLM_RemoteDevice | CLM_NeedResponse,
133  CLMID_REMOTEDEVICE_GETCONNECTEDDEVICES_ASYNC = 0x25 | CLM_RemoteDevice | CLM_NeedResponse,
134  CLMID_REMOTEDEVICE_ADDDESTINATION = 0x28 | CLM_RemoteDevice | CLM_NeedResponse,
135  CLMID_REMOTEDEVICE_CHANGEDESTINATION = 0x29 | CLM_RemoteDevice | CLM_NeedResponse,
136  CLMID_REMOTEDEVICE_REMOVEDESTINATION = 0x2A | CLM_RemoteDevice | CLM_NeedResponse,
137  CLMID_REMOTEDEVICE_GETPARAMETERINFO_ASYNC = 0x30 | CLM_RemoteDevice | CLM_NeedResponse,
138  CLMID_REMOTEDEVICE_GETMODIFIERDATATYPEINFO_ASYNC = 0x31 | CLM_RemoteDevice | CLM_NeedResponse,
139  CLMID_REMOTEDEVICE_GETSELECTORPARAMVALUETEXT_ASYNC = 0x32 | CLM_RemoteDevice | CLM_NeedResponse,
140  CLMID_REMOTEDEVICE_GETCONTROLLERINFO_ASYNC = 0x38 | CLM_RemoteDevice | CLM_NeedResponse,
141  CLMID_REMOTEDEVICE_GETINDEXLISTITEMTEXT_ASYNC = 0x3C | CLM_RemoteDevice | CLM_NeedResponse,
142  CLMID_REMOTEDEVICE_ASSIGNCONTROLLER = 0x40 | CLM_RemoteDevice | CLM_NeedResponse,
143  CLMID_REMOTEDEVICE_RESETCONTROLLER = 0x41 | CLM_RemoteDevice | CLM_NeedResponse,
144  CLMID_REMOTEDEVICE_RESETALLCONTROLLERS = 0x42 | CLM_RemoteDevice | CLM_NeedResponse,
145  CLMID_REMOTEDEVICE_COLLECTSNAPSHOTDATA_ASYNC = 0x50 | CLM_RemoteDevice | CLM_NeedResponse,
146  CLMID_REMOTEDEVICE_RESTORESNAPSHOTDATA_ASYNC = 0x51 | CLM_RemoteDevice | CLM_NeedResponse,
147  CLMID_REMOTEDEVICE_LEARN = 0x60 | CLM_RemoteDevice | CLM_NeedResponse,
148  CLMID_REMOTEDEVICE_SMARTCONNECTSTART_ASYNC = 0x70 | CLM_RemoteDevice | CLM_NeedResponse,
149 
150  CLMID_BASELOCALDEVICE_ADDSUBDEVICE = 0x00 | CLM_LocalDevice | CLM_NeedResponse,
151  CLMID_BASELOCALDEVICE_REPLYINVALIDREQUEST = 0x08 | CLM_LocalDevice | CLM_NeedResponse,
152  CLMID_BASELOCALDEVICE_REGISTERNOTIFICATIONHANDLER = 0x10 | CLM_LocalDevice | CLM_NeedResponse,
153  CLMID_BASELOCALDEVICE_REGISTERSNAPSHOTNOTIFICATIONHANDLER = 0x11 | CLM_LocalDevice | CLM_NeedResponse,
154  CLMID_BASELOCALDEVICE_REGISTERSIGNALNOTIFICATIONHANDLER = 0x12 | CLM_LocalDevice | CLM_NeedResponse,
155  CLMID_BASELOCALDEVICE_REGISTERSMARTCONNECTDSTNOTIFICATIONHANDLER = 0x13 | CLM_LocalDevice | CLM_NeedResponse,
156  CLMID_BASELOCALDEVICE_GETINFO = 0x20 | CLM_LocalDevice | CLM_NeedResponse,
157  CLMID_BASELOCALDEVICE_SETCUSTOMNAME = 0x21 | CLM_LocalDevice | CLM_NeedResponse,
158  CLMID_BASELOCALDEVICE_GETNAME = 0x22 | CLM_LocalDevice | CLM_NeedResponse,
159  CLMID_BASELOCALDEVICE_SETDISABLEDDESTINATIONAUTODELETE = 0x23 | CLM_LocalDevice | CLM_NeedResponse,
160  CLMID_BASELOCALDEVICE_SETSECTIONNAME = 0x24 | CLM_LocalDevice | CLM_NeedResponse,
161  CLMID_BASELOCALDEVICE_GETSECTIONNAME = 0x25 | CLM_LocalDevice | CLM_NeedResponse,
162  CLMID_BASELOCALDEVICE_SETVISIBILITY = 0x26 | CLM_LocalDevice | CLM_NeedResponse,
163  CLMID_BASELOCALDEVICE_SETSTRINGPROPERTY = 0x27 | CLM_LocalDevice | CLM_NeedResponse,
164  CLMID_BASELOCALDEVICE_SETNUMERICPROPERTY = 0x28 | CLM_LocalDevice | CLM_NeedResponse,
165  CLMID_BASELOCALDEVICE_GETPATH = 0x29 | CLM_LocalDevice | CLM_NeedResponse,
166  CLMID_BASELOCALDEVICE_ADDOUTPUT = 0x30 | CLM_LocalDevice | CLM_NeedResponse,
167  CLMID_BASELOCALDEVICE_GETOUTPUTFROMID = 0x31 | CLM_LocalDevice | CLM_NeedResponse,
168  CLMID_BASELOCALDEVICE_CLEAROUTPUTS = 0x32 | CLM_LocalDevice | CLM_NeedResponse,
169  CLMID_BASELOCALDEVICE_FLUSH = 0x33 | CLM_LocalDevice | CLM_NeedResponse,
170  CLMID_BASELOCALDEVICE_ADDCONTROLLER = 0x40 | CLM_LocalDevice | CLM_NeedResponse,
171  CLMID_BASELOCALDEVICE_CLEARCONTROLLERS = 0x41 | CLM_LocalDevice | CLM_NeedResponse,
172  CLMID_BASELOCALDEVICE_UNASSIGNALLCONTROLLERS = 0x42 | CLM_LocalDevice | CLM_NeedResponse,
173  CLMID_BASELOCALDEVICE_ADDINPUT = 0x50 | CLM_LocalDevice | CLM_NeedResponse,
174  CLMID_BASELOCALDEVICE_GETINPUTFROMID = 0x51 | CLM_LocalDevice | CLM_NeedResponse,
175  CLMID_BASELOCALDEVICE_CLEARINPUTS = 0x52 | CLM_LocalDevice | CLM_NeedResponse,
176  CLMID_BASELOCALDEVICE_ADDPIPE = 0x60 | CLM_LocalDevice | CLM_NeedResponse,
177  CLMID_BASELOCALDEVICE_GETPIPEFROMID = 0x61 | CLM_LocalDevice | CLM_NeedResponse,
178  CLMID_BASELOCALDEVICE_CLEARPIPES = 0x62 | CLM_LocalDevice | CLM_NeedResponse,
179  CLMID_BASELOCALDEVICE_LEAVELEARNINGMODE = 0x70 | CLM_LocalDevice | CLM_NeedResponse,
180  CLMID_BASELOCALDEVICE_ISLEARNINGMODEACTIVE = 0x71 | CLM_LocalDevice | CLM_NeedResponse,
181  CLMID_BASELOCALDEVICE_SIGNALDIRECT = 0x78 | CLM_LocalDevice | CLM_NeedResponse,
182  CLMID_BASELOCALDEVICE_SIGNALBROADCAST = 0x79 | CLM_LocalDevice | CLM_NeedResponse,
183  CLMID_BASELOCALDEVICE_SETDISABLEDINTERNALSNAPSHOT = 0x80 | CLM_LocalDevice | CLM_NeedResponse,
184  CLMID_BASELOCALDEVICE_REPLYREQUESTCOLLECTSNAPSHOTDATA = 0x81 | CLM_LocalDevice | CLM_NeedResponse,
185  CLMID_BASELOCALDEVICE_REPLYREQUESTRESTORESNAPSHOTDATA = 0x82 | CLM_LocalDevice | CLM_NeedResponse,
186  CLMID_BASELOCALDEVICE_SCT_UNASSIGNANDREQUESTSECTIONLIST = 0x90 | CLM_LocalDevice | CLM_NeedResponse,
187  CLMID_BASELOCALDEVICE_SCT_REQUESTCONTROLLERLIST = 0x91 | CLM_LocalDevice | CLM_NeedResponse,
188  CLMID_BASELOCALDEVICE_SCT_ASSIGNCONTROLLER = 0x92 | CLM_LocalDevice | CLM_NeedResponse,
189  CLMID_BASELOCALDEVICE_SCT_ASSIGNOUTPUT = 0x93 | CLM_LocalDevice | CLM_NeedResponse,
190  CLMID_BASELOCALDEVICE_SCT_FINISHED = 0x94 | CLM_LocalDevice | CLM_NeedResponse,
191  CLMID_BASELOCALDEVICE_FLOWCONTROL = 0xA0 | CLM_LocalDevice | CLM_NeedResponse,
192 
193  CLMID_CP2MIDI_REGISTERNOTIFICATIONHANDLER = 0x00 | CLM_CP2MIDI | CLM_NeedResponse,
194  CLMID_CP2MIDI_SETMIDICCMODE = 0x08 | CLM_CP2MIDI | CLM_NeedResponse,
195  CLMID_CP2MIDI_ENABLEACTIVESENSING = 0x09 | CLM_CP2MIDI | CLM_NeedResponse,
196  CLMID_CP2MIDI_ISACTIVESENSINGENABLED = 0x10 | CLM_CP2MIDI | CLM_NeedResponse,
197  CLMID_CP2MIDI_DATACONSUMED = 0x20 | CLM_CP2MIDI | CLM_NeedResponse,
198 
199  CLMID_MIDI2CP_SENDMIDIBLOB = 0x00 | CLM_MIDI2CP | CLM_NeedResponse,
200 
201  CLMID_HYBRIDMIDI_REGISTERCP2MIDINOTIFICATIONHANDLER = 0x00 | CLM_HybridMIDI | CLM_NeedResponse,
202  CLMID_HYBRIDMIDI_SETMIDICCMODE = 0x08 | CLM_HybridMIDI | CLM_NeedResponse,
203  CLMID_HYBRIDMIDI_ENABLEACTIVESENSING = 0x09 | CLM_HybridMIDI | CLM_NeedResponse,
204  CLMID_HYBRIDMIDI_ISACTIVESENSINGENABLED = 0x10 | CLM_HybridMIDI | CLM_NeedResponse,
205  CLMID_HYBRIDMIDI_DATACONSUMED = 0x20 | CLM_HybridMIDI | CLM_NeedResponse,
206  CLMID_HYBRIDMIDI_SENDMIDIBLOB = 0x30 | CLM_HybridMIDI | CLM_NeedResponse,
207 
208  CLMID_VMIDILINKIN_REGISTERNOTIFICATIONHANDLER = 0x00 | CLM_VMIDILinkIn | CLM_NeedResponse,
209 
210  CLMID_VMIDILINKOUT_REGISTERNOTIFICATIONHANDLER = 0x00 | CLM_VMIDILinkOut | CLM_NeedResponse,
211  CLMID_VMIDILINKOUT_SENDEVENTMESSAGETOCHANNEL = 0x08 | CLM_VMIDILinkOut | CLM_NeedResponse,
212  CLMID_VMIDILINKOUT_SENDMODIFIERMESSAGETOCHANNEL = 0x09 | CLM_VMIDILinkOut | CLM_NeedResponse,
213  CLMID_VMIDILINKOUT_SENDSELECTORMESSAGETOCHANNEL = 0x0A | CLM_VMIDILinkOut | CLM_NeedResponse,
214  CLMID_VMIDILINKOUT_CLOCK_TICK = 0x10 | CLM_VMIDILinkOut | CLM_NeedResponse,
215  CLMID_VMIDILINKOUT_CLOCK_RUNFROMSTART = 0x11 | CLM_VMIDILinkOut | CLM_NeedResponse,
216  CLMID_VMIDILINKOUT_CLOCK_STOP = 0x12 | CLM_VMIDILinkOut | CLM_NeedResponse,
217  CLMID_VMIDILINKOUT_CLOCK_RUN = 0x13 | CLM_VMIDILinkOut | CLM_NeedResponse,
218 
219  CLMID_VMIDILINKHYBRID_REGISTERVMIDILINKINNOTIFICATIONHANDLER = 0x00 | CLM_VMIDILinkHybrid | CLM_NeedResponse,
220  CLMID_VMIDILINKHYBRID_REGISTERVMIDILINKOUTNOTIFICATIONHANDLER = 0x01 | CLM_VMIDILinkHybrid | CLM_NeedResponse,
221  CLMID_VMIDILINKHYBRID_SENDEVENTMESSAGETOCHANNEL = 0x08 | CLM_VMIDILinkHybrid | CLM_NeedResponse,
222  CLMID_VMIDILINKHYBRID_SENDMODIFIERMESSAGETOCHANNEL = 0x09 | CLM_VMIDILinkHybrid | CLM_NeedResponse,
223  CLMID_VMIDILINKHYBRID_SENDSELECTORMESSAGETOCHANNEL = 0x0A | CLM_VMIDILinkHybrid | CLM_NeedResponse,
224  CLMID_VMIDILINKHYBRID_CLOCK_TICK = 0x10 | CLM_VMIDILinkHybrid | CLM_NeedResponse,
225  CLMID_VMIDILINKHYBRID_CLOCK_RUNFROMSTART = 0x11 | CLM_VMIDILinkHybrid | CLM_NeedResponse,
226  CLMID_VMIDILINKHYBRID_CLOCK_STOP = 0x12 | CLM_VMIDILinkHybrid | CLM_NeedResponse,
227  CLMID_VMIDILINKHYBRID_CLOCK_RUN = 0x13 | CLM_VMIDILinkHybrid | CLM_NeedResponse,
228 
229  CLMID_INPUT_REGISTERNOTIFICATIONHANDLER = 0x00 | CLM_Input | CLM_NeedResponse,
230  CLMID_INPUT_REGISTERCLOCKLISTENERCONTROLNOTIFICATIONHANDLER = 0x01 | CLM_Input | CLM_NeedResponse,
231  CLMID_INPUT_REGISTERPARAMETERNOTIFICATIONHANDLER = 0x02 | CLM_Input | CLM_NeedResponse,
232  CLMID_INPUT_ACTIVATEMESSAGETIMESTAMP = 0x08 | CLM_Input | CLM_NeedResponse,
233  CLMID_INPUT_GETINFO = 0x10 | CLM_Input | CLM_NeedResponse,
234  CLMID_INPUT_GETNAME = 0x11 | CLM_Input | CLM_NeedResponse,
235  CLMID_INPUT_SETNAME = 0x12 | CLM_Input | CLM_NeedResponse,
236  CLMID_INPUT_SETSECTIONID = 0x13 | CLM_Input | CLM_NeedResponse,
237  CLMID_INPUT_SETCAPABILITIES = 0x14 | CLM_Input | CLM_NeedResponse,
238  CLMID_INPUT_GETPATH = 0x15 | CLM_Input | CLM_NeedResponse,
239  CLMID_INPUT_SIGNAL = 0x18 | CLM_Input | CLM_NeedResponse,
240  CLMID_INPUT_DATACONSUMED = 0x20 | CLM_Input | CLM_NeedResponse,
241  CLMID_INPUT_CLOCK_SET = 0x30 | CLM_Input | CLM_NeedResponse,
242  CLMID_INPUT_ADDMODIFIERPARAMETER = 0x40 | CLM_Input | CLM_NeedResponse,
243  CLMID_INPUT_ADDSELECTORPARAMETER = 0x41 | CLM_Input | CLM_NeedResponse,
244  CLMID_INPUT_ADDTEXTPARAMETER = 0x42 | CLM_Input | CLM_NeedResponse,
245  CLMID_INPUT_ADDTITLEPARAMETER = 0x43 | CLM_Input | CLM_NeedResponse,
246  CLMID_INPUT_CLEARPARAMETERDEFINITION = 0x48 | CLM_Input | CLM_NeedResponse,
247  CLMID_INPUT_REFRESHPARAMETERDEFINITION = 0x49 | CLM_Input | CLM_NeedResponse,
248  CLMID_INPUT_GETSOURCE = 0x50 | CLM_Input | CLM_NeedResponse,
249  CLMID_INPUT_REMOVESOURCE = 0x51 | CLM_Input | CLM_NeedResponse,
250 
251  CLMID_INPUT_PARAM_REFRESHCURRENTMODIFIERPARAMETERVALUE = 0x00 | CLM_InputParameter | CLM_NeedResponse,
252  CLMID_INPUT_PARAM_REFRESHCURRENTSELECTORPARAMETERVALUE = 0x01 | CLM_InputParameter | CLM_NeedResponse,
253  CLMID_INPUT_PARAM_REFRESHCURRENTTEXTPARAMETERVALUE = 0x02 | CLM_InputParameter | CLM_NeedResponse,
254  CLMID_INPUT_PARAM_DECLAREPARAMETERCHANGED = 0x03 | CLM_InputParameter | CLM_NeedResponse,
255  CLMID_INPUT_PARAM_ADDMODIFIERSUPPORTEDDATATYPE = 0x04 | CLM_InputParameter | CLM_NeedResponse,
256 
257  CLMID_BASEOUTPUT_GETINFO = 0x00 | CLM_BaseOutput | CLM_NeedResponse,
258  CLMID_BASEOUTPUT_GETNAME = 0x01 | CLM_BaseOutput | CLM_NeedResponse,
259  CLMID_BASEOUTPUT_SETNAME = 0x02 | CLM_BaseOutput | CLM_NeedResponse,
260  CLMID_BASEOUTPUT_SETSECTIONID = 0x03 | CLM_BaseOutput | CLM_NeedResponse,
261  CLMID_BASEOUTPUT_ENABLESENDINGDURINGGLOBALLEARNING = 0x08 | CLM_BaseOutput | CLM_NeedResponse,
262  CLMID_BASEOUTPUT_CLEARTIMESTAMP = 0x10 | CLM_BaseOutput | CLM_NeedResponse,
263  CLMID_BASEOUTPUT_SETTIMESTAMPOFFLINE = 0x11 | CLM_BaseOutput | CLM_NeedResponse,
264  CLMID_BASEOUTPUT_SETTIMESTAMPSONGPOSITION = 0x12 | CLM_BaseOutput | CLM_NeedResponse,
265  CLMID_BASEOUTPUT_SETTIMESTAMPSYSTEMTIME = 0x13 | CLM_BaseOutput | CLM_NeedResponse,
266  CLMID_BASEOUTPUT_SETTIMESTAMPSYSTEMTIMEFROMGST = 0x14 | CLM_BaseOutput | CLM_NeedResponse,
267  CLMID_BASEOUTPUT_ENABLEAUTOTIMESTAMPONRECORDING = 0x15 | CLM_BaseOutput | CLM_NeedResponse,
268  CLMID_BASEOUTPUT_QUERYCURRENTPARAMETERVALUES = 0x20 | CLM_BaseOutput | CLM_NeedResponse,
269  CLMID_BASEOUTPUT_QUERYCURRENTPARAMETERVALUE = 0x21 | CLM_BaseOutput | CLM_NeedResponse,
270 
271  CLMID_OUTPUT_SETCAPABILITIES = 0x00 | CLM_Output | CLM_NeedResponse,
272  CLMID_OUTPUT_REGISTERNOTIFICATIONHANDLER = 0x10 | CLM_Output | CLM_NeedResponse,
273  CLMID_OUTPUT_REGISTERCLOCKGENERATORNOTIFICATIONHANDLER = 0x11 | CLM_Output | CLM_NeedResponse,
274  CLMID_OUTPUT_CLOCK_GENERATORCOMMAND = 0x20 | CLM_Output | CLM_NeedResponse,
275  CLMID_OUTPUT_CLOCK_SET = 0x21 | CLM_Output | CLM_NeedResponse,
276  CLMID_OUTPUT_CLOCK_TICK = 0x22 | CLM_Output | CLM_NeedResponse,
277  CLMID_OUTPUT_CLOCK_SETCONTROLLERINPUT = 0x30 | CLM_Output | CLM_NeedResponse,
278  CLMID_OUTPUT_CLOCK_RUNFROMSTART = 0x31 | CLM_Output | CLM_NeedResponse,
279  CLMID_OUTPUT_CLOCK_RUN = 0x32 | CLM_Output | CLM_NeedResponse,
280  CLMID_OUTPUT_CLOCK_STOP = 0x33 | CLM_Output | CLM_NeedResponse,
281  CLMID_OUTPUT_CLOCK_SETPOSITIONIMMEDIATE = 0x34 | CLM_Output | CLM_NeedResponse,
282  CLMID_OUTPUT_CLOCK_SETPOSITIONPREPARE = 0x35 | CLM_Output | CLM_NeedResponse,
283  CLMID_OUTPUT_CLOCK_SETPOSITIONTRIGGER = 0x36 | CLM_Output | CLM_NeedResponse,
284  CLMID_OUTPUT_CLOCK_FILLIN = 0x37 | CLM_Output | CLM_NeedResponse,
285  CLMID_OUTPUT_CLOCK_STATE = 0x38 | CLM_Output | CLM_NeedResponse,
286  CLMID_OUTPUT_CLEARDESTINATIONS = 0x40 | CLM_Output | CLM_NeedResponse,
287  CLMID_OUTPUT_ADDDESTINATION = 0x41 | CLM_Output | CLM_NeedResponse,
288  CLMID_OUTPUT_REMOVEDESTINATION = 0x42 | CLM_Output | CLM_NeedResponse,
289  CLMID_OUTPUT_REMOVEDESTINATIONBYINDEX = 0x43 | CLM_Output | CLM_NeedResponse,
290  CLMID_OUTPUT_GETDESTINATION = 0x44 | CLM_Output | CLM_NeedResponse,
291  CLMID_OUTPUT_ISREADYTOSEND = 0x50 | CLM_Output | CLM_NeedResponse,
292  CLMID_OUTPUT_SEND = 0x51 | CLM_Output | CLM_NeedResponse,
293  CLMID_OUTPUT_FLUSH = 0x52 | CLM_Output | CLM_NeedResponse,
294  CLMID_OUTPUT_SENDMODIFIERMESSAGE = 0x53 | CLM_Output | CLM_NeedResponse,
295  CLMID_OUTPUT_SENDEVENTMESSAGE = 0x54 | CLM_Output | CLM_NeedResponse,
296  CLMID_OUTPUT_SENDSELECTORMESSAGE = 0x55 | CLM_Output | CLM_NeedResponse,
297  CLMID_OUTPUT_SENDTEXTMESSAGE = 0x56 | CLM_Output | CLM_NeedResponse,
298  CLMID_OUTPUT_SENDMIDISYSEXMESSAGE = 0x57 | CLM_Output | CLM_NeedResponse,
299  CLMID_OUTPUT_SIGNAL = 0x60 | CLM_Output | CLM_NeedResponse,
300 
301  CLMID_CONTROLLER_GETINFO = 0x00 | CLM_Controller | CLM_NeedResponse,
302  CLMID_CONTROLLER_QUERYPARAMETERPATH = 0x01 | CLM_Controller | CLM_NeedResponse,
303  CLMID_CONTROLLER_REGISTERNOTIFICATIONHANDLER = 0x10 | CLM_Controller | CLM_NeedResponse,
304  CLMID_CONTROLLER_ASSIGN = 0x20 | CLM_Controller | CLM_NeedResponse,
305  CLMID_CONTROLLER_UNASSIGN = 0x21 | CLM_Controller | CLM_NeedResponse,
306  CLMID_CONTROLLER_ENTERLEARNINGMODE = 0x22 | CLM_Controller | CLM_NeedResponse,
307  CLMID_CONTROLLER_SENDVALUE = 0x23 | CLM_Controller | CLM_NeedResponse,
308  CLMID_CONTROLLER_SENDVALUEWITHAUTOMATION = 0x24 | CLM_Controller | CLM_NeedResponse,
309  CLMID_CONTROLLER_SENDTEXTVALUE = 0x25 | CLM_Controller | CLM_NeedResponse,
310  CLMID_CONTROLLER_SENDTEXTVALUEWITHAUTOMATION = 0x26 | CLM_Controller | CLM_NeedResponse,
311  CLMID_CONTROLLER_SENDDOWN = 0x27 | CLM_Controller | CLM_NeedResponse,
312  CLMID_CONTROLLER_SENDUP = 0x28 | CLM_Controller | CLM_NeedResponse,
313  CLMID_CONTROLLER_QUERYPARAMETERVALUE = 0x30 | CLM_Controller | CLM_NeedResponse,
314 
315  CLMID_DATATRANSFERMESSAGE_SETNUMBER = 0x00 | CLM_DataTransferMessage | CLM_NeedResponse,
316  CLMID_DATATRANSFERMESSAGE_GETNUMBER = 0x01 | CLM_DataTransferMessage | CLM_NeedResponse,
317  CLMID_DATATRANSFERMESSAGE_GETSENDBUFFERLENGTH = 0x02 | CLM_DataTransferMessage | CLM_NeedResponse,
318  CLMID_DATATRANSFERMESSAGE_SETSENDBUFFER = 0x03 | CLM_DataTransferMessage | CLM_NeedResponse,
319  CLMID_DATATRANSFERMESSAGE_GETRECEIVEBUFFERLENGTH = 0x04 | CLM_DataTransferMessage | CLM_NeedResponse,
320  CLMID_DATATRANSFERMESSAGE_GETRECEIVEBUFFER = 0x05 | CLM_DataTransferMessage | CLM_NeedResponse,
321 
322  CLMID_PIPE_REGISTERNOTIFICATIONHANDLER = 0x00 | CLM_Pipe | CLM_NeedResponse,
323  CLMID_PIPE_GETPIPEINFO = 0x10 | CLM_Pipe | CLM_NeedResponse,
324  CLMID_PIPE_CLEARCONNECTIONS = 0x20 | CLM_Pipe | CLM_NeedResponse,
325  CLMID_PIPE_ADDCONNECTION = 0x21 | CLM_Pipe | CLM_NeedResponse,
326  CLMID_PIPE_REMOVECONNECTION = 0x22 | CLM_Pipe | CLM_NeedResponse,
327  CLMID_PIPE_REMOVECONNECTIONBYINDEX = 0x23 | CLM_Pipe | CLM_NeedResponse,
328  CLMID_PIPE_GETCONNECTION = 0x24 | CLM_Pipe | CLM_NeedResponse,
329  CLMID_PIPE_ISREADYTOSEND = 0x30 | CLM_Pipe | CLM_NeedResponse,
330  CLMID_PIPE_SEND = 0x31 | CLM_Pipe | CLM_NeedResponse,
331  CLMID_PIPE_FLUSH = 0x32 | CLM_Pipe | CLM_NeedResponse,
332  CLMID_PIPE_SENDMODIFIERMESSAGE = 0x33 | CLM_Pipe | CLM_NeedResponse,
333  CLMID_PIPE_SENDEVENTMESSAGE = 0x34 | CLM_Pipe | CLM_NeedResponse,
334  CLMID_PIPE_SENDSELECTORMESSAGE = 0x35 | CLM_Pipe | CLM_NeedResponse,
335  CLMID_PIPE_SENDTEXTMESSAGE = 0x36 | CLM_Pipe | CLM_NeedResponse,
336  CLMID_PIPE_SIGNAL = 0x40 | CLM_Pipe | CLM_NeedResponse,
337  CLMID_PIPE_DATACONSUMED = 0x50 | CLM_Pipe | CLM_NeedResponse,
338 
339  CLMID_SHAREDDISPLAY_REGISTERNOTIFICATIONHANDLER = 0x00 | CLM_SharedDisplay | CLM_NeedResponse,
340  CLMID_SHAREDDISPLAY_ACCEPT = 0x10 | CLM_SharedDisplay | CLM_NeedResponse,
341  CLMID_SHAREDDISPLAY_RELEASESHAREDDISPLAY = 0x11 | CLM_SharedDisplay | CLM_NeedResponse,
342  CLMID_SHAREDDISPLAY_SENDKEY = 0x20 | CLM_SharedDisplay | CLM_NeedResponse,
343 
344  CLMID_SHAREDDISPLAYCLIENT_REGISTERNOTIFICATIONHANDLER = 0x00 | CLM_SharedDisplayClient | CLM_NeedResponse,
345  CLMID_SHAREDDISPLAYCLIENT_REQUESTSHAREDDISPLAY = 0x10 | CLM_SharedDisplayClient | CLM_NeedResponse,
346  CLMID_SHAREDDISPLAYCLIENT_RELEASESHAREDDISPLAY = 0x11 | CLM_SharedDisplayClient | CLM_NeedResponse,
347  CLMID_SHAREDDISPLAYCLIENT_CLEARDISPLAY = 0x20 | CLM_SharedDisplayClient | CLM_NeedResponse,
348  CLMID_SHAREDDISPLAYCLIENT_SETTEXT = 0x21 | CLM_SharedDisplayClient | CLM_NeedResponse,
349  CLMID_SHAREDDISPLAYCLIENT_SETCURSOR = 0x22 | CLM_SharedDisplayClient | CLM_NeedResponse,
350  CLMID_SHAREDDISPLAYCLIENT_GETSIZE = 0x23 | CLM_SharedDisplayClient | CLM_NeedResponse,
351  CLMID_SHAREDDISPLAYCLIENT_GETCURSORPOS = 0x24 | CLM_SharedDisplayClient | CLM_NeedResponse,
352 
353  CLMID_SERVER_SETASYNCTIMEOUT = 0x00 | CLM_Server | CLM_NeedResponse,
354  CLMID_SERVER_ENDOFASYNC = 0x01 | CLM_Server | CLM_NeedResponse,
355 
356  _CLMID_Mask = 0xFF
357 
358 } CLC_ClientToServerMethodIDs;
359 
360 typedef enum
361 {
362  CLMID_CHAI_NOTIFICATION_NOTIFICATION = 0x00 | CLM_CHAI | CLM_CmdFromServer,
363  CLMID_CHAI_NOTIFICATION_DEVICEDECLARATION = 0x01 | CLM_CHAI | CLM_CmdFromServer,
364  CLMID_CHAI_NOTIFICATION_DEVICEDISCARDED = 0x02 | CLM_CHAI | CLM_CmdFromServer,
365  CLMID_CHAI_NOTIFICATION_DEVICEIDENTITYCHANGED = 0x03 | CLM_CHAI | CLM_CmdFromServer,
366  CLMID_CHAI_NOTIFICATION_WARNING = 0x04 | CLM_CHAI | CLM_CmdFromServer,
367  CLMID_CHAI_NOTIFICATION_GLOBALTIMER = 0x10 | CLM_CHAI | CLM_CmdFromServer,
368  CLMID_CHAI_NOTIFICATION_SIGNAL = 0x20 | CLM_CHAI | CLM_CmdFromServer,
369  CLMID_CHAI_ASYNCRETURN_REMOTEDEVICE_FIND_SUCCESS = 0x30 | CLM_CHAI | CLM_CmdFromServer,
370  CLMID_CHAI_ASYNCRETURN_REMOTEDEVICE_FIND_FAILURE = 0x31 | CLM_CHAI | CLM_CmdFromServer,
371 
372  CLMID_REMOTEDEVICE_NOTIFICATION_READY = 0x00 | CLM_RemoteDevice | CLM_CmdFromServer,
373  CLMID_REMOTEDEVICE_ASYNCRETURN_GETNAME = 0x01 | CLM_RemoteDevice | CLM_CmdFromServer,
374  CLMID_REMOTEDEVICE_ASYNCRETURN_GETPROPERTYSTRING = 0x08 | CLM_RemoteDevice | CLM_CmdFromServer,
375  CLMID_REMOTEDEVICE_ASYNCRETURN_GETPROPERTYNUMERIC = 0x09 | CLM_RemoteDevice | CLM_CmdFromServer,
376  CLMID_REMOTEDEVICE_ASYNCRETURN_GETINPUTINFO = 0x10 | CLM_RemoteDevice | CLM_CmdFromServer,
377  CLMID_REMOTEDEVICE_ASYNCRETURN_GETOUTPUTINFO = 0x11 | CLM_RemoteDevice | CLM_CmdFromServer,
378  CLMID_REMOTEDEVICE_ASYNCRETURN_GETDESTINATION = 0x20 | CLM_RemoteDevice | CLM_CmdFromServer,
379  CLMID_REMOTEDEVICE_ASYNCRETURN_GETDETAILEDDESTINATION = 0x21 | CLM_RemoteDevice | CLM_CmdFromServer,
380  CLMID_REMOTEDEVICE_ASYNCRETURN_GETDESTINATIONCOUNT = 0x22 | CLM_RemoteDevice | CLM_CmdFromServer,
381  CLMID_REMOTEDEVICE_ASYNCRETURN_GETCONNECTEDDEVICES = 0x23 | CLM_RemoteDevice | CLM_CmdFromServer,
382  CLMID_REMOTEDEVICE_ASYNCRETURN_GETPARAMINFOMODIFIER = 0x30 | CLM_RemoteDevice | CLM_CmdFromServer,
383  CLMID_REMOTEDEVICE_ASYNCRETURN_GETPARAMINFOSELECTOR = 0x31 | CLM_RemoteDevice | CLM_CmdFromServer,
384  CLMID_REMOTEDEVICE_ASYNCRETURN_GETPARAMINFOTEXT = 0x32 | CLM_RemoteDevice | CLM_CmdFromServer,
385  CLMID_REMOTEDEVICE_ASYNCRETURN_GETPARAMINFONODATA = 0x33 | CLM_RemoteDevice | CLM_CmdFromServer,
386  CLMID_REMOTEDEVICE_ASYNCRETURN_GETCONTROLLERINFO = 0x38 | CLM_RemoteDevice | CLM_CmdFromServer,
387  CLMID_REMOTEDEVICE_ASYNCRETURN_GETMODIFIERDATATYPEINFO = 0x40 | CLM_RemoteDevice | CLM_CmdFromServer,
388  CLMID_REMOTEDEVICE_ASYNCRETURN_GETSELECTORPARAMVALUETEXT = 0x41 | CLM_RemoteDevice | CLM_CmdFromServer,
389  CLMID_REMOTEDEVICE_ASYNCRETURN_GETINDEXLISTITEM = 0x48 | CLM_RemoteDevice | CLM_CmdFromServer,
390  CLMID_REMOTEDEVICE_ASYNCRETURN_COLLECTSNAPSHOTDATA = 0x50 | CLM_RemoteDevice | CLM_CmdFromServer,
391  CLMID_REMOTEDEVICE_ASYNCRETURN_RESTORESNAPSHOTDATA = 0x51 | CLM_RemoteDevice | CLM_CmdFromServer,
392  CLMID_REMOTEDEVICE_ASYNCRETURN_SMARTCONNECTSTART = 0x60 | CLM_RemoteDevice | CLM_CmdFromServer,
393 
394  CLMID_BASELOCALDEVICE_NOTIFICATION_NOTIFICATION = 0x00 | CLM_LocalDevice | CLM_CmdFromServer,
395  CLMID_BASELOCALDEVICE_NOTIFICATION_SNAPSHOT_REQUESTCOLLECTSNAPSHOTDATA = 0x10 | CLM_LocalDevice | CLM_CmdFromServer,
396  CLMID_BASELOCALDEVICE_NOTIFICATION_SNAPSHOT_REQUESTRESTORESNAPSHOTDATA = 0x11 | CLM_LocalDevice | CLM_CmdFromServer,
397  CLMID_BASELOCALDEVICE_NOTIFICATION_SIGNAL_SIGNAL = 0x20 | CLM_LocalDevice | CLM_CmdFromServer,
398  CLMID_BASELOCALDEVICE_NOTIFICATION_SCT_STARTED = 0x30 | CLM_LocalDevice | CLM_CmdFromServer,
399  CLMID_BASELOCALDEVICE_NOTIFICATION_SCT_SECTIONLISTREPLY = 0x31 | CLM_LocalDevice | CLM_CmdFromServer,
400  CLMID_BASELOCALDEVICE_NOTIFICATION_SCT_CONTROLLERLISTREPLY = 0x32 | CLM_LocalDevice | CLM_CmdFromServer,
401  CLMID_BASELOCALDEVICE_NOTIFICATION_SCT_FINISHED = 0x33 | CLM_LocalDevice | CLM_CmdFromServer,
402 
403  CLMID_CP2MIDI_NOTIFICATION_MIDIMESSAGE = 0x00 | CLM_CP2MIDI | CLM_CmdFromServer,
404  CLMID_CP2MIDI_NOTIFICATION_MIDISYSEX = 0x01 | CLM_CP2MIDI | CLM_CmdFromServer,
405 
406  CLMID_INPUT_NOTIFICATION_MESSSAGE = 0x00 | CLM_Input | CLM_CmdFromServer,
407  CLMID_INPUT_NOTIFICATION_SOURCECHANGE = 0x01 | CLM_Input | CLM_CmdFromServer,
408  CLMID_INPUT_NOTIFICATION_CLOCKDEFINITION = 0x10 | CLM_Input | CLM_CmdFromServer,
409  CLMID_INPUT_NOTIFICATION_CLOCKTICK = 0x11 | CLM_Input | CLM_CmdFromServer,
410  CLMID_INPUT_NOTIFICATION_CLOCKCOMMAND = 0x12 | CLM_Input | CLM_CmdFromServer,
411  CLMID_INPUT_NOTIFICATION_CLOCKSETPOSITION = 0x13 | CLM_Input | CLM_CmdFromServer,
412  CLMID_INPUT_NOTIFICATION_PARAM_REQUESTREFRESHCURRENTVALUE = 0x20 | CLM_Input | CLM_CmdFromServer,
413  CLMID_INPUT_NOTIFICATION_PARAM_ONMODIFIERUPDATE = 0x21 | CLM_Input | CLM_CmdFromServer,
414  CLMID_INPUT_NOTIFICATION_PARAM_ONSELECTORUPDATE = 0x22 | CLM_Input | CLM_CmdFromServer,
415  CLMID_INPUT_NOTIFICATION_PARAM_ONTEXTUPDATE = 0x23 | CLM_Input | CLM_CmdFromServer,
416 
417  CLMID_OUTPUT_NOTIFICATION_FLOWCONTROL = 0x00 | CLM_Output | CLM_CmdFromServer,
418  CLMID_OUTPUT_NOTIFICATION_DATACONSUMED = 0x04 | CLM_Output | CLM_CmdFromServer,
419  CLMID_OUTPUT_NOTIFICATION_DESTINATIONCHANGE = 0x08 | CLM_Output | CLM_CmdFromServer,
420  CLMID_OUTPUT_NOTIFICATION_REFRESHPARAMETERDEFINITION = 0x10 | CLM_Output | CLM_CmdFromServer,
421  CLMID_OUTPUT_NOTIFICATION_UPDATEINDEXLISTCONTENT = 0x11 | CLM_Output | CLM_CmdFromServer,
422  CLMID_OUTPUT_NOTIFICATION_UPDATESELECTORITEMLISTCONTENT = 0x12 | CLM_Output | CLM_CmdFromServer,
423  CLMID_OUTPUT_NOTIFICATION_REFRESHCURRENTMODIFIERPARAMVALUE = 0x18 | CLM_Output | CLM_CmdFromServer,
424  CLMID_OUTPUT_NOTIFICATION_REFRESHCURRENTSELECTORPARAMVALUE = 0x19 | CLM_Output | CLM_CmdFromServer,
425  CLMID_OUTPUT_NOTIFICATION_REFRESHCURRENTTEXTPARAMVALUE = 0x1A | CLM_Output | CLM_CmdFromServer,
426  CLMID_OUTPUT_NOTIFICATION_CLOCKGENERATORCOMMAND = 0x20 | CLM_Output | CLM_CmdFromServer,
427 
428  CLMID_CONTROLLER_NOTIFICATION_CONNECTIONSTATUS = 0x00 | CLM_Controller | CLM_CmdFromServer,
429  CLMID_CONTROLLER_NOTIFICATION_REFRESHCURRENTMODIFIERPARAMVALUE = 0x10 | CLM_Controller | CLM_CmdFromServer,
430  CLMID_CONTROLLER_NOTIFICATION_REFRESHCURRENTSELECTORPARAMVALUE = 0x11 | CLM_Controller | CLM_CmdFromServer,
431  CLMID_CONTROLLER_NOTIFICATION_REFRESHCURRENTTEXTPARAMVALUE = 0x12 | CLM_Controller | CLM_CmdFromServer,
432  CLMID_CONTROLLER_NOTIFICATION_ASSIGN = 0x20 | CLM_Controller | CLM_CmdFromServer,
433  CLMID_CONTROLLER_NOTIFICATION_ONPARAMETERPATHREPLY = 0x30 | CLM_Controller | CLM_CmdFromServer,
434  CLMID_CONTROLLER_NOTIFICATION_ONLEARNINGMODECHANGE = 0x40 | CLM_Controller | CLM_CmdFromServer,
435 
436  CLMID_PIPE_NOTIFICATION_PEERCHANGE = 0x00 | CLM_Pipe | CLM_CmdFromServer,
437  CLMID_PIPE_NOTIFICATION_DATACONSUMED = 0x04 | CLM_Pipe | CLM_CmdFromServer,
438  CLMID_PIPE_NOTIFICATION_MESSAGE = 0x08 | CLM_Pipe | CLM_CmdFromServer,
439 
440  CLMID_SHAREDDISPLAY_NOTIFICATION_REQUEST = 0x00 | CLM_SharedDisplay | CLM_CmdFromServer,
441  CLMID_SHAREDDISPLAY_NOTIFICATION_SESSIONCLOSED = 0x01 | CLM_SharedDisplay | CLM_CmdFromServer,
442  CLMID_SHAREDDISPLAY_NOTIFICATION_DISPLAYCLEAR = 0x10 | CLM_SharedDisplay | CLM_CmdFromServer,
443  CLMID_SHAREDDISPLAY_NOTIFICATION_SETTEXT = 0x11 | CLM_SharedDisplay | CLM_CmdFromServer,
444  CLMID_SHAREDDISPLAY_NOTIFICATION_SETCURSOR = 0x12 | CLM_SharedDisplay | CLM_CmdFromServer,
445 
446  CLMID_SHAREDDISPLAYCLIENT_NOTIFICATION_REQUESTACCEPTED = 0x00 | CLM_SharedDisplayClient | CLM_CmdFromServer,
447  CLMID_SHAREDDISPLAYCLIENT_NOTIFICATION_SESSIONCLOSED = 0x01 | CLM_SharedDisplayClient | CLM_CmdFromServer,
448  CLMID_SHAREDDISPLAYCLIENT_NOTIFICATION_ONKEY = 0x10 | CLM_SharedDisplayClient | CLM_CmdFromServer,
449 
450  CLMID_VMIDILINKIN_NOTIFICATION_STATUSCHANGE = 0x00 | CLM_VMIDILinkIn | CLM_CmdFromServer,
451  CLMID_VMIDILINKIN_NOTIFICATION_MESSSAGE = 0x01 | CLM_VMIDILinkIn | CLM_CmdFromServer,
452  CLMID_VMIDILINKIN_NOTIFICATION_CLOCKTICK = 0x02 | CLM_VMIDILinkIn | CLM_CmdFromServer,
453  CLMID_VMIDILINKIN_NOTIFICATION_CLOCKCOMMAND = 0x03 | CLM_VMIDILinkIn | CLM_CmdFromServer,
454 
455  CLMID_VMIDILINKOUT_NOTIFICATION_STATUSCHANGE = 0x00 | CLM_VMIDILinkOut | CLM_CmdFromServer,
456  CLMID_VMIDILINKOUT_NOTIFICATION_DATACONSUMED = 0x01 | CLM_VMIDILinkOut | CLM_CmdFromServer,
457 
458  // Following opcodes are for embedded systems that use the CPVNM Chip
459  CLMID_SERVER_ASKTOENTERBL = 0x80 | CLM_Server | CLM_CmdFromServer // The CPVNM Chip Ask the client to enter in boot loader mode. The client must reply with a CLMID_SERVER_RESETVNM
460 } CLC_ServerToClientMethodIDs;
461 
463 
469 typedef enum
470 {
471  CLC_ErrorCode_Success = 0x0000,
472 
473  CLC_ErrorCode_CPErrorsReserved = 0x00FF,
474 
475  CLC_ErrorCode_General_MissingARHCallback = 0x01 | CLM_General,
476  CLC_ErrorCode_General_MissingNHCallback = 0x02 | CLM_General,
477  CLC_ErrorCode_General_UnknownModule = 0x03 | CLM_General,
478  CLC_ErrorCode_General_FunctionNotRecognized = 0x04 | CLM_General,
479  CLC_ErrorCode_General_BadPayloadSize = 0x05 | CLM_General,
480  CLC_ErrorCode_General_BadFunctionReturn = 0x06 | CLM_General,
481  CLC_ErrorCode_General_AlreadyProcessingAsync = 0x07 | CLM_General,
482  CLC_ErrorCode_General_DataToLarge = 0x08 | CLM_General,
483  CLC_ErrorCode_General_CannotCallFromSystem = 0x09 | CLM_General,
484  CLC_ErrorCode_General_InvalidHandle = 0x0A | CLM_General,
485  CLC_ErrorCode_General_NotConnected = 0x0B | CLM_General,
486  CLC_ErrorCode_General_LowResources = 0x0B | CLM_General,
487  CLC_ErrorCode_General_ArrayTooLarge = 0x0C | CLM_General,
488  CLC_ErrorCode_General_InvalidParameter = 0x0D | CLM_General,
489 
490  CLC_ErrorCode_CHAI_InvalidDuplicateNumber = 0x01 | CLM_CHAI, // 0 and 0xFFFFFFFF are not allowed for embedded systems
491 
492  CLC_ErrorCode_LovalDevice_DeviceTypeNotSupported = 0x01 | CLM_LocalDevice,
493 
494  CLC_ErrorCode_Client_TransportWriteFailed = 0x01 | CLM_Client,
495  CLC_ErrorCode_Client_FunctionReturnTimeout = 0x02 | CLM_Client,
496 
497  CLC_ErrorCode_Server_ObjectTypeUnknown = 0x01 | CLM_Server,
498  CLC_ErrorCode_Server_MemoryAllocation = 0x02 | CLM_Server,
499  CLC_ErrorCode_Server_EthNotAvailable = 0x03 | CLM_Server,
500  CLC_ErrorCode_Server_EthFrameTooLong = 0x04 | CLM_Server,
501 
502  CLC_ErrorCode_ModuleMask = 0xFF00,
503  CLC_ErrorCode_IndexMask = 0x00FF
504 } CLC_ErrorCode;
505 
509 typedef enum
510 {
511  // CHAI
512  NEF_CHAI_Notification = 0x00000001,
513  NEF_CHAI_DeviceDeclaration = 0x00000002,
514  NEF_CHAI_DeviceDiscarded = 0x00000004,
515  NEF_CHAI_DeviceIdentityChanged = 0x00000008,
516  NEF_CHAI_Warning = 0x00000010,
517  NEF_CHAI_Mask = 0x0000001F,
518  NEF_CHAI_Signal = 0x00000020,
519  NEF_CHAI_Signal_Mask = 0x00000020,
520  NEF_CHAI_GlobalTimer = 0x00000040,
521  NEF_CHAI_GlobalTimer_Mask = 0x00000040,
522 
523  // Base Local Device
524  NEF_LocalDevice_Notification = 0x00000001,
525  NEF_LocalDevice_Notification_Mask = 0x00000001,
526  NEF_LocalDevice_Snapshot = 0x00000010,
527  NEF_LocalDevice_Snapshot_Mask = 0x00000010,
528  NEF_LocalDevice_Signal = 0x00000020,
529  NEF_LocalDevice_Signal_Mask = 0x00000020,
530  NEF_LocalDevice_SmartConnectTarget = 0x00000040,
531  NEF_LocalDevice_SmartConnectTarget_Mask = 0x00000040,
532  NEF_LocalDevice_Reserverd = 0x0000FF80,
533  // CP2MIDI & HybridMIDI Device Notification (inherit from base local device)
534  NEF_LocalDevice_CP2MIDI_Notification = 0x00010000,
535  NEF_LocalDevice_CP2MIDI_Notification_Mask = 0x00010000,
536  // VMIDILink In Device Notification (inherit from CP2Midi)
537  NEF_LocalDevice_VMIDILinkIn_StatusChange = 0x00100000,
538  NEF_LocalDevice_VMIDILinkIn_EventMessage = 0x00200000,
539  NEF_LocalDevice_VMIDILinkIn_ModifierMessage = 0x00400000,
540  NEF_LocalDevice_VMIDILinkIn_SelectorMessage = 0x00800000,
541  NEF_LocalDevice_VMIDILinkIn_MIDISysExMessage = 0x01000000,
542  NEF_LocalDevice_VMIDILinkIn_Clock = 0x02000000,
543  NEF_LocalDevice_VMIDILinkIn_Mask = 0x03F00000,
544  // VMIDILink Out Device Notification
545  NEF_LocalDevice_VMIDILinkOut_StatusChange = 0x10000000,
546  NEF_LocalDevice_VMIDILinkOut_DataConsumed = 0x20000000,
547  NEF_LocalDevice_VMIDILinkOut_Mask = 0x30000000,
548 
549  // Shared Display Device Notification (inherit from base local device)
550  NEF_LocalDevice_SharedDisplay_Notification = 0x00010000,
551  NEF_LocalDevice_SharedDisplay_Notification_Mask = 0x00010000,
552  // Shared Display Client Device Notification (inherit from base local device)
553  NEF_LocalDevice_SharedDisplayClient_Notification = 0x00010000,
554  NEF_LocalDevice_SharedDisplayClient_Notification_Mask = 0x00010000,
555 
556  // Remote Device
557  NEF_RemoteDevice_Notification = 0x00000001,
558  NEF_RemoteDevice_Notification_Mask = 0x00000001,
559 
560  // Input
561  NEF_Input_SourceChange = 0x00000001,
562  NEF_Input_Message = 0x00000010,
563  NEF_Input_EventMessage = 0x00000020,
564  NEF_Input_ModifierMessage = 0x00000040,
565  NEF_Input_SelectorMessage = 0x00000080,
566  NEF_Input_TextMessage = 0x00000100,
567  NEF_Input_SysExMessage = 0x00000200,
568  NEF_Input_Mask = 0x000003F1,
569  NEF_Input_ClockListenerControl = 0x00001000,
570  NEF_Input_ClockListenerControl_Mask = 0x00001000,
571  NEF_Input_Parameter = 0x00010000,
572  NEF_Input_Parameter_Mask = 0x00010000,
573 
574  // Output
575  NEF_Output_FlowControl = 0x00000001,
576  NEF_Output_DestinationChange = 0x00000002,
577  NEF_Output_RefreshParameterDefinition = 0x00000004,
578  NEF_Output_UpdateIndexListContent = 0x00000008,
579  NEF_Output_UpdateSelectorItemListContent = 0x00000010,
580  NEF_Output_RefreshCurrentModifierParamValue = 0x00000020,
581  NEF_Output_RefreshCurrentSelectorParamValue = 0x00000040,
582  NEF_Output_RefreshCurrentTextParamValue = 0x00000080,
583  NEF_Output_DataConsumed = 0x00000100,
584  NEF_Output_Mask = 0x000001FF,
585  NEF_Output_ClockGenerator = 0x00001000,
586  NEF_Output_ClockGenerator_Mask = 0x00001000,
587 
588  // Controller
589  NEF_Controller_ConnectionStatus = 0x00000001,
590  NEF_Controller_RefreshCurrentModifierParameterValue = 0x00000002,
591  NEF_Controller_RefreshCurrentSelectorParameterValue = 0x00000004,
592  NEF_Controller_RefreshCurrentTextParameterValue = 0x00000008,
593  NEF_Controller_Assign = 0x00000010,
594  NEF_Controller_OnParameterPathReply = 0x00000020,
595  NEF_Controller_OnLearningModeChange = 0x00000040,
596  NEF_Controller_Mask = 0x0000007F,
597 
598  // Pipe
599  NEF_Pipe_PeerChange = 0x00000001,
600  NEF_Pipe_Message = 0x00000010,
601  NEF_Pipe_EventMessage = 0x00000020,
602  NEF_Pipe_ModifierMessage = 0x00000040,
603  NEF_Pipe_SelectorMessage = 0x00000080,
604  NEF_Pipe_TextMessage = 0x00000100,
605  NEF_Pipe_SysExMessage = 0x00000200,
606  NEF_Pipe_DataConsumed = 0x00001000,
607  NEF_Pipe_Mask = 0x000013F1
608 } CLC_NotificationEnableFlags;
609 
611 
612 #define CLM_SERVER_RESET_DELAY_MS 200
613 
614 #ifdef __cplusplus
615 }
616 #endif
617 
618 #endif // __CLCM_CLDEFINES_H__
_CLM_Mask_
Definition: CLCm_Defines.h:65
CLC_ErrorCode_General_CannotCallFromSystem
Definition: CLCm_Defines.h:483
CLC_ErrorCode_General_UnknownModule
Definition: CLCm_Defines.h:477
CLM_BaseOutput
Definition: CLCm_Defines.h:53
CLM_Input
Definition: CLCm_Defines.h:52
CLC_ErrorCode_General_BadFunctionReturn
Definition: CLCm_Defines.h:480
CLC_ErrorCode_ModuleMask
Definition: CLCm_Defines.h:502
CLM_Client
Definition: CLCm_Defines.h:41
CLM_Server
Definition: CLCm_Defines.h:42
CLC_ErrorCode
CLC_ErrorCode
Error code Enumeration. Error codes from 0x01 to 0xFF are related to a CopperLan functions return cod...
Definition: CLCm_Defines.h:469
CLM_Async
Definition: CLCm_Defines.h:45
CLM_General
Definition: CLCm_Defines.h:43
CLC_ErrorCode_General_BadPayloadSize
Definition: CLCm_Defines.h:479
CLC_ErrorCode_CPErrorsReserved
Definition: CLCm_Defines.h:473
CLC_ErrorCode_LovalDevice_DeviceTypeNotSupported
Definition: CLCm_Defines.h:492
CLC_ErrorCode_General_MissingARHCallback
Definition: CLCm_Defines.h:475
CLM_DataTransferMessage
Definition: CLCm_Defines.h:63
CLM_MIDI2CP
Definition: CLCm_Defines.h:50
CLM_SharedDisplay
Definition: CLCm_Defines.h:57
CLM_LocalDevice
Definition: CLCm_Defines.h:48
CLC_ErrorCode_Client_TransportWriteFailed
Definition: CLCm_Defines.h:494
CLM_TransportProtocol
Definition: CLCm_Defines.h:64
CLC_ErrorCode_Client_FunctionReturnTimeout
Definition: CLCm_Defines.h:495
CLC_ErrorCode_Server_EthFrameTooLong
Definition: CLCm_Defines.h:500
CLC_ErrorCode_General_FunctionNotRecognized
Definition: CLCm_Defines.h:478
CLC_ErrorCode_General_MissingNHCallback
Definition: CLCm_Defines.h:476
CLM_RemoteDevice
Definition: CLCm_Defines.h:47
CLM_InputParameter
Definition: CLCm_Defines.h:59
CLM_Controller
Definition: CLCm_Defines.h:55
CLM_SharedDisplayClient
Definition: CLCm_Defines.h:58
CLCm_Types.h
CLM_CHAI
Definition: CLCm_Defines.h:46
CLM_HybridMIDI
Definition: CLCm_Defines.h:51
CLC_Modules
CLC_Modules
CHAILink module list.
Definition: CLCm_Defines.h:39
CLC_ErrorCode_CHAI_InvalidDuplicateNumber
Definition: CLCm_Defines.h:490
CLC_ErrorCode_Success
Definition: CLCm_Defines.h:471
CLC_ErrorCode_General_InvalidHandle
Definition: CLCm_Defines.h:484
CLM_Pipe
Definition: CLCm_Defines.h:56
CLM_CmdFromServer
Definition: CLCm_Defines.h:68
_CLM_CmdFromMask_
Definition: CLCm_Defines.h:69
CLC_ErrorCode_General_ArrayTooLarge
Definition: CLCm_Defines.h:487
CLC_ErrorCode_General_LowResources
Definition: CLCm_Defines.h:486
CLM_CmdFromClient
Definition: CLCm_Defines.h:67
CLC_ErrorCode_IndexMask
Definition: CLCm_Defines.h:503
CLM_NeedResponse
Definition: CLCm_Defines.h:71
CLM_CP2MIDI
Definition: CLCm_Defines.h:49
CLC_ErrorCode_General_DataToLarge
Definition: CLCm_Defines.h:482
CLC_ErrorCode_Server_EthNotAvailable
Definition: CLCm_Defines.h:499
CLM_Output
Definition: CLCm_Defines.h:54
CLM_VMIDILinkHybrid
Definition: CLCm_Defines.h:62
CLM_HookedObject
Definition: CLCm_Defines.h:44
CLC_ErrorCode_General_InvalidParameter
Definition: CLCm_Defines.h:488
CLC_ErrorCode_Server_ObjectTypeUnknown
Definition: CLCm_Defines.h:497
CLM_VMIDILinkIn
Definition: CLCm_Defines.h:60
CLC_ErrorCode_General_AlreadyProcessingAsync
Definition: CLCm_Defines.h:481
CLM_VMIDILinkOut
Definition: CLCm_Defines.h:61
CLC_ErrorCode_Server_MemoryAllocation
Definition: CLCm_Defines.h:498
CLC_ErrorCode_General_NotConnected
Definition: CLCm_Defines.h:485