Skip to main content

Interface Class

Package: GHIElectronics.Endpoint.Devices.UsbHost
Namespace: GHIElectronics.Endpoint.Devices.UsbHost.Descriptors

Interface descriptor.

class Interface : public BaseDescriptor {};

Constructors​

Interface(byte[] buffer)​

Interface(const std::vector<uint8_t>& buffer);

Constructs a new descriptor.

ParameterTypeDescription
bufferbyte[]The buffer with which to populate the descriptor.

Interface(byte[] buffer, int offset)​

Interface(const std::vector<uint8_t>& buffer, int32_t offset);

Constructs a new descriptor.

ParameterTypeDescription
bufferbyte[]The buffer with which to populate the descriptor.
offsetintThe offset into the buffer at which to start.

Interface()​

Interface();

Constructs a new descriptor.

Properties​

AlternateSetting​

uint8_t AlternateSetting() const;
void AlternateSetting(uint8_t value);

The value used to select alternate settings.

Returns byte

AuxiliaryDescriptors​

std::vector<Auxiliary> AuxiliaryDescriptors() const;
void AuxiliaryDescriptors(std::vector<Auxiliary> value);

Child auxiliary descriptors.

Returns Auxiliary[]

ClassCode​

uint8_t ClassCode() const;
void ClassCode(uint8_t value);

The class code.

Returns byte

Endpoints​

std::vector<Endpoint> Endpoints() const;
void Endpoints(std::vector<Endpoint> value);

Child endpoint descriptors.

Returns Endpoint[]

Index​

uint8_t Index() const;
void Index(uint8_t value);

The interface string descriptor index.

Returns byte

Number​

uint8_t Number() const;
void Number(uint8_t value);

The number of the interface.

Returns byte

NumberEndpoints​

uint8_t NumberEndpoints() const;
void NumberEndpoints(uint8_t value);

The number of endpoints for this interface.

Returns byte

ProtocolCode​

uint8_t ProtocolCode() const;
void ProtocolCode(uint8_t value);

The protocal code.

Returns byte

SubclassCode​

uint8_t SubclassCode() const;
void SubclassCode(uint8_t value);

The subclass code.

Returns byte

Fields​

FixedLength​

static constexpr uint8_t FixedLength = 9;

The fixed length of this descriptor type in bytes.