RT-Thread RTOS
An open source embedded real-time operating system
+ Collaboration diagram for Audio:

Modules

 AUDIO_CTL
 
 AUDIO_TYPE
 
 AUDIO_SAMP_RATES
 
 AUDIO_BIT_RATES
 
 AUDIO_DSP
 
 AUDIO_MIXER
 
 CODEC_CMD
 

Data Structures

struct  rt_audio_buf_info
 
struct  rt_audio_ops
 
struct  rt_audio_configure
 
struct  rt_audio_caps
 
struct  rt_audio_replay
 
struct  rt_audio_record
 
struct  rt_audio_device
 

Enumerations

enum  audio_stream
 

Functions

rt_err_t rt_audio_register (struct rt_audio_device *audio, const char *name, rt_uint32_t flag, void *data)
 
void rt_audio_tx_complete (struct rt_audio_device *audio)
 
void rt_audio_rx_done (struct rt_audio_device *audio, rt_uint8_t *pbuf, rt_size_t len)
 
int rt_audio_samplerate_to_speed (rt_uint32_t bitValue)
 

Detailed Description

Audio driver API.

Enumeration Type Documentation

◆ audio_stream

Audio stream control command.

Function Documentation

◆ rt_audio_register()

rt_err_t rt_audio_register ( struct rt_audio_device audio,
const char *  name,
rt_uint32_t  flag,
void *  data 
)

Register and initialize audio device.

Parameters
[in]audiopointer to audio deive
[in]namedevice name
[in]flagdevice flags
[in]datauser data
Returns
error code, RT_EOK is successful otherwise means failure

◆ rt_audio_tx_complete()

void rt_audio_tx_complete ( struct rt_audio_device audio)

Send a replay frame to the audio hardware device.

See _audio_send_replay_frame for details

Parameters
[in]audiopointer to audio device
Returns
void

◆ rt_audio_rx_done()

void rt_audio_rx_done ( struct rt_audio_device audio,
rt_uint8_t *  pbuf,
rt_size_t  len 
)

Receive recording from audio device.

Parameters
[in]audiopointer to audio device
[in]pbufpointer ro data to be received
[in]lenbuffer size
Returns
void

◆ rt_audio_samplerate_to_speed()

int rt_audio_samplerate_to_speed ( rt_uint32_t  bitValue)

Set audio sample rate.

Parameters
[in]bitValueaudio sample rate, it can be one of value in AUDIO_SAMP_RATES
Returns
speed has been set