USB Component  Version 6.13.6
MDK Middleware for USB Device and Host Communication
 All Data Structures Functions Variables Enumerations Enumerator Groups Pages
USBD_ADC: Audio Device Class Functions

Events generated by USB Device - Audio Device Class functions. More...

Functions

__STATIC_INLINE void EvrUSBD_ADC_Initialize (uint8_t instance)
 Event on internal library operation ADC initialize start (Operation) More...
 
__STATIC_INLINE void EvrUSBD_ADC_InitializeFailed (uint8_t instance, usbStatus error)
 Event on internal library operation ADC initialize failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_ADC_Uninitialize (uint8_t instance)
 Event on internal library operation ADC uninitialize start (Operation) More...
 
__STATIC_INLINE void EvrUSBD_ADC_UninitializeFailed (uint8_t instance, usbStatus error)
 Event on internal library operation ADC uninitialize failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_ADC_Reset (uint8_t instance)
 Event on internal library operation ADC reset start (Operation) More...
 
__STATIC_INLINE void EvrUSBD_ADC_ResetFailed (uint8_t instance, usbStatus error)
 Event on internal library operation ADC reset failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_ADC_OnInitialize (uint8_t n)
 Event on USBD_ADCn_Initialize user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBD_ADC_OnUninitialize (uint8_t n)
 Event on USBD_ADCn_Uninitialize user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBD_ADC_OnPlayStart (uint8_t n)
 Event on USBD_ADCn_PlayStart user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBD_ADC_OnPlayStop (uint8_t n)
 Event on USBD_ADCn_PlayStop user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBD_ADC_OnSetSpeakerMute (uint8_t n, uint8_t ch, bool on)
 Event on USBD_ADCn_SetSpeakerMute user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBD_ADC_OnSetSpeakerVolume (uint8_t n, uint8_t ch, uint16_t vol)
 Event on USBD_ADCn_SetSpeakerVolume user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBD_ADC_OnRecordStart (uint8_t n)
 Event on USBD_ADCn_RecordStart user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBD_ADC_OnRecordStop (uint8_t n)
 Event on USBD_ADCn_RecordStop user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBD_ADC_OnSetMicrophoneMute (uint8_t n, uint8_t ch, bool on)
 Event on USBD_ADCn_SetMicrophoneMute user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBD_ADC_OnSetMicrophoneVolume (uint8_t n, uint8_t ch, uint16_t vol)
 Event on USBD_ADCn_SetMicrophoneVolume user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBD_ADC_OnReceivedSamples (uint8_t n)
 Event on USBD_ADCn_ReceivedSamples user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBD_ADC_SetSpeakerVolumeRange (uint8_t instance, uint8_t ch, uint16_t min, uint16_t max, uint16_t res, uint16_t cur)
 Event on USBD_ADC_SetSpeakerVolumeRange finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBD_ADC_SetSpeakerVolumeRangeFailed (uint8_t instance, uint8_t ch, uint16_t min, uint16_t max, uint16_t res, uint16_t cur, usbStatus error)
 Event on USBD_ADC_SetSpeakerVolumeRange failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_ADC_SetMicrophoneVolumeRange (uint8_t instance, uint8_t ch, uint16_t min, uint16_t max, uint16_t res, uint16_t cur)
 Event on USBD_ADC_SetMicrophoneVolumeRange finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBD_ADC_SetMicrophoneVolumeRangeFailed (uint8_t instance, uint8_t ch, uint16_t min, uint16_t max, uint16_t res, uint16_t cur, usbStatus error)
 Event on USBD_ADC_SetMicrophoneVolumeRange failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_ADC_ReceivedSamplesAvailable (uint8_t instance, uint32_t result)
 Event on USBD_ADC_ReceivedSamplesAvailable finished (API) More...
 
__STATIC_INLINE void EvrUSBD_ADC_WrittenSamplesPending (uint8_t instance, uint32_t result)
 Event on USBD_ADC_WrittenSamplesPending finished (API) More...
 
__STATIC_INLINE void EvrUSBD_ADC_ReadSamples (uint8_t instance, int32_t result)
 Event on USBD_ADC_ReadSamples finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBD_ADC_ReadSamplesFailed (uint8_t instance, usbStatus error)
 Event on USBD_ADC_ReadSamples failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_ADC_WriteSamples (uint8_t instance, int32_t result)
 Event on USBD_ADC_WriteSamples finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBD_ADC_WriteSamplesFailed (uint8_t instance, usbStatus error)
 Event on USBD_ADC_WriteSamples failed (Error) More...
 

