Class Interface
Represents a device interface.
Inherited Members
Namespace: ic4
Assembly: ic4dotnet.dll
Syntax
public class Interface : HandleObject, IDisposable, IEquatable<Interface>Remarks
Interfaces represent physical connections for cameras to the computer, e.g. network adapters or USB controllers.
Interface objects are created by the library in multiple ways:
- When enumerating the available interfaces using Interfaces.
- When querying a DeviceInfo object for the interface the device is attached to using Interface.
Properties
Devices
Enumerates the devices currently attached to this interface.
Declaration
public IReadOnlyList<DeviceInfo> Devices { get; }Property Value
| Type | Description |
|---|---|
| IReadOnlyList<DeviceInfo> | A list of DeviceInfo objects representing the devices attached to this interface. |
Exceptions
| Type | Condition |
|---|---|
| IC4Exception | Check ErrorCode and ToString() for details. |
DisplayName
The name of the device interface
Declaration
public string DisplayName { get; }Property Value
| Type | Description |
|---|---|
| string | The name of the device interface |
PropertyMap
Opens the property map for the interface.
Declaration
public PropertyMap PropertyMap { get; }Property Value
| Type | Description |
|---|---|
| PropertyMap |
Remarks
The property map can be used to query advanced interface information or configure the interface and its attached devices.
Exceptions
| Type | Condition |
|---|---|
| IC4Exception | Check ErrorCode and ToString() for details. |
TransportLayerName
The name of the transport layer that provides this interface object
Declaration
public string TransportLayerName { get; }Property Value
| Type | Description |
|---|---|
| string | The name of the transport layer that provides this interface object |
Remarks
This string can be interpreted as a name for the driver providing access to devices on the interface.
Exceptions
| Type | Condition |
|---|---|
| IC4Exception | Check ErrorCode and ToString() for details. |
TransportLayerType
The type of the transport layer used by this interface
Declaration
public TransportLayerType TransportLayerType { get; }Property Value
| Type | Description |
|---|---|
| TransportLayerType | The transport layer type of this interface |
TransportLayerVersion
The version of the transport layer that provides this interface object.
Declaration
public string TransportLayerVersion { get; }Property Value
| Type | Description |
|---|---|
| string | The version of the transport layer that provides this interface object. |
Remarks
This string can be interpreted as driver version for the driver providing access devices on the interface.
Exceptions
| Type | Condition |
|---|---|
| IC4Exception | Check ErrorCode and ToString() for details. |
Methods
Equals(object)
Checks whether two interface objects refer to the same interface.
Declaration
public override bool Equals(object obj)Parameters
| Type | Name | Description |
|---|---|---|
| object | obj | A second interface object |
Returns
| Type | Description |
|---|---|
| bool |
|
Overrides
Equals(Interface)
Checks whether two interface objects refer to the same interface.
Declaration
public bool Equals(Interface other)Parameters
| Type | Name | Description |
|---|---|---|
| Interface | other | A second interface object |
Returns
| Type | Description |
|---|---|
| bool |
|