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

Public Member Functions

void SetUp () override
 
void TearDown () override
 
void authorizePlayer ()
 
 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, const std::string &messageId=MESSAGE_ID_TEST2)
 
SetStateResult wakeOnSetState ()
 
SetStateResult resetWakeOnSetState ()
 
void wakeOnSetComplete ()
 
- Public Member Functions inherited from testing::Test
virtual ~Test ()
 

Public Attributes

std::shared_ptr< MockExternalMediaPlayerm_externalMediaPlayer
 ExternalMediaPlayer for testing purposes More...
 
std::shared_ptr< MockExternalMediaAdapterHandlerm_externalMediaPlayerAdapterHandler
 The external media adapter handler. 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< avsCommon::sdkInterfaces::endpoints::test::MockEndpointCapabilitiesRegistrarm_mockEndpointCapabilitiesRegistrar
 An endpoint capabilities registrar with which to register the EMP. More...
 
std::shared_ptr< acsdkStartupManagerInterfaces::StartupNotifierInterfacem_startupNotifier
 Object to notify the EMP when to start up. More...
 
std::shared_ptr< acsdkShutdownManagerInterfaces::ShutdownNotifierInterfacem_shutdownNotifier
 Object to notify the EMP when to shut down. More...
 
std::shared_ptr< MockRenderPlayerInfoCardsProviderRegistrarm_renderPlayerInfoCardsProviderRegistrar
 Registrar for RenderPlayerInfoCardsProviders. More...
 
std::shared_ptr< acsdkApplicationAudioPipelineFactoryInterfaces::test::MockApplicationAudioPipelineFactorym_mockAudioPipelineFactory
 The mock ApplicationAudioPipelineFactoryInterface. 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...
 
std::promise< void > m_wakeSetCompletePromise
 Promise to be fulfilled when directive handling is complete. More...
 
std::future< void > m_wakeSetCompleteFuture
 Future to notify when directive handling is complete. More...
 

Additional Inherited Members

- Public Types inherited from testing::Test
typedef internal::SetUpTestCaseFunc SetUpTestCaseFunc
 
typedef internal::TearDownTestCaseFunc TearDownTestCaseFunc
 
- Static Public Member Functions inherited from testing::Test
static void SetUpTestCase ()
 
static void TearDownTestCase ()
 
static bool HasFatalFailure ()
 
static bool HasNonfatalFailure ()
 
static bool HasFailure ()
 
static void RecordProperty (const std::string &key, const std::string &value)
 
static void RecordProperty (const std::string &key, int value)
 
- Protected Member Functions inherited from testing::Test
 Test ()
 

Constructor & Destructor Documentation

◆ ExternalMediaPlayerTest()

alexaClientSDK::acsdkExternalMediaPlayer::test::ExternalMediaPlayerTest::ExternalMediaPlayerTest ( )

Member Function Documentation

◆ authorizePlayer()

void alexaClientSDK::acsdkExternalMediaPlayer::test::ExternalMediaPlayerTest::authorizePlayer ( )

◆ resetWakeOnSetState()

SetStateResult alexaClientSDK::acsdkExternalMediaPlayer::test::ExternalMediaPlayerTest::resetWakeOnSetState ( )

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

Returns
SUCCESS.

◆ sendAuthorizeDiscoveredPlayersDirective()

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

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() [1/2]

void alexaClientSDK::acsdkExternalMediaPlayer::test::ExternalMediaPlayerTest::SetUp ( )
overridevirtual

Reimplemented from testing::Test.

◆ SetUp() [2/2]

void alexaClientSDK::acsdkExternalMediaPlayer::test::ExternalMediaPlayerTest::SetUp ( )
overridevirtual

Reimplemented from testing::Test.

◆ TearDown() [1/2]

void alexaClientSDK::acsdkExternalMediaPlayer::test::ExternalMediaPlayerTest::TearDown ( )
overridevirtual

Reimplemented from testing::Test.

◆ TearDown() [2/2]

void alexaClientSDK::acsdkExternalMediaPlayer::test::ExternalMediaPlayerTest::TearDown ( )
overridevirtual

Reimplemented from testing::Test.

◆ verifyState()

void alexaClientSDK::acsdkExternalMediaPlayer::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

◆ wakeOnSetComplete()

void alexaClientSDK::acsdkExternalMediaPlayer::test::ExternalMediaPlayerTest::wakeOnSetComplete ( )

This is invoked in response to a setComplete call.

Returns
SUCCESS.

◆ wakeOnSetState()

SetStateResult alexaClientSDK::acsdkExternalMediaPlayer::test::ExternalMediaPlayerTest::wakeOnSetState ( )

This is invoked in response to a setState call.

Returns
SUCCESS.

Member Data Documentation

◆ m_adapterMap

ExternalMediaPlayer::AdapterCreationMap alexaClientSDK::acsdkExternalMediaPlayer::test::ExternalMediaPlayerTest::m_adapterMap

The map of adapter creation functions.

◆ m_attachmentManager

std::shared_ptr<AttachmentManager> alexaClientSDK::acsdkExternalMediaPlayer::test::ExternalMediaPlayerTest::m_attachmentManager

Attachment manager used to create a reader.

◆ m_externalMediaPlayer [1/2]

std::shared_ptr<MockExternalMediaPlayer> alexaClientSDK::acsdkExternalMediaPlayer::test::ExternalMediaPlayerTest::m_externalMediaPlayer

ExternalMediaPlayer for testing purposes

◆ m_externalMediaPlayer [2/2]

std::shared_ptr<ExternalMediaPlayer> alexaClientSDK::acsdkExternalMediaPlayer::test::ExternalMediaPlayerTest::m_externalMediaPlayer

