alexaClientSDK::sampleApplications::common::EndpointAlexaPlaybackControllerHandler Class Reference

#include <EndpointAlexaPlaybackControllerHandler.h>

Inheritance diagram for alexaClientSDK::sampleApplications::common::EndpointAlexaPlaybackControllerHandler:

Collaboration diagram for alexaClientSDK::sampleApplications::common::EndpointAlexaPlaybackControllerHandler:

Public Member Functions
AlexaPlaybackControllerInterface methods
acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerInterface::Response	play () override
acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerInterface::Response	pause () override
acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerInterface::Response	stop () override
acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerInterface::Response	startOver () override
acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerInterface::Response	previous () override
acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerInterface::Response	next () override
acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerInterface::Response	rewind () override
acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerInterface::Response	fastForward () override
acsdkAlexaPlaybackControllerInterfaces::PlaybackState	getPlaybackState () override
bool	addObserver (const std::weak_ptr< acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerObserverInterface > &observer) override
void	removeObserver (const std::weak_ptr< acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerObserverInterface > &observer) override
std::set< acsdkAlexaPlaybackControllerInterfaces::PlaybackOperation >	getSupportedOperations () override
Public Member Functions inherited from alexaClientSDK::acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerInterface
virtual	~AlexaPlaybackControllerInterface ()=default
virtual bool	addObserver (const std::weak_ptr< AlexaPlaybackControllerObserverInterface > &observer)=0
virtual void	removeObserver (const std::weak_ptr< AlexaPlaybackControllerObserverInterface > &observer)=0

Static Public Member Functions
static std::shared_ptr< EndpointAlexaPlaybackControllerHandler >	create (const std::string &endpointName, std::shared_ptr< EndpointFocusAdapter > focusAdapter)

Detailed Description

Sample implementation of an AlexaPlaybackControllerInterface.

Member Function Documentation

addObserver()

bool alexaClientSDK::sampleApplications::common::EndpointAlexaPlaybackControllerHandler::addObserver ( const std::weak_ptr< acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerObserverInterface > &  observer )

override

create()

static std::shared_ptr<EndpointAlexaPlaybackControllerHandler> alexaClientSDK::sampleApplications::common::EndpointAlexaPlaybackControllerHandler::create ( const std::string &  endpointName, std::shared_ptr< EndpointFocusAdapter >  focusAdapter  )

static

Create a AlexaPlaybackControllerHandler object.

Parameters

endpointName	The name of the endpoint.
focusAdapter	The EndpointFocusAdapter to manage focus.

Returns

A pointer to a new AlexaPlaybackControllerHandler object if it succeeds; otherwise, nullptr.

fastForward()

acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerInterface::Response alexaClientSDK::sampleApplications::common::EndpointAlexaPlaybackControllerHandler::fastForward ( )

overridevirtual

Execute fast forward operation for audtio or video content on the device

Returns

A AlexaPlaybackControllerResponse to indicate whether playback operation was successfully executed or encountered an error while executing.

Implements alexaClientSDK::acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerInterface.

getPlaybackState()

acsdkAlexaPlaybackControllerInterfaces::PlaybackState alexaClientSDK::sampleApplications::common::EndpointAlexaPlaybackControllerHandler::getPlaybackState ( )

overridevirtual

Get the current playback state of the device.

Returns

Return the current playback state for the audio or video content PlaybackState

Note

If AlexaPlaybackControllerInterface implementation has configured its instance's property as retrievable, this method should return the current launch target state. Unlike AlexaPlaybackControllerObserverInterface observer methods, this returns the current playback state at any given point when requested, with or without a change in playback state.

Implements alexaClientSDK::acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerInterface.

getSupportedOperations()

std::set<acsdkAlexaPlaybackControllerInterfaces::PlaybackOperation> alexaClientSDK::sampleApplications::common::EndpointAlexaPlaybackControllerHandler::getSupportedOperations ( )

overridevirtual

Returns all supported playback operations the device is expected to understand.

Returns

A PlaybackOperation set object that contains the supported playback operations. e.g. Play, Pause, Stop, StartOver, Previous, Next, Rewind, FastForward

Implements alexaClientSDK::acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerInterface.

next()

acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerInterface::Response alexaClientSDK::sampleApplications::common::EndpointAlexaPlaybackControllerHandler::next ( )

overridevirtual

Execute next operation for audio or video content on the device

Returns

A AlexaPlaybackControllerResponse to indicate whether playback operation was successfully executed or encountered an error while executing.

Implements alexaClientSDK::acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerInterface.

pause()

acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerInterface::Response alexaClientSDK::sampleApplications::common::EndpointAlexaPlaybackControllerHandler::pause ( )

overridevirtual

Execute pause operation for audio or video content on the device

Returns

A AlexaPlaybackControllerResponse to indicate whether playback operation was successfully executed or encountered an error while executing.

Implements alexaClientSDK::acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerInterface.

play()

acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerInterface::Response alexaClientSDK::sampleApplications::common::EndpointAlexaPlaybackControllerHandler::play ( )

overridevirtual

Execute play operation for audio or video content on the device

Returns

A AlexaPlaybackControllerResponse to indicate whether playback operation was successfully executed or encountered an error while executing.

Implements alexaClientSDK::acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerInterface.

previous()

acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerInterface::Response alexaClientSDK::sampleApplications::common::EndpointAlexaPlaybackControllerHandler::previous ( )

overridevirtual

Execute previous operation for audio or video content on the device

Returns

A AlexaPlaybackControllerResponse to indicate whether playback operation was successfully executed or encountered an error while executing.

Implements alexaClientSDK::acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerInterface.

removeObserver()

void alexaClientSDK::sampleApplications::common::EndpointAlexaPlaybackControllerHandler::removeObserver ( const std::weak_ptr< acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerObserverInterface > &  observer )

override

rewind()

acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerInterface::Response alexaClientSDK::sampleApplications::common::EndpointAlexaPlaybackControllerHandler::rewind ( )

overridevirtual

Execute rewind operation for audio or video content on the device

Returns

A AlexaPlaybackControllerResponse to indicate whether playback operation was successfully executed or encountered an error while executing.

Implements alexaClientSDK::acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerInterface.

startOver()

acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerInterface::Response alexaClientSDK::sampleApplications::common::EndpointAlexaPlaybackControllerHandler::startOver ( )

overridevirtual

Execute start over operation for audio or video content on the device

Returns

A AlexaPlaybackControllerResponse to indicate whether playback operation was successfully executed or encountered an error while executing.

Implements alexaClientSDK::acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerInterface.

stop()

acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerInterface::Response alexaClientSDK::sampleApplications::common::EndpointAlexaPlaybackControllerHandler::stop ( )

overridevirtual

Execute stop operation for audio or video content on the device

Returns

A AlexaPlaybackControllerResponse to indicate whether playback operation was successfully executed or encountered an error while executing.

Implements alexaClientSDK::acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerInterface.

---

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

• /workplace/avs-device-sdk/SampleApplications/Common/Endpoint/include/acsdk/Sample/Endpoint/EndpointAlexaPlaybackControllerHandler.h