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

Public Member Functions

 ExternalMediaPlayerTest ()
 
void SetUp () override
 
void TearDown () override
 
void verifyState (const std::string &providedState, const std::string &expectedState)
 
void sendAuthorizeDiscoveredPlayersDirective (const std::string &payload, std::unique_ptr< DirectiveHandlerResultInterface > resultHandler=nullptr)
 
SetStateResult wakeOnSetState ()
 
SetStateResult resetWakeOnSetState ()
 

Public Attributes

ExternalMediaPlayer::AdapterMediaPlayerMap m_adapterMediaPlayerMap
 The map of adapters to MediaPlayerInterface. More...
 
ExternalMediaPlayer::AdapterSpeakerMap m_adapterSpeakerMap
 The map of adapters to SpeakerInterface. More...
 
ExternalMediaPlayer::AdapterCreationMap m_adapterMap
 The map of adapter creation functions. More...
 
std::shared_ptr< ExternalMediaPlayerm_externalMediaPlayer
 ExternalMediaPlayer to test More...
 
std::shared_ptr< MockMediaPlayerm_mockMediaPlayer
 Player to send the audio to. More...
 
std::shared_ptr< MockChannelVolumeInterfacem_mockSpeakerInterface
 SpeakerInterface to manage volume changes of individual speakers. More...
 
std::shared_ptr< MockSpeakerManagerm_mockSpeakerManager
 SpeakerManager to manage volume changes across speakers. More...
 
std::shared_ptr< MockMetricRecorderm_metricRecorder
 MetricRecorder to send metrics More...
 
std::shared_ptr< MockContextManagerm_mockContextManager
 ContextManager to provide state and update state. More...
 
std::shared_ptr< MockFocusManagerm_mockFocusManager
 FocusManager to request focus to the DIALOG channel. More...
 
std::unique_ptr< MockDirectiveHandlerResultm_mockDirectiveHandlerResult
 A directive handler result to send the result to. More...
 
std::shared_ptr< MockMessageSenderm_mockMessageSender
 A message sender used to send events to AVS. More...
 
std::shared_ptr< certifiedSender::test::MockCertifiedSenderm_mockCertifiedSender
 
std::shared_ptr< MockExceptionEncounteredSenderm_mockExceptionSender
 An exception sender used to send exception encountered events to AVS. More...
 
std::shared_ptr< MockPlaybackRouterm_mockPlaybackRouter
 A playback router to notify when ExternalMediaPlayer becomes active. More...
 
std::shared_ptr< AttachmentManagerm_attachmentManager
 Attachment manager used to create a reader. More...
 
std::promise< void > m_wakeSetStatePromise
 Promise to be fulfilled when setState is called. More...
 
std::future< void > m_wakeSetStateFuture
 Future to notify when setState is called. More...
 

Constructor & Destructor Documentation

◆ ExternalMediaPlayerTest()

alexaClientSDK::capabilityAgents::externalMediaPlayer::test::ExternalMediaPlayerTest::ExternalMediaPlayerTest ( )

Member Function Documentation

◆ resetWakeOnSetState()

SetStateResult alexaClientSDK::capabilityAgents::externalMediaPlayer::test::ExternalMediaPlayerTest::resetWakeOnSetState ( )

This is is invoked to clear the promise set by a setState call for repeat testing

Returns
SUCCESS.

◆ sendAuthorizeDiscoveredPlayersDirective()

void alexaClientSDK::capabilityAgents::externalMediaPlayer::test::ExternalMediaPlayerTest::sendAuthorizeDiscoveredPlayersDirective ( const std::string &  payload,
std::unique_ptr< DirectiveHandlerResultInterface resultHandler = nullptr 
)

Helper method to authorize a set of players.

Parameters
payloadThe payload for an AuthorizeDiscoveredPlayers directive.
resultHandlerA result handler associated with the directive upon which expectations can be set.

◆ SetUp()

void alexaClientSDK::capabilityAgents::externalMediaPlayer::test::ExternalMediaPlayerTest::SetUp ( )
override

◆ TearDown()

void alexaClientSDK::capabilityAgents::externalMediaPlayer::test::ExternalMediaPlayerTest::TearDown ( )
override

◆ verifyState()

void alexaClientSDK::capabilityAgents::externalMediaPlayer::test::ExternalMediaPlayerTest::verifyState ( const std::string &  providedState,
const std::string &  expectedState 
)

Verify that the provided state matches the expected state

Parameters
jsonStateThe state to verify
expectedStateThe expected state

◆ wakeOnSetState()

SetStateResult alexaClientSDK::capabilityAgents::externalMediaPlayer::test::ExternalMediaPlayerTest::wakeOnSetState ( )

This is invoked in response to a setState call.

