SIDX 7
SIDXCDevice.h
Go to the documentation of this file.
1 
6 #include "SIDXCConstants.h"
7 
8 #ifndef SIDXCDevice_H
9 #define SIDXCDevice_H
10 
11 
21 __declspec(dllexport) int SIDXDeviceActionDo(void* SIDXdevice, int setting, const wchar_t* command);
33 __declspec(dllexport) int SIDXDeviceActionGetByItem(void* SIDXdevice, int index, int& setting);
44 __declspec(dllexport) int SIDXDeviceActionGetByName
45  (void* SIDXdevice, const wchar_t* name, int& setting);
54 __declspec(dllexport) int SIDXDeviceActionGetCount(void* SIDXdevice, int& count);
68 __declspec(dllexport) int SIDXDeviceActionGetName
69  (void* SIDXdevice, int index, wchar_t* name, size_t length);
70 
83 __declspec(dllexport) int SIDXDeviceDriverGetDescription
84  (void* SIDXdevice, wchar_t* description, size_t length);
96 __declspec(dllexport) int SIDXDeviceDriverGetName(void* SIDXdevice, wchar_t* name, size_t length);
104 __declspec(dllexport) int SIDXDeviceDriverGetType(void* SIDXdevice, SIDXDriverType& type);
105 
115 __declspec(dllexport) int SIDXDeviceExtraBooleanGet(void* SIDXdevice, int setting, bool& value);
125 __declspec(dllexport) int SIDXDeviceExtraBooleanSet(void* SIDXdevice, int setting, bool value);
126 
137 __declspec(dllexport) int SIDXDeviceExtraGetByItem(void* SIDXdevice, int item, int& setting);
148 __declspec(dllexport) int SIDXDeviceExtraGetByName
149  (void* SIDXdevice, const wchar_t* name, int& setting);
158 __declspec(dllexport) int SIDXDeviceExtraGetCount(void* SIDXdevice, int& count);
171 __declspec(dllexport) int SIDXDeviceExtraGetLabel
172  (void* SIDXdevice, int setting, wchar_t* label, size_t length);
186 __declspec(dllexport) int SIDXDeviceExtraGetName
187  (void* SIDXdevice, int item, wchar_t* name, size_t length);
197 __declspec(dllexport) int SIDXDeviceExtraGetType(void* SIDXdevice, int setting, SIDXSettingType& type);
213 __declspec(dllexport) int SIDXDeviceExtraGetUnit
214  (void* SIDXdevice, int setting, wchar_t* unit, size_t length);
225 __declspec(dllexport) int SIDXDeviceExtraGetValueLocal
226  (void* SIDXdevice, int setting, wchar_t* description, size_t length);
227 
237 __declspec(dllexport) int SIDXDeviceExtraIntegerGet(void* SIDXdevice, int setting, int& value);
248 __declspec(dllexport) int SIDXDeviceExtraIntegerGetRange
249  (void* SIDXdevice, int setting, int& minimum, int& maximum);
259 __declspec(dllexport) int SIDXDeviceExtraIntegerGetValue
260  (void* SIDXdevice, int setting, int& value);
270 __declspec(dllexport) int SIDXDeviceExtraIntegerSet(void* SIDXdevice, int setting, int value);
271 
281 __declspec(dllexport) int SIDXDeviceExtraIsSettable(void* SIDXdevice, int setting, bool& settable);
282 
293 __declspec(dllexport) int SIDXDeviceExtraListGet(void* SIDXdevice, int setting, int& index);
305 __declspec(dllexport) int SIDXDeviceExtraListGetCount
306  (void* SIDXdevice, int setting, int& count);
318 __declspec(dllexport) int SIDXDeviceExtraListGetEntry
319  (void* SIDXdevice, int setting, int index, double& entry);
333 __declspec(dllexport) int SIDXDeviceExtraListGetLocal
334  (void* SIDXdevice, int setting, int index, wchar_t* description, size_t length);
347 __declspec(dllexport) int SIDXDeviceExtraListGetValue(void* SIDXdevice, int setting, double& value);
358 __declspec(dllexport) int SIDXDeviceExtraListSet(void* SIDXdevice, int setting, int index);
369 __declspec(dllexport) int SIDXDeviceExtraListSetValue(void* SIDXdevice, int setting, double value);
370 
380 __declspec(dllexport) int SIDXDeviceExtraRealGet(void* SIDXdevice, int setting, double& value);
391 __declspec(dllexport) int SIDXDeviceExtraRealGetRange
392  (void* SIDXdevice, int setting, double& minimum, double& maximum);
403 __declspec(dllexport) int SIDXDeviceExtraRealGetValue(void* SIDXdevice, int setting, double& value);
413 __declspec(dllexport) int SIDXDeviceExtraRealSet(void* SIDXdevice, int setting, double value);
414 
427 __declspec(dllexport) int SIDXDeviceExtraSequenceGet(
428  void* SIDXdevice,
429  int setting,
430  int* value,
431  size_t length,
432  size_t& return_length
433 );
444 __declspec(dllexport) int SIDXDeviceExtraSequenceGetSize(void* SIDXdevice, int setting, int& size);
456 __declspec(dllexport) int SIDXDeviceExtraSequenceSet
457  (void* SIDXdevice, int setting, const int* value, size_t length);
458 
470 __declspec(dllexport) int SIDXDeviceExtraStringGet
471  (void* SIDXdevice, int setting, wchar_t* value, size_t length);
481 __declspec(dllexport) int SIDXDeviceExtraStringSet
482  (void* SIDXdevice, int setting, const wchar_t* value);
483 
494 __declspec(dllexport) int SIDXDeviceGetDescription(void* SIDXdevice, wchar_t* description, size_t length);
504 __declspec(dllexport) int SIDXDeviceGetLabel(void* SIDXdevice, wchar_t* label, size_t length);
514 __declspec(dllexport) int SIDXDeviceGetName(void* SIDXdevice, wchar_t* name, size_t length);
515 
525 __declspec(dllexport) int SIDXDevicePortAnalogGetRange(void* SIDXdevice, int port, double& minimum, double& maximum);
534 __declspec(dllexport) int SIDXDevicePortAnalogRead(void* SIDXdevice, int port, double& voltage);
543 __declspec(dllexport) int SIDXDevicePortAnalogWrite(void* SIDXdevice, int port, double voltage);
553 __declspec(dllexport) int SIDXDevicePortBitRead(void* SIDXdevice, int port, bool& asserted);
564 __declspec(dllexport) int SIDXDevicePortBitWrite(void* SIDXdevice, int port, bool asserted);
573 __declspec(dllexport) int SIDXDevicePortDigitalRead(void* SIDXdevice, int port, int& value);
582 __declspec(dllexport) int SIDXDevicePortDigitalWrite(void* SIDXdevice, int port, int value);
590 __declspec(dllexport) int SIDXDevicePortGetCount(void* SIDXdevice, int& count);
600 __declspec(dllexport) int SIDXDevicePortGetType(void* SIDXdevice, int port, SIDXPortType& type);
601 
609 __declspec(dllexport) void SIDXDeviceGetLastError
610  (void* SIDXdevice, wchar_t* message, size_t length);
611 
612 #endif
int SIDXDeviceExtraBooleanSet(void *SIDXdevice, int setting, bool value)
Set the device-specific setting to the specified boolean value.
int SIDXDeviceExtraStringSet(void *SIDXdevice, int setting, const wchar_t *value)
Set the device-specific setting to the specified text string value.
int SIDXDevicePortGetCount(void *SIDXdevice, int &count)
Obtains the I/O port count.
int SIDXDeviceExtraGetType(void *SIDXdevice, int setting, SIDXSettingType &type)
Obtain the type of a device-specific setting.
int SIDXDeviceGetName(void *SIDXdevice, wchar_t *name, size_t length)
Obtain the name of the device.
SIDXSettingType
A value of this type represents a setting type.
Definition: SIDXCConstants.h:48
int SIDXDeviceExtraSequenceGetSize(void *SIDXdevice, int setting, int &size)
Obtain the array size for a device-specific setting.
int SIDXDeviceExtraIntegerSet(void *SIDXdevice, int setting, int value)
Set the device-specific setting to the specified integer value.
File containing SIDX constants for reference.
int SIDXDeviceExtraRealGetRange(void *SIDXdevice, int setting, double &minimum, double &maximum)
Obtain the minimum and maximum value for a device-specific setting.
int SIDXDeviceExtraListGetCount(void *SIDXdevice, int setting, int &count)
Obtain the count of available values for a given device-specific setting.
int SIDXDeviceExtraIntegerGetValue(void *SIDXdevice, int setting, int &value)
Obtain the value used by the camera for a device-specific setting.
int SIDXDeviceExtraRealGetValue(void *SIDXdevice, int setting, double &value)
Obtain the value used by the device for a device-specific setting.
int SIDXDeviceExtraIntegerGet(void *SIDXdevice, int setting, int &value)
Obtain the value of a device-specific setting.
int SIDXDeviceExtraListGetEntry(void *SIDXdevice, int setting, int index, double &entry)
Obtain the value associated with a specific device-specific setting index.
int SIDXDeviceExtraSequenceSet(void *SIDXdevice, int setting, const int *value, size_t length)
Set the device-specific setting to the specified array of integer value.
int SIDXDeviceExtraIntegerGetRange(void *SIDXdevice, int setting, int &minimum, int &maximum)
Obtain the minimum and maximum value for a device-specific setting.
void SIDXDeviceGetLastError(void *SIDXdevice, wchar_t *message, size_t length)
The function translates the error code into a text string.
int SIDXDeviceExtraGetLabel(void *SIDXdevice, int setting, wchar_t *label, size_t length)
Obtain a label for the device-specific setting as a text string.
int SIDXDeviceGetLabel(void *SIDXdevice, wchar_t *label, size_t length)
Obtain a human readable label representing the device.
int SIDXDeviceGetDescription(void *SIDXdevice, wchar_t *description, size_t length)
Obtain a description of the device.
int SIDXDeviceActionGetByItem(void *SIDXdevice, int index, int &setting)
Obtain a handle for a device-specific action, based on the index of the action.
int SIDXDeviceExtraListGetValue(void *SIDXdevice, int setting, double &value)
Obtain the value of a device-specific setting.
int SIDXDeviceExtraListGetLocal(void *SIDXdevice, int setting, int index, wchar_t *description, size_t length)
Obtain a description of a specific entry for a device-specific setting.
int SIDXDeviceExtraListSetValue(void *SIDXdevice, int setting, double value)
Set the device-specific setting to the specified real (floating-point) value.
int SIDXDeviceExtraGetName(void *SIDXdevice, int item, wchar_t *name, size_t length)
Obtain the name of a device-specific setting, based on the item of the setting.
int SIDXDeviceExtraListGet(void *SIDXdevice, int setting, int &index)
Obtain the current index value of the device-specific setting.
int SIDXDeviceExtraGetValueLocal(void *SIDXdevice, int setting, wchar_t *description, size_t length)
Obtain the current value of a device-specific setting as a text string.
int SIDXDeviceActionGetName(void *SIDXdevice, int index, wchar_t *name, size_t length)
Obtain the name of a device-specific action, based on the index of the action.
int SIDXDeviceDriverGetType(void *SIDXdevice, SIDXDriverType &type)
Obtain the device vendor and device driver.
int SIDXDevicePortBitRead(void *SIDXdevice, int port, bool &asserted)
Gets the status of the digital input bit specified by the index parameter, as retrieved by the most r...
int SIDXDeviceExtraSequenceGet(void *SIDXdevice, int setting, int *value, size_t length, size_t &return_length)
Obtain the value of a device-specific setting.
int SIDXDeviceExtraGetByItem(void *SIDXdevice, int item, int &setting)
Obtain a handle for a device-specific setting, based on the item of the setting.
int SIDXDeviceActionDo(void *SIDXdevice, int setting, const wchar_t *command)
Perform a device-specific action.
int SIDXDevicePortDigitalRead(void *SIDXdevice, int port, int &value)
Gets the digital input value.
SIDXPortType
A value of this type represents a device port.
Definition: SIDXCConstants.h:128
int SIDXDeviceExtraStringGet(void *SIDXdevice, int setting, wchar_t *value, size_t length)
Obtain the value of a device-specific setting.
int SIDXDeviceExtraRealSet(void *SIDXdevice, int setting, double value)
Set the device-specific setting to the specified real value.
int SIDXDevicePortAnalogGetRange(void *SIDXdevice, int port, double &minimum, double &maximum)
Obtain the minimum and maximum analogue output voltage values.
int SIDXDeviceExtraRealGet(void *SIDXdevice, int setting, double &value)
Obtain the value of a device-specific setting.
int SIDXDevicePortDigitalWrite(void *SIDXdevice, int port, int value)
Sets the digital output bits to the values specified by the data parameter.
int SIDXDeviceActionGetByName(void *SIDXdevice, const wchar_t *name, int &setting)
Obtain a handle for a device-specific action, based on the name of the action.
int SIDXDeviceActionGetCount(void *SIDXdevice, int &count)
Obtain the total count of device-specific actions.
int SIDXDeviceExtraGetCount(void *SIDXdevice, int &count)
Obtain the total count of device-specific settings.
int SIDXDevicePortAnalogWrite(void *SIDXdevice, int port, double voltage)
Sets the voltage as a fraction of maximum possible on the specified port.
int SIDXDevicePortGetType(void *SIDXdevice, int port, SIDXPortType &type)
Obtains the available port type for a given port index.
int SIDXDeviceExtraGetUnit(void *SIDXdevice, int setting, wchar_t *unit, size_t length)
Obtain the unit for the device-specific setting as a text string.
int SIDXDeviceExtraBooleanGet(void *SIDXdevice, int setting, bool &value)
Obtain the value of a device-specific setting.
int SIDXDevicePortAnalogRead(void *SIDXdevice, int port, double &voltage)
Obtains the voltage on the specified port.
int SIDXDeviceDriverGetName(void *SIDXdevice, wchar_t *name, size_t length)
Obtain the driver name.
int SIDXDeviceExtraListSet(void *SIDXdevice, int setting, int index)
Set the device-specific setting to the specified list index.
int SIDXDeviceDriverGetDescription(void *SIDXdevice, wchar_t *description, size_t length)
Obtain the driver description.
SIDXDriverType
A value of this type represents a camera driver.
Definition: SIDXCConstants.h:31
int SIDXDevicePortBitWrite(void *SIDXdevice, int port, bool asserted)
Sets the digital output bit specified by the index parameter to the value specified by the asserted p...
int SIDXDeviceExtraGetByName(void *SIDXdevice, const wchar_t *name, int &setting)
Obtain a handle for a device-specific setting, based on the name of the setting.
int SIDXDeviceExtraIsSettable(void *SIDXdevice, int setting, bool &settable)
Determine is the camera specific setting can be set, based on the returned setting handle...