AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::AudioInjectorInterface Class Referenceabstract

#include <AudioInjectorInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::AudioInjectorInterface:
Inheritance graph
[legend]

Public Member Functions

virtual std::shared_ptr< applicationUtilities::resources::audio::MicrophoneInterfacegetMicrophone (const std::shared_ptr< avsCommon::avs::AudioInputStream > &stream, const alexaClientSDK::avsCommon::utils::AudioFormat &compatibleAudioFormat)=0
 
virtual bool injectAudio (const std::string &filepath)=0
 
virtual ~AudioInjectorInterface ()=default
 

Constructor & Destructor Documentation

◆ ~AudioInjectorInterface()

virtual alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::AudioInjectorInterface::~AudioInjectorInterface ( )
virtualdefault

Destructor.

Member Function Documentation

◆ getMicrophone()

virtual std::shared_ptr<applicationUtilities::resources::audio::MicrophoneInterface> alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::AudioInjectorInterface::getMicrophone ( const std::shared_ptr< avsCommon::avs::AudioInputStream > &  stream,
const alexaClientSDK::avsCommon::utils::AudioFormat compatibleAudioFormat 
)
pure virtual

Returns a MicrophoneInterface instance.

Parameters
streamThe shared data stream to write to.
compatibleAudioFormatThe format of audio data.
Returns
a new instance of .

Implemented in alexaClientSDK::diagnostics::FileBasedAudioInjector.

◆ injectAudio()

virtual bool alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::AudioInjectorInterface::injectAudio ( const std::string &  filepath)
pure virtual

Injects audio into the audio buffer.

Parameters
filepathLocation of audio file.
Returns
Whether audio was successfully injected.

Implemented in alexaClientSDK::diagnostics::FileBasedAudioInjector.


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

AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0