Struct UsbMidiClass 

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

Packet-level implementation of a USB MIDI device.

Implementations

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

pub fn new( alloc: &UsbBusAllocator<B>, n_in_jacks: u8, n_out_jacks: u8, ) -> Result<UsbMidiClass<'_, B>, InvalidArguments>

Creates a new UsbMidiClass with the provided UsbBus and n_in/out_jacks embedded input/output jacks (or “cables”, depending on the terminology). Note that a maximum of 16 in and 16 out jacks is supported.

pub fn send_bytes(&mut self, buffer: [u8; 4]) -> Result<usize>

Sends bytes from a 4-byte buffer and returns either the transferred size or an error.

pub fn send_packet(&mut self, usb_midi: UsbMidiEventPacket) -> Result<usize>

Sends a UsbMidiEventPacket and returns either the transferred size or an error.

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

Reads received bytes into a buffer and returns either the transferred size or an error.

Trait Implementations

impl<B: UsbBus> UsbClass<B> for UsbMidiClass<'_, 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 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 control_out(&mut self, xfer: ControlOut<'_, '_, '_, B>)

Called when a control request is received with direction HostToDevice.

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

Called when a control request is received with direction DeviceToHost.

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.