tUSBDAudioDevice Struct Reference

#include <usbdaudio.h>

Collaboration diagram for tUSBDAudioDevice:

Data Fields
const uint16_t	ui16VID
	The vendor ID that this device is to present in the device descriptor. More...
const uint16_t	ui16PID
	The product ID that this device is to present in the device descriptor. More...
const char	pcVendor [8]
	8 byte vendor string. More...
const char	pcProduct [16]
	16 byte vendor string. More...
const char	pcVersion [4]
	4 byte vendor string. More...
const uint16_t	ui16MaxPowermA
	The maximum power consumption of the device, expressed in mA. More...
const uint8_t	ui8PwrAttributes
const tUSBCallback	pfnCallback
const uint8_t *const *	ppui8StringDescriptors
const uint32_t	ui32NumStringDescriptors
const int16_t	i16VolumeMax
	The maximum volume expressed as an 8.8 signed value. More...
const int16_t	i16VolumeMin
	The minimum volume expressed as an 8.8 signed value. More...
const int16_t	i16VolumeStep
	The minimum volume step expressed as an 8.8 signed value. More...
tAudioInstance	sPrivateData
	The private instance data for the audio device. More...

Detailed Description

The structure used by the application to define operating parameters for the device audio class.

Field Documentation

ui16VID

const uint16_t tUSBDAudioDevice::ui16VID

The vendor ID that this device is to present in the device descriptor.

ui16PID

const uint16_t tUSBDAudioDevice::ui16PID

The product ID that this device is to present in the device descriptor.

pcVendor

const char tUSBDAudioDevice::pcVendor[8]

8 byte vendor string.

pcProduct

const char tUSBDAudioDevice::pcProduct[16]

16 byte vendor string.

pcVersion

const char tUSBDAudioDevice::pcVersion[4]

4 byte vendor string.

ui16MaxPowermA

const uint16_t tUSBDAudioDevice::ui16MaxPowermA

The maximum power consumption of the device, expressed in mA.

ui8PwrAttributes

const uint8_t tUSBDAudioDevice::ui8PwrAttributes

Indicates whether the device is self or bus-powered and whether or not it supports remote wake up. Valid values are USB_CONF_ATTR_SELF_PWR or USB_CONF_ATTR_BUS_PWR, optionally ORed with USB_CONF_ATTR_RWAKE.

pfnCallback

const tUSBCallback tUSBDAudioDevice::pfnCallback

A pointer to the callback function which will be called to notify the application of events relating to the operation of the audio device.

ppui8StringDescriptors

const uint8_t* const* tUSBDAudioDevice::ppui8StringDescriptors

A pointer to the string descriptor array for this device. This array must contain the following string descriptor pointers in this order. Language descriptor, Manufacturer name string (language 1), Product name string (language 1), Serial number string (language 1), Audio Interface description string (language 1), Configuration description string (language 1).

If supporting more than 1 language, the descriptor block (except for string descriptor 0) must be repeated for each language defined in the language descriptor.

Referenced by USBDAudioCompositeInit(), and USBDAudioInit().

ui32NumStringDescriptors

const uint32_t tUSBDAudioDevice::ui32NumStringDescriptors

The number of descriptors provided in the ppStringDescriptors array. This must be 1 + ((5 + (number of strings)) * (number of languages)).

i16VolumeMax

const int16_t tUSBDAudioDevice::i16VolumeMax

The maximum volume expressed as an 8.8 signed value.

i16VolumeMin

const int16_t tUSBDAudioDevice::i16VolumeMin

The minimum volume expressed as an 8.8 signed value.

i16VolumeStep

const int16_t tUSBDAudioDevice::i16VolumeStep

The minimum volume step expressed as an 8.8 signed value.

sPrivateData

tAudioInstance tUSBDAudioDevice::sPrivateData

The private instance data for the audio device.

Referenced by USBAudioBufferOut(), and USBDAudioCompositeInit().

---

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

• usbdaudio.h