AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::integration::test::TestSpeechSynthesizerObserver Class Reference

#include <TestSpeechSynthesizerObserver.h>

Inheritance diagram for alexaClientSDK::integration::test::TestSpeechSynthesizerObserver:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::integration::test::TestSpeechSynthesizerObserver:
Collaboration graph
[legend]

Public Member Functions

 TestSpeechSynthesizerObserver ()
 
 ~TestSpeechSynthesizerObserver ()=default
 
void onStateChanged (avsCommon::sdkInterfaces::SpeechSynthesizerObserverInterface::SpeechSynthesizerState state, const avsCommon::utils::mediaPlayer::MediaPlayerInterface::SourceId mediaSourceId, const avsCommon::utils::Optional< avsCommon::utils::mediaPlayer::MediaPlayerState > &mediaPlayerState, const std::vector< avsCommon::utils::audioAnalyzer::AudioAnalyzerState > &audioAnalyzerState) override
 
bool checkState (const avsCommon::sdkInterfaces::SpeechSynthesizerObserverInterface::SpeechSynthesizerState expectedState, const std::chrono::seconds duration)
 
avsCommon::sdkInterfaces::SpeechSynthesizerObserverInterface::SpeechSynthesizerState waitForNext (const std::chrono::seconds duration)
 
avsCommon::sdkInterfaces::SpeechSynthesizerObserverInterface::SpeechSynthesizerState getCurrentState ()
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::SpeechSynthesizerObserverInterface
virtual ~SpeechSynthesizerObserverInterface ()=default
 

Additional Inherited Members

- Public Types inherited from alexaClientSDK::avsCommon::sdkInterfaces::SpeechSynthesizerObserverInterface
enum  SpeechSynthesizerState {
  SpeechSynthesizerState::PLAYING, SpeechSynthesizerState::FINISHED, SpeechSynthesizerState::INTERRUPTED, SpeechSynthesizerState::GAINING_FOCUS,
  SpeechSynthesizerState::LOSING_FOCUS
}
 

Detailed Description

Interface for observing a SpeechSynthesizer.

Constructor & Destructor Documentation

◆ TestSpeechSynthesizerObserver()

alexaClientSDK::integration::test::TestSpeechSynthesizerObserver::TestSpeechSynthesizerObserver ( )

◆ ~TestSpeechSynthesizerObserver()

alexaClientSDK::integration::test::TestSpeechSynthesizerObserver::~TestSpeechSynthesizerObserver ( )
default

Member Function Documentation

◆ checkState()

bool alexaClientSDK::integration::test::TestSpeechSynthesizerObserver::checkState ( const avsCommon::sdkInterfaces::SpeechSynthesizerObserverInterface::SpeechSynthesizerState  expectedState,
const std::chrono::seconds  duration 
)

◆ getCurrentState()

SpeechSynthesizerObserverInterface::SpeechSynthesizerState alexaClientSDK::integration::test::TestSpeechSynthesizerObserver::getCurrentState ( )

◆ onStateChanged()

void alexaClientSDK::integration::test::TestSpeechSynthesizerObserver::onStateChanged ( avsCommon::sdkInterfaces::SpeechSynthesizerObserverInterface::SpeechSynthesizerState  state,
const avsCommon::utils::mediaPlayer::MediaPlayerInterface::SourceId  mediaSourceId,
const avsCommon::utils::Optional< avsCommon::utils::mediaPlayer::MediaPlayerState > &  mediaPlayerState,
const std::vector< avsCommon::utils::audioAnalyzer::AudioAnalyzerState > &  audioAnalyzerState 
)
overridevirtual

Notification that the SpeechSynthesizer state has changed. Callback functions must return as soon as possible.

Parameters
stateThe new state of the speechSynthesizer.
mediaSourceIdThe current media source id for SpeechSynthesizer
mediaPlayerStateOptional state of the media player as of this state change. The Optional is blank if the state is unavailable.
audioAnalyzerStatestates of the audio analyzers related to the speech output.

Implements alexaClientSDK::avsCommon::sdkInterfaces::SpeechSynthesizerObserverInterface.

◆ waitForNext()

SpeechSynthesizerObserverInterface::SpeechSynthesizerState alexaClientSDK::integration::test::TestSpeechSynthesizerObserver::waitForNext ( const std::chrono::seconds  duration)

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

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