Description

Events generated by USB Device - Audio Device Class functions.

Function Documentation

__STATIC_INLINE void EvrUSBD_ADC_Initialize ( uint8_t  instance)

Event on internal library operation ADC initialize start (Operation)

Parameters
instanceinstance of ADC class
__STATIC_INLINE void EvrUSBD_ADC_InitializeFailed ( uint8_t  instance,
usbStatus  error 
)

Event on internal library operation ADC initialize failed (Error)

Parameters
instanceinstance of ADC class
errorerror code usbStatus
__STATIC_INLINE void EvrUSBD_ADC_OnInitialize ( uint8_t  n)

Event on USBD_ADCn_Initialize user callback function start (API)

Parameters
ninstance of ADC class
__STATIC_INLINE void EvrUSBD_ADC_OnPlayStart ( uint8_t  n)

Event on USBD_ADCn_PlayStart user callback function start (API)

Parameters
ninstance of ADC class
__STATIC_INLINE void EvrUSBD_ADC_OnPlayStop ( uint8_t  n)

Event on USBD_ADCn_PlayStop user callback function start (API)

Parameters
ninstance of ADC class
__STATIC_INLINE void EvrUSBD_ADC_OnReceivedSamples ( uint8_t  n)

Event on USBD_ADCn_ReceivedSamples user callback function start (API)

Parameters
ninstance of ADC class
__STATIC_INLINE void EvrUSBD_ADC_OnRecordStart ( uint8_t  n)

Event on USBD_ADCn_RecordStart user callback function start (API)

Parameters
ninstance of ADC class
__STATIC_INLINE void EvrUSBD_ADC_OnRecordStop ( uint8_t  n)

Event on USBD_ADCn_RecordStop user callback function start (API)

Parameters
ninstance of ADC class
__STATIC_INLINE void EvrUSBD_ADC_OnSetMicrophoneMute ( uint8_t  n,
uint8_t  ch,
bool  on 
)

Event on USBD_ADCn_SetMicrophoneMute user callback function start (API)

Parameters
ninstance of ADC class
chchannel index
  • value 0: master channel
  • value 1: left microphone (in stereo mode)
  • value 2: right microphone (in stereo mode)
oncurrent mute setting
  • false : mute off
  • true : mute on
__STATIC_INLINE void EvrUSBD_ADC_OnSetMicrophoneVolume ( uint8_t  n,
uint8_t  ch,
uint16_t  vol 
)

Event on USBD_ADCn_SetMicrophoneVolume user callback function start (API)

Parameters
ninstance of ADC class
chchannel index
  • value 0: master channel
  • value 1: left microphone (in stereo mode)
  • value 2: right microphone (in stereo mode)
volcurrent volume setting
__STATIC_INLINE void EvrUSBD_ADC_OnSetSpeakerMute ( uint8_t  n,
uint8_t  ch,
bool  on 
)

Event on USBD_ADCn_SetSpeakerMute user callback function start (API)

Parameters
ninstance of ADC class
chchannel index
  • value 0: master channel
  • value 1: left speaker (in stereo mode)
  • value 2: right speaker (in stereo mode)
oncurrent mute setting
  • false : mute off
  • true : mute on
__STATIC_INLINE void EvrUSBD_ADC_OnSetSpeakerVolume ( uint8_t  n,
uint8_t  ch,
uint16_t  vol 
)

Event on USBD_ADCn_SetSpeakerVolume user callback function start (API)

Parameters
ninstance of ADC class
chchannel index
  • value 0: master channel
  • value 1: left speaker (in stereo mode)
  • value 2: right speaker (in stereo mode)
volcurrent volume setting
__STATIC_INLINE void EvrUSBD_ADC_OnUninitialize ( uint8_t  n)

Event on USBD_ADCn_Uninitialize user callback function start (API)

Parameters
ninstance of ADC class
__STATIC_INLINE void EvrUSBD_ADC_ReadSamples ( uint8_t  instance,
int32_t  result 
)

Event on USBD_ADC_ReadSamples finished successfully (API)

Parameters
instanceinstance of ADC class
resultnumber of samples read
__STATIC_INLINE void EvrUSBD_ADC_ReadSamplesFailed ( uint8_t  instance,
usbStatus  error 
)

Event on USBD_ADC_ReadSamples failed (Error)

Parameters
instanceinstance of ADC class
errorerror code usbStatus
__STATIC_INLINE void EvrUSBD_ADC_ReceivedSamplesAvailable ( uint8_t  instance,
uint32_t  result 
)

