Struct AudioClass

pub struct AudioClass<'a, B: UsbBus> { /* private fields */ }

USB device class for audio devices.

This device class based on the “Universal Serial Bus Device Class Definition for Audio Devices”, Release 1.0. It supports one input stream and/or one output stream.

Implementations

impl<B: UsbBus> AudioClass<'_, B>

pub fn read(&self, data: &mut [u8]) -> Result<usize, Error>

Read audio frames as output by the host. Returns an Error if no output stream has been configured.

pub fn write(&self, data: &[u8]) -> Result<usize, Error>

Write audio frames to be input by the host. Returns an Error when no input stream has been configured.

pub fn input_alt_setting(&self) -> Result<u8, Error>

Get current Alternate Setting of the input stream. Returns an error if the stream is not configured.

pub fn output_alt_setting(&self) -> Result<u8, Error>

Get current Alternate Setting of the output stream. Returns an error if the stream is not configured.

Trait Implementations

impl<B: UsbBus> UsbClass<B> for AudioClass<'_, B>

fn get_configuration_descriptors( &self, writer: &mut DescriptorWriter<'_>, ) -> Result<()>

Called when a GET_DESCRIPTOR request is received for a configuration descriptor. When called, the implementation should write its interface, endpoint and any extra class descriptors into writer. The configuration descriptor itself will be written by UsbDevice and shouldn’t be written by classes.

fn control_in(&mut self, xfer: ControlIn<'_, '_, '_, B>)

Called when a control request is received with direction DeviceToHost.

fn control_out(&mut self, xfer: ControlOut<'_, '_, '_, B>)

Called when a control request is received with direction HostToDevice.

fn get_bos_descriptors( &self, writer: &mut BosWriter<'_, '_>, ) -> Result<(), UsbError>

Called when a GET_DESCRIPTOR request is received for a BOS descriptor. When called, the implementation should write its blobs such as capability descriptors into writer. The BOS descriptor itself will be written by UsbDevice and shouldn’t be written by classes.

fn get_string(&self, index: StringIndex, lang_id: LangID) -> Option<&str>

Gets a class-specific string descriptor.

fn reset(&mut self)

Called after a USB reset after the bus reset sequence is complete.

fn poll(&mut self)

Called whenever the UsbDevice is polled.

fn endpoint_setup(&mut self, addr: EndpointAddress)

Called when endpoint with address addr has received a SETUP packet. Implementing this shouldn’t be necessary in most cases, but is provided for completeness’ sake.

fn endpoint_out(&mut self, addr: EndpointAddress)

Called when endpoint with address addr has received data (OUT packet).

fn endpoint_in_complete(&mut self, addr: EndpointAddress)

Called when endpoint with address addr has completed transmitting data (IN packet).

fn get_alt_setting(&mut self, interface: InterfaceNumber) -> Option<u8>

Called when the interfaces alternate setting state is requested.

fn set_alt_setting( &mut self, interface: InterfaceNumber, alternative: u8, ) -> bool

Called when the interfaces alternate setting state is altered.