Returns
SUCCESS.

Member Data Documentation

◆ m_adapterMap

ExternalMediaPlayer::AdapterCreationMap alexaClientSDK::capabilityAgents::externalMediaPlayer::test::ExternalMediaPlayerTest::m_adapterMap

The map of adapter creation functions.

◆ m_adapterMediaPlayerMap

ExternalMediaPlayer::AdapterMediaPlayerMap alexaClientSDK::capabilityAgents::externalMediaPlayer::test::ExternalMediaPlayerTest::m_adapterMediaPlayerMap

The map of adapters to MediaPlayerInterface.

◆ m_adapterSpeakerMap

ExternalMediaPlayer::AdapterSpeakerMap alexaClientSDK::capabilityAgents::externalMediaPlayer::test::ExternalMediaPlayerTest::m_adapterSpeakerMap

The map of adapters to SpeakerInterface.

◆ m_attachmentManager

std::shared_ptr<AttachmentManager> alexaClientSDK::capabilityAgents::externalMediaPlayer::test::ExternalMediaPlayerTest::m_attachmentManager

Attachment manager used to create a reader.

◆ m_externalMediaPlayer

std::shared_ptr<ExternalMediaPlayer> alexaClientSDK::capabilityAgents::externalMediaPlayer::test::ExternalMediaPlayerTest::m_externalMediaPlayer

◆ m_metricRecorder

std::shared_ptr<MockMetricRecorder> alexaClientSDK::capabilityAgents::externalMediaPlayer::test::ExternalMediaPlayerTest::m_metricRecorder

MetricRecorder to send metrics

◆ m_mockCertifiedSender

std::shared_ptr<certifiedSender::test::MockCertifiedSender> alexaClientSDK::capabilityAgents::externalMediaPlayer::test::ExternalMediaPlayerTest::m_mockCertifiedSender

◆ m_mockContextManager

std::shared_ptr<MockContextManager> alexaClientSDK::capabilityAgents::externalMediaPlayer::test::ExternalMediaPlayerTest::m_mockContextManager

ContextManager to provide state and update state.

◆ m_mockDirectiveHandlerResult

std::unique_ptr<MockDirectiveHandlerResult> alexaClientSDK::capabilityAgents::externalMediaPlayer::test::ExternalMediaPlayerTest::m_mockDirectiveHandlerResult

A directive handler result to send the result to.

◆ m_mockExceptionSender

std::shared_ptr<MockExceptionEncounteredSender> alexaClientSDK::capabilityAgents::externalMediaPlayer::test::ExternalMediaPlayerTest::m_mockExceptionSender

An exception sender used to send exception encountered events to AVS.

◆ m_mockFocusManager

std::shared_ptr<MockFocusManager> alexaClientSDK::capabilityAgents::externalMediaPlayer::test::ExternalMediaPlayerTest::m_mockFocusManager

FocusManager to request focus to the DIALOG channel.

◆ m_mockMediaPlayer

std::shared_ptr<MockMediaPlayer> alexaClientSDK::capabilityAgents::externalMediaPlayer::test::ExternalMediaPlayerTest::m_mockMediaPlayer

Player to send the audio to.

◆ m_mockMessageSender

std::shared_ptr<MockMessageSender> alexaClientSDK::capabilityAgents::externalMediaPlayer::test::ExternalMediaPlayerTest::m_mockMessageSender

A message sender used to send events to AVS.

◆ m_mockPlaybackRouter

std::shared_ptr<MockPlaybackRouter> alexaClientSDK::capabilityAgents::externalMediaPlayer::test::ExternalMediaPlayerTest::m_mockPlaybackRouter

A playback router to notify when ExternalMediaPlayer becomes active.

◆ m_mockSpeakerInterface

std::shared_ptr<MockChannelVolumeInterface> alexaClientSDK::capabilityAgents::externalMediaPlayer::test::ExternalMediaPlayerTest::m_mockSpeakerInterface

SpeakerInterface to manage volume changes of individual speakers.

◆ m_mockSpeakerManager

std::shared_ptr<MockSpeakerManager> alexaClientSDK::capabilityAgents::externalMediaPlayer::test::ExternalMediaPlayerTest::m_mockSpeakerManager

SpeakerManager to manage volume changes across speakers.

◆ m_wakeSetStateFuture

std::future<void> alexaClientSDK::capabilityAgents::externalMediaPlayer::test::ExternalMediaPlayerTest::m_wakeSetStateFuture

Future to notify when setState is called.

◆ m_wakeSetStatePromise

std::promise<void> alexaClientSDK::capabilityAgents::externalMediaPlayer::test::ExternalMediaPlayerTest::m_wakeSetStatePromise

Promise to be fulfilled when setState is called.


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

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