DeviceChannel Class

Namespace: id3.Devices

Definition

Virtual class representing a channel of a device, facilitating the handling of device events, execution of commands, and management of device parameters and filters.

Python

class DeviceChannel

Dart

class DeviceChannel implements Finalizable

C#

public partial class DeviceChannel

Java

public class DeviceChannel implements AutoCloseable, Serializable

C

typedef struct id3DevicesDeviceChannel *ID3_DEVICES_DEVICE_CHANNEL;

Usage

Python

deviceChannelInstance = DeviceChannel()
# ...

Explicit destruction

# ...
del deviceChannelInstance

Dart

final deviceChannelInstance = sdk.DeviceChannel();
// ...

Explicit destruction

// ...
deviceChannelInstance.dispose()

C#

using (var deviceChannelInstance = new DeviceChannel())
{
   // ...
}

Explicit destruction

var deviceChannelInstance = new DeviceChannel()
// ...
deviceChannelInstance.Dispose()

Java

try (DeviceChannel deviceChannelInstance = new DeviceChannel()) {
// ...
}

Explicit destruction

DeviceChannel deviceChannelInstance = new DeviceChannel();
// ...
deviceChannelInstance.close();

C

ID3_DEVICES_DEVICE_CHANNEL hDeviceChannel{};
int err = id3DevicesDeviceChannel_Initialize(&hDeviceChannel);
if (err == ID3_SUCCESS) {
    // ...
    id3DevicesDeviceChannel_Dispose(&hDeviceChannel);
}

Properties

Name	Type	Description
deviceAddedCallback	PlugAndPlayCallback	Callback invoked when a device is added to the channel.
deviceClosedCallback	DeviceSelectedCallback	Callback function for when a device is closed on this channel.
deviceEventCallback	DeviceEventCallback	(C++): Callback for generic device events.
deviceFilterList	DeviceTypeList	A list filtering the types of devices this channel will interact with.
deviceId	int	Identifier for the device associated with this channel, intended for internal or plugin use.
deviceInfo	DeviceInfo	Fetches the device object.
deviceOpenedCallback	DeviceSelectedCallback	Callback that is called when a device is opened on this channel.
deviceRemovedCallback	PlugAndPlayCallback	Callback function triggered upon the removal of a device from the channel.
deviceState	DeviceState	Reflects the current state of the device, such as connected, disconnected, etc.
parameterCategoryList	StringList	Lists categories of parameters relevant to the device.

Methods

Name	Description
addDeviceFilter	Adds a filter to specify the types of devices this channel should handle.
applyParameters	Applies a set of parameters to the device.
checkCommand	(C++/dotnet): Checks if a specific command is available on the device.
checkParameter	Confirms if a parameter exists on the device.
clearDeviceFilter	Clears all set device filters, removing any type restrictions.
closeDevice	Controls closing the associated device.
getParameter	Retrieves a device parameter’s value.
getParameterDescriptor	Fetches the descriptor of a device parameter.
getParameterList	Obtains all supported parameters, optionally filtered by category.
getParameterNameList	Retrieves names of all supported parameters, optionally filtered by category.
getParameterValueInt	Gets the integer value of a device parameter.
isPreviouslyDisconnectedDevice	Checks if the specified device was previously disconnected.
openDevice	Controls opening the associated device.
sendCommand	(C++/dotnet): Issues a command to the device.
sendCommandBoolean	(C++/dotnet): Issues a command with a boolean as result to the device.
sendModelCommand	(C++/dotnet): Dispatches a command to the device model.
setParameter	Sets a device parameter’s value.
setParameterValueInt	Assigns an integer value to a device parameter.