alexaClientSDK::capabilityAgents::playbackController::PlaybackRouter Class Reference

#include <PlaybackRouter.h>

Inheritance diagram for alexaClientSDK::capabilityAgents::playbackController::PlaybackRouter:

Collaboration diagram for alexaClientSDK::capabilityAgents::playbackController::PlaybackRouter:

Public Member Functions
virtual	~PlaybackRouter ()=default
@c PlaybackRouterInterface functions.
virtual void	buttonPressed (avsCommon::avs::PlaybackButton button) override
virtual void	togglePressed (avsCommon::avs::PlaybackToggle toggle, bool action) override
virtual void	switchToDefaultHandler () override
virtual void	setHandler (std::shared_ptr< avsCommon::sdkInterfaces::PlaybackHandlerInterface > handler, std::shared_ptr< avsCommon::sdkInterfaces::LocalPlaybackHandlerInterface > localHandler=nullptr) override
virtual void	useDefaultHandlerWith (std::shared_ptr< avsCommon::sdkInterfaces::LocalPlaybackHandlerInterface > localHandler) override
virtual bool	localOperation (avsCommon::sdkInterfaces::LocalPlaybackHandlerInterface::PlaybackOperation op) override
virtual bool	localSeekTo (std::chrono::milliseconds location, bool fromStart) override
Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::PlaybackRouterInterface
virtual	~PlaybackRouterInterface ()=default
virtual void	setHandler (std::shared_ptr< PlaybackHandlerInterface > handler, std::shared_ptr< LocalPlaybackHandlerInterface > localHandler=nullptr)=0
virtual void	useDefaultHandlerWith (std::shared_ptr< LocalPlaybackHandlerInterface > localHandler)
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

Static Public Member Functions
static std::shared_ptr< PlaybackRouterInterface >	createPlaybackRouterInterface (std::shared_ptr< avsCommon::sdkInterfaces::PlaybackHandlerInterface > defaultHandler, std::shared_ptr< acsdkShutdownManagerInterfaces::ShutdownNotifierInterface > shutdownNotifier)
static std::shared_ptr< PlaybackRouter >	create (std::shared_ptr< avsCommon::sdkInterfaces::PlaybackHandlerInterface > defaultHandler)

Additional Inherited Members

Constructor & Destructor Documentation

~PlaybackRouter()

virtual alexaClientSDK::capabilityAgents::playbackController::PlaybackRouter::~PlaybackRouter ( )

virtualdefault

Destructor.

Member Function Documentation

buttonPressed()

virtual void alexaClientSDK::capabilityAgents::playbackController::PlaybackRouter::buttonPressed ( avsCommon::avs::PlaybackButton  button )

overridevirtual

This method can be called by the client when a Button is pressed on a physical button or on the GUI. A ButtonCommandIssued event message will be sent to the observer. NOTE: Instances may attempt to handle button locally first.

Parameters

button

The PlaybackButton type being pressed

Implements alexaClientSDK::avsCommon::sdkInterfaces::PlaybackRouterInterface.

create()

static std::shared_ptr<PlaybackRouter> alexaClientSDK::capabilityAgents::playbackController::PlaybackRouter::create ( std::shared_ptr< avsCommon::sdkInterfaces::PlaybackHandlerInterface >  defaultHandler )

static

Create an instance of @ PlaybackRouter.

Parameters

defaultHandler

The default playback handler.

Deprecated:

Use createPlaybackRouterInterface.

Returns

A std::shared_ptr to the new @ PlaybackRouter instance.

createPlaybackRouterInterface()

static std::shared_ptr<PlaybackRouterInterface> alexaClientSDK::capabilityAgents::playbackController::PlaybackRouter::createPlaybackRouterInterface ( std::shared_ptr< avsCommon::sdkInterfaces::PlaybackHandlerInterface >  defaultHandler, std::shared_ptr< acsdkShutdownManagerInterfaces::ShutdownNotifierInterface >  shutdownNotifier  )

static

Create an instance of @ PlaybackRouterInterface.

Parameters

defaultHandler	The default playback handler.
shutdownNotifier	The ShutdownNotifierInterface to notify this instance when to shut down.

Returns

A std::shared_ptr to the new @ PlaybackRouterInterface instance.

localOperation()

virtual bool alexaClientSDK::capabilityAgents::playbackController::PlaybackRouter::localOperation ( avsCommon::sdkInterfaces::LocalPlaybackHandlerInterface::PlaybackOperation  op )

overridevirtual

Request the handler to perform a local playback operation. NOTE: If local operation is not possable, Instances may fall back on ButtonPressed

Parameters

op	Operation to request

Returns

true if successful, false if the operation cannot be performed locally.

Reimplemented from alexaClientSDK::avsCommon::sdkInterfaces::PlaybackRouterInterface.

localSeekTo()

virtual bool alexaClientSDK::capabilityAgents::playbackController::PlaybackRouter::localSeekTo ( std::chrono::milliseconds  location, bool  fromStart  )

overridevirtual

Request the handler to perform a local seek operation.

Parameters

location	Position to seek to
fromStart	true to seek to absolute location, false to seek reletive to current location.

Returns

true if successful, false if the operation cannot be performed locally.

Reimplemented from alexaClientSDK::avsCommon::sdkInterfaces::PlaybackRouterInterface.

setHandler()

virtual void alexaClientSDK::capabilityAgents::playbackController::PlaybackRouter::setHandler ( std::shared_ptr< avsCommon::sdkInterfaces::PlaybackHandlerInterface >  handler, std::shared_ptr< avsCommon::sdkInterfaces::LocalPlaybackHandlerInterface >  localHandler = nullptr  )

overridevirtual

switchToDefaultHandler()

virtual void alexaClientSDK::capabilityAgents::playbackController::PlaybackRouter::switchToDefaultHandler ( )

overridevirtual

This method switches playback button pressess handling to the default handler.

Implements alexaClientSDK::avsCommon::sdkInterfaces::PlaybackRouterInterface.

togglePressed()

virtual void alexaClientSDK::capabilityAgents::playbackController::PlaybackRouter::togglePressed ( avsCommon::avs::PlaybackToggle  toggle, bool  action  )

overridevirtual

This method can be called by the client when a Toggle is pressed on a physical button or on the GUI. A ToggleCommandIssued event message will be sent to the observer.

Parameters

toggle	The PlaybackToggle type being pressed
action	The boolean action for the toggle state

Implements alexaClientSDK::avsCommon::sdkInterfaces::PlaybackRouterInterface.

useDefaultHandlerWith()

virtual void alexaClientSDK::capabilityAgents::playbackController::PlaybackRouter::useDefaultHandlerWith ( std::shared_ptr< avsCommon::sdkInterfaces::LocalPlaybackHandlerInterface >  localHandler )

overridevirtual

---

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

• /workplace/avs-device-sdk/CapabilityAgents/PlaybackController/include/PlaybackController/PlaybackRouter.h