UsbInterface UsbInterface UsbInterface UsbInterface Class

Definition

public : sealed class UsbInterface : IUsbInterfacepublic sealed class UsbInterface : IUsbInterfacePublic NotInheritable Class UsbInterface Implements IUsbInterface// You can use this class in JavaScript.

Attributes

ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute

Examples

This code example shows how to parse descriptors and get pipe objects. The example assumes that the app has previously obtained the UsbDevice object.

using Windows.Devices.Usb;
using Windows.Storage.Streams;

protected override async void OnLaunched(LaunchActivatedEventArgs args)
{

    UsbDevice device;
    UInt32 readLen = 8;

    // Get the UsbDevice object. Not shown.

    ...

    UsbInterface myInterface = null;

    //
    // Need to find this descriptor after an interface descriptor:
    //
    //   ===>Class-Specific Video Control Interface Header Descriptor<===
    // bLength:   0x0D
    // bDescriptorType:   0x24
    // bDescriptorSubtype:0x01
    // bcdVDC:  0x0100
    // wTotalLength:    0x00D9  -> Validated
    // dwClockFreq: 0x02DC6C00 = (48000000) Hz
    // bInCollection:     0x01
    // baInterfaceNr[1]:  0x01
    // USB Video Class device: spec version 1.0
    //
    foreach (var interf in device.Configuration.UsbInterfaces)
    {
        foreach (var setting in interf.InterfaceSettings)
        {
            var descriptors = setting.Descriptors;

            // First descriptor in the setting must be the interface descriptor
            if (descriptors.Count >= 2 &&
                UsbInterfaceDescriptor.TryParse(descriptors[0], null) == 
                                            true && 
                                            descriptors[1].Length == 0x0D &&
                                            descriptors[1].DescriptorType == 0x24)
            {
                Windows.Storage.Streams.Buffer buffer = new Windows.Storage.Streams.Buffer(readLen);
                descriptors[1].readDescriptorBuffer(buffer);
                Windows.Storage.Streams.DataReader reader = Windows.Storage.Streams.DataReader.FromBuffer(buffer);

                reader.ReadByte(); // bLength
                reader.ReadByte(); // bDescriptorType
                byte bDescriptorSubType = reader.ReadByte();

                if (bDescriptorSubType == 0x01) 
                {
                    // This is our interface.
                    myInterface = interf;
                    ushort bcdVDC = reader.ReadUInt16();
                    ushort wTotalLength = reader.ReadUInt16();
                    byte lsb = reader.ReadByte();
                    uint dwClockFreq = (reader.ReadUInt16() << 8) + lsb;
                    byte bInCollection = reader.ReadByte();
                    byte baInterfaceNr1 = reader.ReadByte();

                    await setting.SelectSettingAsync();
                }
                break;
            }
        }

        if (myInterface != null)
        {
            break;
        }
    }

    if (myInterface == null)
    {
        ShowError("Video Control Interface descriptor not found");
        return;
    }

    // Pipes are now available to communicate with endpoints

    UsbInterruptInPipe interruptIn = myInterface.InterruptInPipes[0];
    UsbBulkOutPipe bulkOut = myInterface.BulkOutPipes[0];

}

public : IVectorView<UsbBulkInPipe> BulkInPipes { get; }public IReadOnlyList<UsbBulkInPipe> BulkInPipes { get; }Public ReadOnly Property BulkInPipes As IReadOnlyList<UsbBulkInPipe>// You can use this property in JavaScript.

public : IVectorView<UsbBulkOutPipe> BulkOutPipes { get; }public IReadOnlyList<UsbBulkOutPipe> BulkOutPipes { get; }Public ReadOnly Property BulkOutPipes As IReadOnlyList<UsbBulkOutPipe>// You can use this property in JavaScript.

public : IVectorView<UsbDescriptor> Descriptors { get; }public IReadOnlyList<UsbDescriptor> Descriptors { get; }Public ReadOnly Property Descriptors As IReadOnlyList<UsbDescriptor>// You can use this property in JavaScript.

public : byte InterfaceNumber { get; }public byte InterfaceNumber { get; }Public ReadOnly Property InterfaceNumber As byte// You can use this property in JavaScript.

public : IVectorView<UsbInterfaceSetting> InterfaceSettings { get; }public IReadOnlyList<UsbInterfaceSetting> InterfaceSettings { get; }Public ReadOnly Property InterfaceSettings As IReadOnlyList<UsbInterfaceSetting>// You can use this property in JavaScript.

public : IVectorView<UsbInterruptInPipe> InterruptInPipes { get; }public IReadOnlyList<UsbInterruptInPipe> InterruptInPipes { get; }Public ReadOnly Property InterruptInPipes As IReadOnlyList<UsbInterruptInPipe>// You can use this property in JavaScript.

public : IVectorView<UsbInterruptOutPipe> InterruptOutPipes { get; }public IReadOnlyList<UsbInterruptOutPipe> InterruptOutPipes { get; }Public ReadOnly Property InterruptOutPipes As IReadOnlyList<UsbInterruptOutPipe>// You can use this property in JavaScript.