Class DeviceInfo
Contains information about a video capture device.
Inherited Members
Namespace: ic4
Assembly: ic4dotnet.dll
Syntax
public class DeviceInfo : HandleObject, IDisposable, IEquatable<DeviceInfo>
Remarks
DeviceInfo
objects are created by the library in multiple ways:
- When enumerating the available devices using Devices.
- When enumerating the available devices on a specific interface using Devices.
- By querying a grabber for information about its currently opened video capture using DeviceInfo.
Properties
Interface
The interface this device is attached to.
Declaration
public Interface Interface { get; }
Property Value
Type | Description |
---|---|
Interface | The interface this device is attached to. |
Exceptions
Type | Condition |
---|---|
IC4Exception | Check ErrorCode and ToString() for details. |
ModelName
The model name for this device.
Declaration
public string ModelName { get; }
Property Value
Type | Description |
---|---|
string | The model name for this device. |
Exceptions
Type | Condition |
---|---|
IC4Exception | Check ErrorCode and ToString() for details. |
Serial
The serial of this device.
Declaration
public string Serial { get; }
Property Value
Type | Description |
---|---|
string | The serial of this device. The serial is a string uniquely identifying the device. Usually this is a number that is also printed on the device's housing. |
Exceptions
Type | Condition |
---|---|
IC4Exception | Check ErrorCode and ToString() for details. |
UniqueName
The unique name for this device.
Declaration
public string UniqueName { get; }
Property Value
Type | Description |
---|---|
string | The unique name for this device. The unique name consists of an identifier for the device driver and the device's serial number, allowing devices to be uniquely identified by a single string. |
Exceptions
Type | Condition |
---|---|
IC4Exception | Check ErrorCode and ToString() for details. |
UserID
The user-defined identifier of this device.
Declaration
public string UserID { get; }
Property Value
Type | Description |
---|---|
string | The user-defined identifier of this device.
If supported by the device, the device's user-defined identifier can be configured through the |
Exceptions
Type | Condition |
---|---|
IC4Exception | Check ErrorCode and ToString() for details. |
Version
The version of this device.
Declaration
public string Version { get; }
Property Value
Type | Description |
---|---|
string | The version of this device. The format of the version string is device-specific. |
Exceptions
Type | Condition |
---|---|
IC4Exception | Check ErrorCode and ToString() for details. |
Methods
Equals(object)
Check whether two device information objects refer to the same video capture device.
Declaration
public override bool Equals(object obj)
Parameters
Type | Name | Description |
---|---|---|
object | obj | A second device information object |
Returns
Type | Description |
---|---|
bool |
|
Overrides
Equals(DeviceInfo)
Check whether two device information objects refer to the same video capture device.
Declaration
public bool Equals(DeviceInfo other)
Parameters
Type | Name | Description |
---|---|---|
DeviceInfo | other | A second device information object |
Returns
Type | Description |
---|---|
bool |
|