Zephyr API Documentation 4.0.0-rc3
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
usb_audio_ops Struct Reference

Audio callbacks used to interact with audio devices by user App. More...

#include <usb_audio.h>

Data Fields

usb_audio_data_request_cb_t data_request_cb
 Callback called when data could be send.
 
usb_audio_data_completion_cb_t data_written_cb
 Callback called when data were successfully written with sending capable device.
 
usb_audio_data_completion_cb_t data_received_cb
 Callback called when data were successfully received by receive capable device.
 
usb_audio_feature_updated_cb_t feature_update_cb
 Callback called when features were modified by the Host.
 

Detailed Description

Audio callbacks used to interact with audio devices by user App.

usb_audio_ops structure contains all relevant callbacks to interact with USB Audio devices. Each of this callbacks is optional and may be left NULL. This will not break the stack but could make USB Audio device useless. Depending on the device some of those callbacks are necessary to make USB device work as expected sending/receiving data. For more information refer to callback documentation above.

Field Documentation

◆ data_received_cb

usb_audio_data_completion_cb_t usb_audio_ops::data_received_cb

Callback called when data were successfully received by receive capable device.

Applicable for headset and headphones. Unused for microphone.

◆ data_request_cb

usb_audio_data_request_cb_t usb_audio_ops::data_request_cb

Callback called when data could be send.

◆ data_written_cb

usb_audio_data_completion_cb_t usb_audio_ops::data_written_cb

Callback called when data were successfully written with sending capable device.

Applicable for headset and microphone. Unused for headphones.

◆ feature_update_cb

usb_audio_feature_updated_cb_t usb_audio_ops::feature_update_cb

Callback called when features were modified by the Host.


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