alexaClientSDK::acsdkExternalMediaPlayer::StaticExternalMediaPlayerAdapterHandler Class Reference

#include <StaticExternalMediaPlayerAdapterHandler.h>

Inheritance diagram for alexaClientSDK::acsdkExternalMediaPlayer::StaticExternalMediaPlayerAdapterHandler:

Collaboration diagram for alexaClientSDK::acsdkExternalMediaPlayer::StaticExternalMediaPlayerAdapterHandler:

Public Member Functions
	StaticExternalMediaPlayerAdapterHandler ()
	Constructor. More...
	~StaticExternalMediaPlayerAdapterHandler () override=default
	Destructor. More...
void	addAdapter (const std::string &localPlayerId, std::shared_ptr< acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterInterface > adapter)
virtual void	doShutdown () override
	alexaClientSDK::avsCommon::utils::RequiresShutdown More...
std::vector< acsdkExternalMediaPlayerInterfaces::PlayerInfo >	updatePlayerInfo (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::AdapterState >	getAdapterStates () override
std::chrono::milliseconds	getOffset (const std::string &localPlayerId) override
void	setExternalMediaPlayer (const std::shared_ptr< acsdkExternalMediaPlayerInterfaces::ExternalMediaPlayerInterface > externalMediaPlayer) override
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

Constructor & Destructor Documentation

StaticExternalMediaPlayerAdapterHandler()

alexaClientSDK::acsdkExternalMediaPlayer::StaticExternalMediaPlayerAdapterHandler::StaticExternalMediaPlayerAdapterHandler

(

)

Constructor.

~StaticExternalMediaPlayerAdapterHandler()

alexaClientSDK::acsdkExternalMediaPlayer::StaticExternalMediaPlayerAdapterHandler::~StaticExternalMediaPlayerAdapterHandler ( )

overridedefault

Destructor.

Member Function Documentation

addAdapter()

void alexaClientSDK::acsdkExternalMediaPlayer::StaticExternalMediaPlayerAdapterHandler::addAdapter	(	const std::string &	localPlayerId,
		std::shared_ptr< acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterInterface >	adapter
	)

Adds an adapter implementing the ExternalMediaAdapterInterface to the list of adapters and associates it with the provided localPlayerId

Parameters

localPlayerId	the local player id
adapter	An adapter implementing ExternalMediaAdapterInterface

adjustSeek()

bool alexaClientSDK::acsdkExternalMediaPlayer::StaticExternalMediaPlayerAdapterHandler::adjustSeek ( const std::string &  localPlayerId, std::chrono::milliseconds  deltaOffset  )

overridevirtual

ExternalMediaPlayerAdapterHandlerInterface functions

Implements alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface.

doShutdown()

virtual void alexaClientSDK::acsdkExternalMediaPlayer::StaticExternalMediaPlayerAdapterHandler::doShutdown ( )

overridevirtual

alexaClientSDK::avsCommon::utils::RequiresShutdown

Implements alexaClientSDK::avsCommon::utils::RequiresShutdown.

getAdapterState()

acsdkExternalMediaPlayerInterfaces::AdapterState alexaClientSDK::acsdkExternalMediaPlayer::StaticExternalMediaPlayerAdapterHandler::getAdapterState ( const std::string &  localPlayerId )

overridevirtual

ExternalMediaPlayerAdapterHandlerInterface functions

Implements alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface.

getAdapterStates()

std::vector<acsdkExternalMediaPlayerInterfaces::AdapterState> alexaClientSDK::acsdkExternalMediaPlayer::StaticExternalMediaPlayerAdapterHandler::getAdapterStates ( )

overridevirtual

ExternalMediaPlayerAdapterHandlerInterface functions

Implements alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface.

getOffset()

std::chrono::milliseconds alexaClientSDK::acsdkExternalMediaPlayer::StaticExternalMediaPlayerAdapterHandler::getOffset ( const std::string &  localPlayerId )

overridevirtual

ExternalMediaPlayerAdapterHandlerInterface functions

Implements alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface.

login()

bool alexaClientSDK::acsdkExternalMediaPlayer::StaticExternalMediaPlayerAdapterHandler::login ( const std::string &  localPlayerId, const std::string &  accessToken, const std::string &  userName, bool  forceLogin, std::chrono::milliseconds  tokenRefreshInterval  )

overridevirtual

ExternalMediaPlayerAdapterHandlerInterface functions

Implements alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface.

logout()

bool alexaClientSDK::acsdkExternalMediaPlayer::StaticExternalMediaPlayerAdapterHandler::logout ( const std::string &  localPlayerId )

overridevirtual

ExternalMediaPlayerAdapterHandlerInterface functions

Implements alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface.

play()

bool alexaClientSDK::acsdkExternalMediaPlayer::StaticExternalMediaPlayerAdapterHandler::play ( const PlayParams &  params )

overridevirtual

ExternalMediaPlayerAdapterHandlerInterface functions

Implements alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface.

playControl()

bool alexaClientSDK::acsdkExternalMediaPlayer::StaticExternalMediaPlayerAdapterHandler::playControl ( const std::string &  localPlayerId, acsdkExternalMediaPlayerInterfaces::RequestType  requestType, const std::string &  playbackTarget  )

overridevirtual

ExternalMediaPlayerAdapterHandlerInterface functions

Implements alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface.

seek()

bool alexaClientSDK::acsdkExternalMediaPlayer::StaticExternalMediaPlayerAdapterHandler::seek ( const std::string &  localPlayerId, std::chrono::milliseconds  offset  )

overridevirtual

ExternalMediaPlayerAdapterHandlerInterface functions

Implements alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface.

setExternalMediaPlayer()

void alexaClientSDK::acsdkExternalMediaPlayer::StaticExternalMediaPlayerAdapterHandler::setExternalMediaPlayer ( const std::shared_ptr< acsdkExternalMediaPlayerInterfaces::ExternalMediaPlayerInterface >  externalMediaPlayer )

override

ExternalMediaPlayerAdapterHandlerInterface functions

updatePlayerInfo()

std::vector<acsdkExternalMediaPlayerInterfaces::PlayerInfo> alexaClientSDK::acsdkExternalMediaPlayer::StaticExternalMediaPlayerAdapterHandler::updatePlayerInfo ( const std::vector< acsdkExternalMediaPlayerInterfaces::PlayerInfo > &  playerList )

overridevirtual

ExternalMediaPlayerAdapterHandlerInterface functions

Implements alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface.

---

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

• /workplace/avs-device-sdk/capabilities/ExternalMediaPlayer/acsdkExternalMediaPlayer/include/acsdkExternalMediaPlayer/StaticExternalMediaPlayerAdapterHandler.h