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

Mock class for ExternalMediaPlayerAdapterHandler. More...

#include <MockExternalMediaAdapterHandler.h>

Inheritance diagram for alexaClientSDK::acsdkExternalMediaPlayer::test::MockExternalMediaAdapterHandler:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::acsdkExternalMediaPlayer::test::MockExternalMediaAdapterHandler:
Collaboration graph
[legend]

Public Member Functions

 MOCK_METHOD1 (handleAuthorization, bool(const AuthorizedPlayerInfo &authorizedPlayer))
 
 MOCK_METHOD5 (handleLogin, bool(const std::string &localPlayerId, const std::string &accessToken, const std::string &userName, bool forceLogin, std::chrono::milliseconds tokenRefreshInterval))
 
 MOCK_METHOD1 (handleLogout, bool(const std::string &localPlayerId))
 
 MOCK_METHOD1 (handlePlay, bool(const PlayParams &params))
 
 MOCK_METHOD3 (handlePlayControl, bool(const std::string &localPlayerId, acsdkExternalMediaPlayerInterfaces::RequestType requestType, const std::string &playbackTarget))
 
 MOCK_METHOD2 (handleSeek, bool(const std::string &localPlayerId, std::chrono::milliseconds offset))
 
 MOCK_METHOD2 (handleAdjustSeek, bool(const std::string &localPlayerId, std::chrono::milliseconds deltaOffset))
 
 MOCK_METHOD2 (handleGetAdapterState, bool(const std::string &localPlayerId, acsdkExternalMediaPlayerInterfaces::AdapterState &state))
 
 MOCK_METHOD1 (handleSetVolume, void(int8_t volume))
 
 MOCK_METHOD1 (handleSetMute, void(bool mute))
 
void reportMockPlayers (const std::string &localPlayerId)
 
 MockExternalMediaAdapterHandler ()
 
- Public Member Functions inherited from alexaClientSDK::acsdkExternalMediaPlayer::ExternalMediaAdapterHandler
std::vector< acsdkExternalMediaPlayerInterfaces::PlayerInfoupdatePlayerInfo (const std::vector< acsdkExternalMediaPlayerInterfaces::PlayerInfo > &playerList) override
 
bool login (const std::string &localPlayerId, const std::string &accessToken, const std::string &userName, bool forceLogin, std::chrono::milliseconds tokenRefreshInterval) override
 
bool logout (const std::string &localPlayerId) override
 
bool play (const PlayParams &params) override
 
bool playControl (const std::string &localPlayerId, acsdkExternalMediaPlayerInterfaces::RequestType requestType, const std::string &playbackTarget) override
 
bool seek (const std::string &localPlayerId, std::chrono::milliseconds offset) override
 
bool adjustSeek (const std::string &localPlayerId, std::chrono::milliseconds deltaOffset) override
 
acsdkExternalMediaPlayerInterfaces::AdapterState getAdapterState (const std::string &localPlayerId) override
 
std::vector< acsdkExternalMediaPlayerInterfaces::AdapterStategetAdapterStates () override
 
std::chrono::milliseconds getOffset (const std::string &localPlayerId) override
 
void setExternalMediaPlayer (const std::shared_ptr< acsdkExternalMediaPlayerInterfaces::ExternalMediaPlayerInterface > externalMediaPlayer) override
 
void onSpeakerSettingsChanged (const Source &source, const avsCommon::sdkInterfaces::ChannelVolumeInterface::Type &type, const avsCommon::sdkInterfaces::SpeakerInterface::SpeakerSettings &settings) override
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::SpeakerManagerObserverInterface
virtual ~SpeakerManagerObserverInterface ()=default
 
- Public Member Functions inherited from alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface
 ExternalMediaAdapterHandlerInterface (const std::string &name)
 
virtual ~ExternalMediaAdapterHandlerInterface ()=default
 
virtual void setExternalMediaPlayer (const std::shared_ptr< ExternalMediaPlayerInterface > externalMediaPlayer)=0
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::utils::RequiresShutdown
 RequiresShutdown (const std::string &name)
 
virtual ~RequiresShutdown ()
 Destructor. More...
 
const std::string & name () const
 
void shutdown ()
 
bool isShutdown () const
 

Additional Inherited Members

- Public Types inherited from alexaClientSDK::avsCommon::sdkInterfaces::SpeakerManagerObserverInterface
enum  Source { Source::DIRECTIVE, Source::LOCAL_API, Source::EXTERNAL_CLIENT }
 Indicates whether the source of the call is from an AVS Directive or through a Local API call. More...
 
- Protected Member Functions inherited from alexaClientSDK::acsdkExternalMediaPlayer::ExternalMediaAdapterHandler
 ExternalMediaAdapterHandler (const std::string &name)
 
bool initializeAdapterHandler (std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::SpeakerManagerInterface > speakerManager)
 
bool validatePlayer (const std::string &localPlayerId, bool checkAuthorized=true)
 
std::string createExternalMediaPlayerEvent (const std::string &localPlayerId, const std::string &event, bool includePlaybackSessionId=false, std::function< void(rapidjson::Value::Object &, rapidjson::Value::AllocatorType &)> createPayload=[](rapidjson::Value::Object &v, rapidjson::Value::AllocatorType &a) {})
 