Event on USBD_ADC_ReceivedSamplesAvailable finished (API)

Parameters
instanceinstance of ADC class
resultnumber of samples available to be read
__STATIC_INLINE void EvrUSBD_ADC_Reset ( uint8_t  instance)

Event on internal library operation ADC reset start (Operation)

Parameters
instanceinstance of ADC class
__STATIC_INLINE void EvrUSBD_ADC_ResetFailed ( uint8_t  instance,
usbStatus  error 
)

Event on internal library operation ADC reset failed (Error)

Parameters
instanceinstance of ADC class
errorerror code usbStatus
__STATIC_INLINE void EvrUSBD_ADC_SetMicrophoneVolumeRange ( uint8_t  instance,
uint8_t  ch,
uint16_t  min,
uint16_t  max,
uint16_t  res,
uint16_t  cur 
)

Event on USBD_ADC_SetMicrophoneVolumeRange finished successfully (API)

Parameters
instanceinstance of ADC class
chchannel index
  • value 0: master channel
  • value 1: left microphone (in stereo mode)
  • value 2: right microphone (in stereo mode)
minminimum volume value
maxmaximum volume value
resvolume resolution
curcurrent volume value
__STATIC_INLINE void EvrUSBD_ADC_SetMicrophoneVolumeRangeFailed ( uint8_t  instance,
uint8_t  ch,
uint16_t  min,
uint16_t  max,
uint16_t  res,
uint16_t  cur,
usbStatus  error 
)

Event on USBD_ADC_SetMicrophoneVolumeRange failed (Error)

Parameters
instanceinstance of ADC class
chchannel index
  • value 0: master channel
  • value 1: left microphone (in stereo mode)
  • value 2: right microphone (in stereo mode)
minminimum volume value
maxmaximum volume value
resvolume resolution
curcurrent volume value
errorerror code usbStatus
__STATIC_INLINE void EvrUSBD_ADC_SetSpeakerVolumeRange ( uint8_t  instance,
uint8_t  ch,
uint16_t  min,
uint16_t  max,
uint16_t  res,
uint16_t  cur 
)

Event on USBD_ADC_SetSpeakerVolumeRange finished successfully (API)

Parameters
instanceinstance of ADC class
chchannel index
  • value 0: master channel
  • value 1: left speaker (in stereo mode)
  • value 2: right speaker (in stereo mode)
minminimum volume value
maxmaximum volume value
resvolume resolution
curcurrent volume value
__STATIC_INLINE void EvrUSBD_ADC_SetSpeakerVolumeRangeFailed ( uint8_t  instance,
uint8_t  ch,
uint16_t  min,
uint16_t  max,
uint16_t  res,
uint16_t  cur,
usbStatus  error 
)

Event on USBD_ADC_SetSpeakerVolumeRange failed (Error)

Parameters
instanceinstance of ADC class
chchannel index
  • value 0: master channel
  • value 1: left speaker (in stereo mode)
  • value 2: right speaker (in stereo mode)
minminimum volume value
maxmaximum volume value
resvolume resolution
curcurrent volume value
errorerror code usbStatus
__STATIC_INLINE void EvrUSBD_ADC_Uninitialize ( uint8_t  instance)

Event on internal library operation ADC uninitialize start (Operation)

Parameters
instanceinstance of ADC class
__STATIC_INLINE void EvrUSBD_ADC_UninitializeFailed ( uint8_t  instance,
usbStatus  error 
)

Event on internal library operation ADC uninitialize failed (Error)

Parameters
instanceinstance of ADC class
errorerror code usbStatus
__STATIC_INLINE void EvrUSBD_ADC_WriteSamples ( uint8_t  instance,
int32_t  result 
)

Event on USBD_ADC_WriteSamples finished successfully (API)

Parameters
instanceinstance of ADC class
resultnumber of samples written for sending
__STATIC_INLINE void EvrUSBD_ADC_WriteSamplesFailed ( uint8_t  instance,
usbStatus  error 
)

Event on USBD_ADC_WriteSamples failed (Error)

Parameters
instanceinstance of ADC class
errorerror code usbStatus
__STATIC_INLINE void EvrUSBD_ADC_WrittenSamplesPending ( uint8_t  instance,
uint32_t  result 
)

Event on USBD_ADC_WrittenSamplesPending finished (API)

Parameters
instanceinstance of ADC class
resultnumber of samples ready to be sent