AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::acsdkAudioPlayer::test::TestAudioPlayerObserver Class Reference
Inheritance diagram for alexaClientSDK::acsdkAudioPlayer::test::TestAudioPlayerObserver:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::acsdkAudioPlayer::test::TestAudioPlayerObserver:
Collaboration graph
[legend]

Public Member Functions

 TestAudioPlayerObserver ()
 
bool waitFor (PlayerActivity activity, std::chrono::milliseconds timeout)
 
bool waitFor (SeekStatus seekStatus, std::chrono::milliseconds offset, std::chrono::milliseconds timeout)
 
bool waitFor (SeekStatus seekStatus, std::chrono::milliseconds stOffset, std::chrono::milliseconds endOffset, std::chrono::milliseconds timeout)
 
void onPlayerActivityChanged (avsCommon::avs::PlayerActivity state, const Context &context) override
 
void onSeekActivity (SeekStatus seekStatus, const Context &context) override
 
PlayRequestor getPlayRequestorObject ()
 
- Public Member Functions inherited from alexaClientSDK::acsdkAudioPlayerInterfaces::AudioPlayerObserverInterface
virtual ~AudioPlayerObserverInterface ()=default
 

Additional Inherited Members

- Public Types inherited from alexaClientSDK::acsdkAudioPlayerInterfaces::AudioPlayerObserverInterface
enum  SeekStatus { SeekStatus::SEEK_START, SeekStatus::SEEK_COMPLETE }
 Enum representing Seek activities. More...
 

Constructor & Destructor Documentation

◆ TestAudioPlayerObserver()

alexaClientSDK::acsdkAudioPlayer::test::TestAudioPlayerObserver::TestAudioPlayerObserver ( )
inline

Member Function Documentation

◆ getPlayRequestorObject()

PlayRequestor alexaClientSDK::acsdkAudioPlayer::test::TestAudioPlayerObserver::getPlayRequestorObject ( )
inline

◆ onPlayerActivityChanged()

void alexaClientSDK::acsdkAudioPlayer::test::TestAudioPlayerObserver::onPlayerActivityChanged ( avsCommon::avs::PlayerActivity  state,
const Context context 
)
inlineoverridevirtual

Used to notify the observer when the AudioPlayer has a change in PlayerActivity.

Parameters
stateThe PlayerActivity of the AudioPlayer.
contextThe Context of the AudioPlayer.

Implements alexaClientSDK::acsdkAudioPlayerInterfaces::AudioPlayerObserverInterface.

◆ onSeekActivity()

void alexaClientSDK::acsdkAudioPlayer::test::TestAudioPlayerObserver::onSeekActivity ( SeekStatus  seekStatus,
const Context context 
)
inlineoverridevirtual

Used to notify the observer when the AudioPlayer is seeking within the current track.

Parameters
seekStatusType of activity being performed, represented by SeekStatus
contextThe Context of the AudioPlayer at the time of the seek activity.

Reimplemented from alexaClientSDK::acsdkAudioPlayerInterfaces::AudioPlayerObserverInterface.

◆ waitFor() [1/3]

bool alexaClientSDK::acsdkAudioPlayer::test::TestAudioPlayerObserver::waitFor ( PlayerActivity  activity,
std::chrono::milliseconds  timeout 
)
inline

◆ waitFor() [2/3]

bool alexaClientSDK::acsdkAudioPlayer::test::TestAudioPlayerObserver::waitFor ( SeekStatus  seekStatus,
std::chrono::milliseconds  offset,
std::chrono::milliseconds  timeout 
)
inline

◆ waitFor() [3/3]

bool alexaClientSDK::acsdkAudioPlayer::test::TestAudioPlayerObserver::waitFor ( SeekStatus  seekStatus,
std::chrono::milliseconds  stOffset,
std::chrono::milliseconds  endOffset,
std::chrono::milliseconds  timeout 
)
inline

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

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