Sound Byte Libs 0.5.1-121-g3358a44
C++ firmware library for audio applications on 32-bit ARM Cortex-M processors
Loading...
Searching...
No Matches
sbl::audio Namespace Reference

Convenience layer: start audio with a validated driver. More...

Detailed Description

Convenience layer: start audio with a validated driver.

Typedefs

using AudioConfig = sbl::hal::audio::AudioConfig
 
using AudioCallback = sbl::hal::audio::AudioCallback
 

Functions

template<typename Driver >
void start (AudioCallback cb)
 Configure audio with defaults, set callback, and start streaming.
 
template<typename Driver >
void start (const AudioConfig &config, AudioCallback cb)
 Configure with custom settings, set callback, and start streaming.
 
template<typename Driver >
void stop ()
 Stop audio streaming.
 

Typedef Documentation

◆ AudioConfig

Definition at line 42 of file driver.hpp.

◆ AudioCallback

Definition at line 43 of file driver.hpp.

Function Documentation

◆ start() [1/2]

template<typename Driver >
void sbl::audio::start ( AudioCallback  cb)
inline

Configure audio with defaults, set callback, and start streaming.

Template Parameters
DriverAudio driver type (e.g., sbl::driver::Sai)
Parameters
cbAudio processing callback (called from ISR context)
Note
Not ISR-safe — init-time only (configures audio hardware + DMA)

Definition at line 54 of file driver.hpp.

◆ start() [2/2]

template<typename Driver >
void sbl::audio::start ( const AudioConfig &  config,
AudioCallback  cb 
)
inline

Configure with custom settings, set callback, and start streaming.

Template Parameters
DriverAudio driver type (e.g., sbl::driver::Sai)
Parameters
configAudio configuration (sample rate, bit depth, block size)
cbAudio processing callback (called from ISR context)
Note
Not ISR-safe — init-time only (configures audio hardware + DMA)

Definition at line 70 of file driver.hpp.

◆ stop()

template<typename Driver >
void sbl::audio::stop ( )
inline

Stop audio streaming.

Template Parameters
DriverAudio driver type (e.g., sbl::driver::Sai)
Note
Not ISR-safe — tears down audio streaming hardware

Definition at line 84 of file driver.hpp.