Interface IUsbInterface

Inherited Members

System.IDisposable.Dispose()

Namespace: Usb.Net

Assembly: Usb.Net.dll

Syntax

public interface IUsbInterface : IDisposable

Properties

InterfaceNumber

Declaration

byte InterfaceNumber { get; }

Property Value

Type	Description
System.Byte

InterruptReadEndpoint

Declaration

IUsbInterfaceEndpoint InterruptReadEndpoint { get; set; }

Property Value

Type	Description
IUsbInterfaceEndpoint

InterruptWriteEndpoint

Declaration

IUsbInterfaceEndpoint InterruptWriteEndpoint { get; set; }

Property Value

Type	Description
IUsbInterfaceEndpoint

ReadBufferSize

Declaration

ushort ReadBufferSize { get; }

Property Value

Type	Description
System.UInt16

ReadEndpoint

Declaration

IUsbInterfaceEndpoint ReadEndpoint { get; set; }

Property Value

Type	Description
IUsbInterfaceEndpoint

UsbInterfaceEndpoints

Declaration

IList<IUsbInterfaceEndpoint> UsbInterfaceEndpoints { get; }

Property Value

Type	Description
System.Collections.Generic.IList<IUsbInterfaceEndpoint>

WriteBufferSize

Declaration

ushort WriteBufferSize { get; }

Property Value

Type	Description
System.UInt16

WriteEndpoint

Declaration

IUsbInterfaceEndpoint WriteEndpoint { get; set; }

Property Value

Type	Description
IUsbInterfaceEndpoint

Methods

ClaimInterface()

Declaration

Task ClaimInterface()

Returns

Type	Description
System.Threading.Tasks.Task

PerformControlTransferAsync(SetupPacket, Byte[], CancellationToken)

Performs a USB Control Transfer https://docs.microsoft.com/en-us/windows-hardware/drivers/usbcon/usb-control-transfer https://docs.microsoft.com/en-us/windows-hardware/drivers/usbcon/how-to-send-a-usb-control-transfer--uwp-app-

Declaration

Task<TransferResult> PerformControlTransferAsync(SetupPacket setupPacket, byte[] buffer = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
SetupPacket	setupPacket
System.Byte[]	buffer
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<TransferResult>

ReadAsync(UInt32, CancellationToken)

Declaration

Task<TransferResult> ReadAsync(uint bufferLength, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.UInt32	bufferLength
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<TransferResult>

RegisterDefaultEndpoints()

This is for internal use and should need to be called. This will probably be removed in future versions. TODO

Declaration

void RegisterDefaultEndpoints()

WriteAsync(Byte[], CancellationToken)

Declaration

Task<uint> WriteAsync(byte[] data, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.Byte[]	data
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<System.UInt32>