#include <ExternalMediaPlayerInterface.h>

Inheritance diagram for alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaPlayerInterface:

Public Member Functions

virtual ~ExternalMediaPlayerInterface ()=default

virtual void setPlayerInFocus (const std::string &playerInFocus)=0

virtual void updateDiscoveredPlayers (const std::vector< DiscoveredPlayerInfo > &addedPlayers, const std::unordered_set< std::string > &removedLocalPlayerIds)=0

ExternalMediaAdapterHandlerInterface to the list of handlers being managed by the External

Adds a new Media Player Interface.

Parameters

adapterHandler The adapter handler to add

virtual void addAdapterHandler (std::shared_ptr< acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface > adapterHandler)=0

ExternalMediaAdapterHandlerInterface from the list of handlers being managed by the External

Removes an Media Player Interface

Parameters

adapterHandler The adapter handler to remove

virtual void removeAdapterHandler (std::shared_ptr< acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface > adapterHandler)=0

virtual void addObserver (const std::shared_ptr< acsdkExternalMediaPlayerInterfaces::ExternalMediaPlayerObserverInterface > observer)=0

virtual void removeObserver (const std::shared_ptr< acsdkExternalMediaPlayerInterfaces::ExternalMediaPlayerObserverInterface > observer)=0

Detailed Description

This class provides an interface to the ExternalMediaPlayer. Currently it provides an interface for adapters to set the player in focus when they acquire focus.

Constructor & Destructor Documentation

◆ ~ExternalMediaPlayerInterface()

virtual alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaPlayerInterface::~ExternalMediaPlayerInterface ( )

virtualdefault

Destructor

Member Function Documentation

◆ addAdapterHandler()

virtual void alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaPlayerInterface::addAdapterHandler ( std::shared_ptr< acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface > adapterHandler )

pure virtual

◆ addObserver()

virtual void alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaPlayerInterface::addObserver ( const std::shared_ptr< acsdkExternalMediaPlayerInterfaces::ExternalMediaPlayerObserverInterface > observer )

pure virtual

Adds an observer which will be notified on any observable state changes

Parameters

observer The observer to add

◆ removeAdapterHandler()

virtual void alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaPlayerInterface::removeAdapterHandler ( std::shared_ptr< acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface > adapterHandler )

pure virtual

Adds an observer which will be notified on any observable state changes

Parameters

observer The observer to add

◆ removeObserver()

virtual void alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaPlayerInterface::removeObserver ( const std::shared_ptr< acsdkExternalMediaPlayerInterfaces::ExternalMediaPlayerObserverInterface > observer )

pure virtual

Removes an observer from the list of active watchers

Parameters

observer The observer to remove

◆ setPlayerInFocus()

virtual void alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaPlayerInterface::setPlayerInFocus ( const std::string & playerInFocus )

pure virtual

Method to set which player is currently active and which should be the target for playback control by the ExternalMediaPlayer. This is not related to AFML focus.

Parameters

playerInFocus The business name of the adapter that has currently acquired focus.

Note: This function should not be called during the callback in ExternalMediaAdapterInterface.

Implemented in alexaClientSDK::acsdkExternalMediaPlayer::ExternalMediaPlayer.

◆ updateDiscoveredPlayers()

virtual void alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaPlayerInterface::updateDiscoveredPlayers	(	const std::vector< DiscoveredPlayerInfo > &	addedPlayers,
		const std::unordered_set< std::string > &	removedLocalPlayerIds
	)

pure virtual

Method used by External Media Player adapters to notify that a change has occurred to the discovered players

Parameters

addedPlayers	The players that have been added
removedPlayers	The players that have been removed

Implemented in alexaClientSDK::acsdkExternalMediaPlayer::ExternalMediaPlayer.

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

/workplace/avs-device-sdk/capabilities/ExternalMediaPlayer/acsdkExternalMediaPlayerInterfaces/include/acsdkExternalMediaPlayerInterfaces/ExternalMediaPlayerInterface.h