AudioStream Class
AudioSettingClass
Description
A class used to initialize audio stream parameters for the audio codec.
Syntax
class AudioSetting
Members
Public Constructors | |
AudioSetting::AudioSetting | Constructs a AudioSetting object. |
AudioClass
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 | |
AudioClass::configAudio | Configure audio module by setting up audio parameters. |
AudioClass::begin | Open audio module. |
AudioClass::end | Close the audio module. |
AudioClass::printInfo | Print out current configuration of audio channels. |
AudioClass::configAudio
Description
Initialize audio stream settings for the audio codec.
Syntax
void configAudio(AudioSetting& config);
Parameters
config: AudioSetting object.
Returns
NA
Example Code
NA
Notes and Warnings
“Audio.h” must be included to use the class function.
AudioClass::begin
Description
Start audio streaming.
Syntax
void begin(void);
Parameters
NA
Returns
NA
Example Code
SingleVideoWithAudio
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Video/examples/StreamRTSP/SingleVideoWithAudio/SingleVideoWithAudio.ino)
Notes and Warnings
“Audio.h” must be included to use the class function.
AudioClass::end
Description
Stop audio streaming.
Syntax
void end(void);
Parameters
NA
Returns
NA
Example Code
NA
Notes and Warnings
“Audio.h” must be included to use the class function.
AudioClass::printInfo
Description
Print out current configuration of audio channel.
Syntax
void printInfo(void);
Parameters
NA
Returns
NA
Example Code
SingleVideoWithAudio
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Video/examples/StreamRTSP/SingleVideoWithAudio/SingleVideoWithAudio.ino)
Notes and Warnings
“Audio.h” must be included to use the class function.