USB_ClassInfo_Audio_Host_t Struct Reference

Audio Class Host Mode Configuration and State Structure. More...

#include <AudioClassHost.h>

Data Fields
struct {
uint8_t   DataINPipeNumber
uint8_t   DataOUTPipeNumber
}	Config
struct {
bool   IsActive
uint8_t   ControlInterfaceNumber
uint8_t   StreamingInterfaceNumber
uint8_t   EnabledStreamingAltIndex
uint16_t   DataINPipeSize
uint16_t   DataOUTPipeSize
}	State

---

Detailed Description

Class state structure. An instance of this structure should be made within the user application, and passed to each of the Audio class driver functions as the AudioInterfaceInfo parameter. This stores each Audio interface's configuration and state information.

---

Field Documentation

struct { ... } USB_ClassInfo_Audio_Host_t::Config

Config data for the USB class interface within the device. All elements in this section must be set or the interface will fail to enumerate and operate correctly.

uint8_t USB_ClassInfo_Audio_Host_t::ControlInterfaceNumber

Interface index of the Audio Control interface within the attached device.

uint8_t USB_ClassInfo_Audio_Host_t::DataINPipeNumber

Pipe number of the Audio interface's IN data pipe. If this interface should not bind to an IN endpoint, this may be set to 0 to disable audio input streaming for this driver instance.

uint16_t USB_ClassInfo_Audio_Host_t::DataINPipeSize

Size in bytes of the Audio interface's IN data pipe.

uint8_t USB_ClassInfo_Audio_Host_t::DataOUTPipeNumber

Pipe number of the Audio interface's OUT data pipe. If this interface should not bind to an OUT endpoint, this may be set to 0 to disable audio output streaming for this driver instance.

uint16_t USB_ClassInfo_Audio_Host_t::DataOUTPipeSize

Size in bytes of the Audio interface's OUT data pipe.

uint8_t USB_ClassInfo_Audio_Host_t::EnabledStreamingAltIndex

Alternative setting index of the Audio Streaming interface when the stream is enabled.

bool USB_ClassInfo_Audio_Host_t::IsActive

Indicates if the current interface instance is connected to an attached device, valid after Audio_Host_ConfigurePipes() is called and the Host state machine is in the Configured state.

struct { ... } USB_ClassInfo_Audio_Host_t::State

State data for the USB class interface within the device. All elements in this section may be set to initial values, but may also be ignored to default to sane values when the interface is enumerated.

uint8_t USB_ClassInfo_Audio_Host_t::StreamingInterfaceNumber

Interface index of the Audio Streaming interface within the attached device.

---

The documentation for this struct was generated from the following file:

• Drivers/USB/Class/Host/AudioClassHost.h