alexaClientSDK::applicationUtilities::resources::audio::MicrophoneInterface Class Reference

This acts as an interface to record audio input from a microphone. More...

#include <MicrophoneInterface.h>

Inheritance diagram for alexaClientSDK::applicationUtilities::resources::audio::MicrophoneInterface:

Public Member Functions
virtual bool	stopStreamingMicrophoneData ()=0
virtual bool	startStreamingMicrophoneData ()=0
virtual bool	isStreaming ()=0
virtual	~MicrophoneInterface ()=default

Detailed Description

This acts as an interface to record audio input from a microphone.

Constructor & Destructor Documentation

~MicrophoneInterface()

virtual alexaClientSDK::applicationUtilities::resources::audio::MicrophoneInterface::~MicrophoneInterface ( )

virtualdefault

Destructor.

Member Function Documentation

isStreaming()

virtual bool alexaClientSDK::applicationUtilities::resources::audio::MicrophoneInterface::isStreaming ( )

pure virtual

Whether the microphone is currently streaming.

Returns

Whether the microphone is streaming.

Implemented in alexaClientSDK::applicationUtilities::androidUtilities::AndroidSLESMicrophone, alexaClientSDK::sampleApplications::ipcServerSampleApp::PortAudioMicrophoneWrapper, and alexaClientSDK::diagnostics::AudioInjectorMicrophone.

startStreamingMicrophoneData()

virtual bool alexaClientSDK::applicationUtilities::resources::audio::MicrophoneInterface::startStreamingMicrophoneData ( )

pure virtual

Starts streaming from the microphone.

Returns

Whether the start was successful.

Implemented in alexaClientSDK::applicationUtilities::androidUtilities::AndroidSLESMicrophone, alexaClientSDK::sampleApplications::ipcServerSampleApp::PortAudioMicrophoneWrapper, and alexaClientSDK::diagnostics::AudioInjectorMicrophone.

stopStreamingMicrophoneData()

virtual bool alexaClientSDK::applicationUtilities::resources::audio::MicrophoneInterface::stopStreamingMicrophoneData ( )

pure virtual

Stops streaming from the microphone.

Returns

Whether the stop was successful.

Implemented in alexaClientSDK::applicationUtilities::androidUtilities::AndroidSLESMicrophone, alexaClientSDK::diagnostics::AudioInjectorMicrophone, and alexaClientSDK::sampleApplications::ipcServerSampleApp::PortAudioMicrophoneWrapper.

---

The documentation for this class was generated from the following file:

• /workplace/avs-device-sdk/ApplicationUtilities/Resources/Audio/include/Audio/MicrophoneInterface.h