◆ m_externalMediaPlayerAdapterHandler

std::shared_ptr<MockExternalMediaAdapterHandler> alexaClientSDK::acsdkExternalMediaPlayer::test::ExternalMediaPlayerTest::m_externalMediaPlayerAdapterHandler

The external media adapter handler.

◆ m_metricRecorder

std::shared_ptr<MockMetricRecorder> alexaClientSDK::acsdkExternalMediaPlayer::test::ExternalMediaPlayerTest::m_metricRecorder

MetricRecorder to send metrics

◆ m_mockAudioPipelineFactory

std::shared_ptr<acsdkApplicationAudioPipelineFactoryInterfaces::test::MockApplicationAudioPipelineFactory> alexaClientSDK::acsdkExternalMediaPlayer::test::ExternalMediaPlayerTest::m_mockAudioPipelineFactory

The mock ApplicationAudioPipelineFactoryInterface.

◆ m_mockCertifiedSender

std::shared_ptr<certifiedSender::test::MockCertifiedSender> alexaClientSDK::acsdkExternalMediaPlayer::test::ExternalMediaPlayerTest::m_mockCertifiedSender

◆ m_mockContextManager

std::shared_ptr<MockContextManager> alexaClientSDK::acsdkExternalMediaPlayer::test::ExternalMediaPlayerTest::m_mockContextManager

ContextManager to provide state and update state.

◆ m_mockDirectiveHandlerResult

std::unique_ptr<MockDirectiveHandlerResult> alexaClientSDK::acsdkExternalMediaPlayer::test::ExternalMediaPlayerTest::m_mockDirectiveHandlerResult

A directive handler result to send the result to.

◆ m_mockEndpointCapabilitiesRegistrar

std::shared_ptr<avsCommon::sdkInterfaces::endpoints::test::MockEndpointCapabilitiesRegistrar> alexaClientSDK::acsdkExternalMediaPlayer::test::ExternalMediaPlayerTest::m_mockEndpointCapabilitiesRegistrar

An endpoint capabilities registrar with which to register the EMP.

◆ m_mockExceptionSender

std::shared_ptr<MockExceptionEncounteredSender> alexaClientSDK::acsdkExternalMediaPlayer::test::ExternalMediaPlayerTest::m_mockExceptionSender

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

◆ m_mockFocusManager

std::shared_ptr<MockFocusManager> alexaClientSDK::acsdkExternalMediaPlayer::test::ExternalMediaPlayerTest::m_mockFocusManager

FocusManager to request focus to the DIALOG channel.

◆ m_mockMediaPlayer

std::shared_ptr<MockMediaPlayer> alexaClientSDK::acsdkExternalMediaPlayer::test::ExternalMediaPlayerTest::m_mockMediaPlayer

Player to send the audio to.

◆ m_mockMessageSender

std::shared_ptr<MockMessageSender> alexaClientSDK::acsdkExternalMediaPlayer::test::ExternalMediaPlayerTest::m_mockMessageSender

A message sender used to send events to AVS.

◆ m_mockPlaybackRouter

std::shared_ptr<MockPlaybackRouter> alexaClientSDK::acsdkExternalMediaPlayer::test::ExternalMediaPlayerTest::m_mockPlaybackRouter

A playback router to notify when ExternalMediaPlayer becomes active.

◆ m_mockSpeakerInterface

std::shared_ptr<MockChannelVolumeInterface> alexaClientSDK::acsdkExternalMediaPlayer::test::ExternalMediaPlayerTest::m_mockSpeakerInterface

SpeakerInterface to manage volume changes of individual speakers.

◆ m_mockSpeakerManager

std::shared_ptr<MockSpeakerManager> alexaClientSDK::acsdkExternalMediaPlayer::test::ExternalMediaPlayerTest::m_mockSpeakerManager

SpeakerManager to manage volume changes across speakers.

◆ m_renderPlayerInfoCardsProviderRegistrar

std::shared_ptr<MockRenderPlayerInfoCardsProviderRegistrar> alexaClientSDK::acsdkExternalMediaPlayer::test::ExternalMediaPlayerTest::m_renderPlayerInfoCardsProviderRegistrar

Registrar for RenderPlayerInfoCardsProviders.

◆ m_shutdownNotifier

std::shared_ptr<acsdkShutdownManagerInterfaces::ShutdownNotifierInterface> alexaClientSDK::acsdkExternalMediaPlayer::test::ExternalMediaPlayerTest::m_shutdownNotifier

Object to notify the EMP when to shut down.

◆ m_startupNotifier

std::shared_ptr<acsdkStartupManagerInterfaces::StartupNotifierInterface> alexaClientSDK::acsdkExternalMediaPlayer::test::ExternalMediaPlayerTest::m_startupNotifier

Object to notify the EMP when to start up.

◆ m_wakeSetCompleteFuture

std::future<void> alexaClientSDK::acsdkExternalMediaPlayer::test::ExternalMediaPlayerTest::m_wakeSetCompleteFuture

Future to notify when directive handling is complete.

◆ m_wakeSetCompletePromise

std::promise<void> alexaClientSDK::acsdkExternalMediaPlayer::test::ExternalMediaPlayerTest::m_wakeSetCompletePromise

Promise to be fulfilled when directive handling is complete.

◆ m_wakeSetStateFuture

std::future<void> alexaClientSDK::acsdkExternalMediaPlayer::test::ExternalMediaPlayerTest::m_wakeSetStateFuture

Future to notify when setState is called.

◆ m_wakeSetStatePromise

std::promise<void> alexaClientSDK::acsdkExternalMediaPlayer::test::ExternalMediaPlayerTest::m_wakeSetStatePromise

Promise to be fulfilled when setState is called.


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

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