Class AudioStream

AudioSetting Class

Description

A class used to contain audio configuration parameters for the audio codec.

Syntax

class AudioSetting

Members

Public Constructors
AudioSetting::AudioSetting	Constructs an AudioSetting object.

Audio Class

Description

A class used to configure and initialize the on-board Audio Codec to generate an audio data stream.

Syntax

class Audio

Members

Public Constructors
Audio::Audio	Constructs an Audio object.
Public Methods
Audio::configAudio	Configure audio module by setting up audio parameters.
Audio::configMicAEC	Configure Acoustic Echo Cancellation algorithm for microphone audio input.
Audio::configMicAGC	Configure Automatic Gain Control algorithm for microphone audio input.
Audio::configMicNS	Configure Noise Suppression algorithm for microphone audio input.
Audio::configSpkAGC	Configure Automatic Gain Control algorithm for speaker audio output.
Audio::configSpkNS	Configure Noise Suppression algorithm for speaker audio output.
Audio::begin	Start audio data streaming.
Audio::end	Stop audio data streaming.
Audio::setAMicBoost	Adjust input sensitivity boost for analog mic.
Audio::setDMicBoost	Adjust input sensitivity boost for digital mic.
Audio::setMicGain	Adjust microphone input volume.
Audio::setSpkGain	Adjust speaker output volume.
Audio::muteMic	Mute microphone input.
Audio::muteSpk	Mute speaker output.
Audio::printInfo	Print out current configuration of audio channels.

Audio::configAudio

Description

Initialize audio stream settings for the audio codec.

Syntax

void configAudio(AudioSetting& config);

Parameters

config: AudioSetting object containing desired audio configuration.

Example Code

Example: Audio/LoopbackTest

Note

“AudioStream.h” must be included to use the class function.

Audio::configMicAEC

Description

Configure Acoustic Echo Cancellation algorithm for microphone audio input.

Syntax

void configMicAEC(uint8_t enable, uint8_t level);

Parameters

enable: Enable or disable Acoustic Echo Cancellation algorithm.

level: Strength of echo cancellation effect.

0 to 17 (Default value is 5)

“AudioStream.h” must be included to use the class function. The algorithm will only work when the audio sample rate is configured as 8kHz or 16kHz. The Acoustic Echo Cancellation algorithm is intended to prevent the microphone audio input from picking up sounds produced by the speaker audio output.

Audio::configMicAEC

Description

Configure Automatic Gain Control algorithm for microphone audio input.

Syntax

void configMicAGC(uint8_t enable, uint8_t dBFS);

Parameters

enable: Enable or disable Automatic Gain Control algorithm.

level: Target reference level of gain control algorithm.

0 to 30 (Corresponding to 0 dBFS to -30 dBFS. Default value is 6)

Returns

NA

Example Code

Example: Audio/AudioEffect

Note

“AudioStream.h” must be included to use the class function. The algorithm will only work when the audio sample rate is configured as 8kHz or 16kHz.

Audio::configMicNS

Description

Configure Noise Suppression algorithm for microphone audio input.

Syntax

void configMicNS(uint8_t enable, uint8_t level);

Parameters

enable: Enable or disable Noise Suppression algorithm.

level: Strength of Noise Suppression effect.

0 to 12 (Default value is 12)

Returns

NA

Example Code

Example: Audio/AudioEffect

Note

“AudioStream.h” must be included to use the class function. The algorithm will only work when the audio sample rate is configured as 8kHz or 16kHz.

Audio::configSpkAGC

Description

Configure Acoustic Echo Cancellation algorithm for speaker audio output.

Syntax

void configMicAGC(uint8_t enable, uint8_t dBFS);

Parameters

enable: Enable or disable Automatic Gain Control algorithm.

level: Target reference level of gain control algorithm.

0 to 30 (Corresponding to 0 dBFS to -30 dBFS. Default value is 6)

Returns

NA

Example Code

Example: Audio/AudioEffect

Note

“AudioStream.h” must be included to use the class function. The algorithm will only work when the audio sample rate is configured as 8kHz or 16kHz.

void configMicNS(uint8_t enable, uint8_t level);

Parameters

enable: Enable or disable Noise Suppression algorithm.

level: Strength of Noise Suppression effect.

0 to 12 (Default value is 12)

Returns

NA

Example Code

Example: Audio/AudioEffect

Note

“AudioStream.h” must be included to use the class function. The algorithm will only work when the audio sample rate is configured as 8kHz or 16kHz.

void begin(void);

“AudioStream.h” must be included to use the class function.

void end(void);

“AudioStream.h” must be included to use the class function.

void setAMicBoost(uint8_t amicBoost);

Parameters

amicBoost: Sensitivity boost for analog mic input.

0 to 3 (Corresponding to sensitivity boosts of 0 dB, 20 dB, 30 dB, 40 dB. Default value is 0)

Returns

NA

Example Code

Example: Audio/AudioEffect

Note

“AudioStream.h” must be included to use the class function.

void setDMicBoost(uint8_t dmicBoost);

Parameters

dmicBoost: Sensitivity boost for analog mic input.

0 to 3 (Corresponding to sensitivity boosts of 0 dB, 12 dB, 24 dB, 36 dB. Default value is 0)

Returns

NA

Example Code

Example: Audio/AudioEffect

Note

“AudioStream.h” must be included to use the class function.

void setMicGain(uint8_t gain);

Parameters

gain: Volume level of microphone input.

0 to 100

Returns

NA

Example Code

Example: Audio/AudioVolumeAdjust

Note

“AudioStream.h” must be included to use the class function.

void setSpkGain(uint8_t gain);

Parameters

gain: Volume level of speaker output.

0 to 100

Returns

NA

Example Code

Example: Audio/AudioVolumeAdjust

Note

“AudioStream.h” must be included to use the class function.

void muteMic(uint8_t mute);

“AudioStream.h” must be included to use the class function.

void muteSpk(uint8_t mute);

“AudioStream.h” must be included to use the class function.

void printInfo(void);

“AudioStream.h” must be included to use the class function.