nRF52840 only: Module with types, definitions, and API used by USB Audio class.
More...
nRF52840 only: Module with types, definitions, and API used by USB Audio class.
Reference specifications:
- "Universal Serial Bus Device Class Definition for Audio Devices" Release 1.0, March 18, 1998.
- "Universal Serial Bus Device Class Definition for Audio Data Formats" Release 1.0, March 18, 1998.
- "Universal Serial Bus Device Class Definition for Terminal Types" Release 1.0, March 18, 1998.
#define APP_USBD_AUDIO_GLOBAL_DEF |
( |
|
instance_name, |
|
|
|
interfaces_configs, |
|
|
|
user_ev_handler, |
|
|
|
raw_descriptors |
|
) |
| |
Value:
interfaces_configs, \
user_ev_handler, \
raw_descriptors)
Global definition of app_usbd_audio_t class instance.
- Parameters
-
instance_name | Name of global instance |
interfaces_configs | Interfaces configurations |
user_ev_handler | User event handler (optional) |
raw_descriptors | Raw descriptor table |
- Note
- This macro is just simplified version of APP_USBD_AUDIO_GLOBAL_DEF_INTERNAL
Events passed to user event handler.
- Note
- Example prototype of user event handler:
Events passed to user event handler.
- Note
- Example prototype of user event handler:
Enumerator |
---|
APP_USBD_AUDIO_USER_EVT_SUSPEND |
User event SUSPEND
|
APP_USBD_AUDIO_USER_EVT_RESUME |
User event RESUME
|
APP_USBD_AUDIO_USER_EVT_START |
User event START
|
APP_USBD_AUDIO_USER_EVT_STOP |
User event STOP
|
APP_USBD_AUDIO_USER_EVT_CLASS_REQ |
User event CLASS_REQ
|
APP_USBD_AUDIO_USER_EVT_RX_DONE |
User event RX_DONE
|
APP_USBD_AUDIO_USER_EVT_TX_DONE |
User event TX_DONE
|
Helper function to get audio from base class instance.
- Parameters
-
[in] | p_inst | Base class instance |
- Returns
- Audio class handle
@brief Helper function to get class instance from Audio class
- Parameters
-
- Returns
- Base class instance
Helper function to get audio specific request from audio class.
- Parameters
-
- Returns
- Audio class specific request
void app_usbd_audio_class_rx_buf_set |
( |
app_usbd_class_inst_t const * |
p_inst, |
|
|
void * |
p_buff, |
|
|
size_t |
size |
|
) |
| |
Set receive buffer.
- Parameters
-
[in] | p_inst | Base class instance |
[in] | p_buff | Receive buffer |
[in] | size | Receive buffer size |
void app_usbd_audio_class_tx_buf_set |
( |
app_usbd_class_inst_t const * |
p_inst, |
|
|
const void * |
p_buff, |
|
|
size_t |
size |
|
) |
| |
Set transmit buffer.
- Parameters
-
[in] | p_inst | Base class instance |
[in] | p_buff | Transmit buffer |
[in] | size | Transmit buffer size |