void reportDiscoveredPlayers (const std::vector< acsdkExternalMediaPlayerInterfaces::DiscoveredPlayerInfo > &discoveredPlayers)
 
bool removeDiscoveredPlayer (const std::string &localPlayerId)
 
virtual void doShutdown () override
 alexaClientSDK::avsCommon::utils::RequiresShutdown More...
 
virtual bool handleAuthorization (const AuthorizedPlayerInfo &authorizedPlayer)=0
 
virtual bool handleLogin (const std::string &localPlayerId, const std::string &accessToken, const std::string &userName, bool forceLogin, std::chrono::milliseconds tokenRefreshInterval)=0
 
virtual bool handleLogout (const std::string &localPlayerId)=0
 
virtual bool handlePlay (const ExternalMediaAdapterHandlerInterface::PlayParams &params)=0
 
virtual bool handlePlayControl (const std::string &localPlayerId, acsdkExternalMediaPlayerInterfaces::RequestType requestType, const std::string &playbackTarget)=0
 
virtual bool handleSeek (const std::string &localPlayerId, std::chrono::milliseconds offset)=0
 
virtual bool handleAdjustSeek (const std::string &localPlayerId, std::chrono::milliseconds deltaOffset)=0
 
virtual bool handleGetAdapterState (const std::string &localPlayerId, acsdkExternalMediaPlayerInterfaces::AdapterState &state)=0
 
virtual std::chrono::milliseconds handleGetOffset (const std::string &localPlayerId)
 
virtual void handleSetVolume (int8_t volume)=0
 
virtual void handleSetMute (bool mute)=0
 
- Protected Attributes inherited from alexaClientSDK::acsdkExternalMediaPlayer::ExternalMediaAdapterHandler
std::weak_ptr< acsdkExternalMediaPlayerInterfaces::ExternalMediaPlayerInterfacem_externalMediaPlayer
 The pointer to the external media player object. More...
 

Detailed Description

Mock class for ExternalMediaPlayerAdapterHandler.

Constructor & Destructor Documentation

◆ MockExternalMediaAdapterHandler()

alexaClientSDK::acsdkExternalMediaPlayer::test::MockExternalMediaAdapterHandler::MockExternalMediaAdapterHandler ( )

Member Function Documentation

◆ MOCK_METHOD1() [1/5]

alexaClientSDK::acsdkExternalMediaPlayer::test::MockExternalMediaAdapterHandler::MOCK_METHOD1 ( handleAuthorization  ,
bool(const AuthorizedPlayerInfo &authorizedPlayer)   
)

◆ MOCK_METHOD1() [2/5]

alexaClientSDK::acsdkExternalMediaPlayer::test::MockExternalMediaAdapterHandler::MOCK_METHOD1 ( handleLogout  ,
bool(const std::string &localPlayerId)   
)

◆ MOCK_METHOD1() [3/5]

alexaClientSDK::acsdkExternalMediaPlayer::test::MockExternalMediaAdapterHandler::MOCK_METHOD1 ( handlePlay  ,
bool(const PlayParams &params)   
)

◆ MOCK_METHOD1() [4/5]

alexaClientSDK::acsdkExternalMediaPlayer::test::MockExternalMediaAdapterHandler::MOCK_METHOD1 ( handleSetVolume  ,
void(int8_t volume)   
)

◆ MOCK_METHOD1() [5/5]

alexaClientSDK::acsdkExternalMediaPlayer::test::MockExternalMediaAdapterHandler::MOCK_METHOD1 ( handleSetMute  ,
void(bool mute)   
)

◆ MOCK_METHOD2() [1/3]

alexaClientSDK::acsdkExternalMediaPlayer::test::MockExternalMediaAdapterHandler::MOCK_METHOD2 ( handleSeek  ,
bool(const std::string &localPlayerId, std::chrono::milliseconds offset)   
)

◆ MOCK_METHOD2() [2/3]

alexaClientSDK::acsdkExternalMediaPlayer::test::MockExternalMediaAdapterHandler::MOCK_METHOD2 ( handleAdjustSeek  ,
bool(const std::string &localPlayerId, std::chrono::milliseconds deltaOffset)   
)

◆ MOCK_METHOD2() [3/3]

alexaClientSDK::acsdkExternalMediaPlayer::test::MockExternalMediaAdapterHandler::MOCK_METHOD2 ( handleGetAdapterState  ,
bool(const std::string &localPlayerId, acsdkExternalMediaPlayerInterfaces::AdapterState &state)   
)

◆ MOCK_METHOD3()

alexaClientSDK::acsdkExternalMediaPlayer::test::MockExternalMediaAdapterHandler::MOCK_METHOD3 ( handlePlayControl  ,
bool(const std::string &localPlayerId, acsdkExternalMediaPlayerInterfaces::RequestType requestType, const std::string &playbackTarget)   
)

◆ MOCK_METHOD5()

alexaClientSDK::acsdkExternalMediaPlayer::test::MockExternalMediaAdapterHandler::MOCK_METHOD5 ( handleLogin  ,
bool(const std::string &localPlayerId, const std::string &accessToken, const std::string &userName, bool forceLogin, std::chrono::milliseconds tokenRefreshInterval)   
)

◆ reportMockPlayers()

void alexaClientSDK::acsdkExternalMediaPlayer::test::MockExternalMediaAdapterHandler::reportMockPlayers ( const std::string &  localPlayerId)

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