alexaClientSDK::sampleApp::PortAudioMicrophoneWrapper Class Reference

This acts as a wrapper around PortAudio, a cross-platform open-source audio I/O library. More...

#include <PortAudioMicrophoneWrapper.h>

Inheritance diagram for alexaClientSDK::sampleApp::PortAudioMicrophoneWrapper:

Collaboration diagram for alexaClientSDK::sampleApp::PortAudioMicrophoneWrapper:

Public Member Functions
bool	stopStreamingMicrophoneData () override
bool	startStreamingMicrophoneData () override
bool	isStreaming () override
	~PortAudioMicrophoneWrapper ()
Public Member Functions inherited from alexaClientSDK::applicationUtilities::resources::audio::MicrophoneInterface
virtual	~MicrophoneInterface ()=default

Static Public Member Functions
static std::unique_ptr< PortAudioMicrophoneWrapper >	create (std::shared_ptr< avsCommon::avs::AudioInputStream > stream)

Detailed Description

This acts as a wrapper around PortAudio, a cross-platform open-source audio I/O library.

Constructor & Destructor Documentation

~PortAudioMicrophoneWrapper()

alexaClientSDK::sampleApp::PortAudioMicrophoneWrapper::~PortAudioMicrophoneWrapper

(

)

Destructor.

Member Function Documentation

create()

std::unique_ptr< PortAudioMicrophoneWrapper > alexaClientSDK::sampleApp::PortAudioMicrophoneWrapper::create ( std::shared_ptr< avsCommon::avs::AudioInputStream >  stream )

static

Creates a PortAudioMicrophoneWrapper.

Parameters

stream

The shared data stream to write to.

Returns

A unique_ptr to a PortAudioMicrophoneWrapper if creation was successful and nullptr otherwise.

isStreaming()

bool alexaClientSDK::sampleApp::PortAudioMicrophoneWrapper::isStreaming ( )

overridevirtual

Whether the microphone is currently streaming.

Returns

Whether the microphone is streaming.

Implements alexaClientSDK::applicationUtilities::resources::audio::MicrophoneInterface.

startStreamingMicrophoneData()

bool alexaClientSDK::sampleApp::PortAudioMicrophoneWrapper::startStreamingMicrophoneData ( )

overridevirtual

Starts streaming from the microphone.

Returns

Whether the start was successful.

Implements alexaClientSDK::applicationUtilities::resources::audio::MicrophoneInterface.

stopStreamingMicrophoneData()

bool alexaClientSDK::sampleApp::PortAudioMicrophoneWrapper::stopStreamingMicrophoneData ( )

overridevirtual

Stops streaming from the microphone.

Returns

Whether the stop was successful.

Implements alexaClientSDK::applicationUtilities::resources::audio::MicrophoneInterface.

---

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

• /workplace/avs-device-sdk/SampleApp/include/SampleApp/PortAudioMicrophoneWrapper.h
• /workplace/avs-device-sdk/SampleApp/src/PortAudioMicrophoneWrapper.cpp