alexaClientSDK::capabilityAgents::playbackController::PlaybackCommand Class Reference

#include <PlaybackCommand.h>

Inheritance diagram for alexaClientSDK::capabilityAgents::playbackController::PlaybackCommand:

Public Member Functions
	PlaybackCommand (const std::string &name)
virtual	~PlaybackCommand ()=default
virtual std::string	getEventName () const =0
virtual std::string	getEventPayload () const =0

Static Public Member Functions
static const PlaybackCommand &	buttonToCommand (avsCommon::avs::PlaybackButton button)
static const PlaybackCommand &	toggleToCommand (avsCommon::avs::PlaybackToggle toggle, bool action)

Protected Attributes
const std::string	m_name
	The distinct AVS name of a command. More...

Friends
std::ostream &	operator<< (std::ostream &, const PlaybackCommand &command)

Detailed Description

This class represents a specific PlaybackController interface command.

Constructor & Destructor Documentation

PlaybackCommand()

alexaClientSDK::capabilityAgents::playbackController::PlaybackCommand::PlaybackCommand

(

const std::string &

name

)

Constructor

Parameters

name	The distinguishing command name. It is either the event name(v1.0), or the payload name(v1.1).

~PlaybackCommand()

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

virtualdefault

Destructor.

Member Function Documentation

buttonToCommand()

static const PlaybackCommand& alexaClientSDK::capabilityAgents::playbackController::PlaybackCommand::buttonToCommand ( avsCommon::avs::PlaybackButton  button )

static

Convert a Button to a PlaybackCommand

Parameters

button

a Button

Returns

The matched PlaybackCommand

getEventName()

virtual std::string alexaClientSDK::capabilityAgents::playbackController::PlaybackCommand::getEventName ( ) const

pure virtual

Get the event name associated with this command.

Returns

Event name.

Implemented in alexaClientSDK::capabilityAgents::playbackController::ToggleCommand, alexaClientSDK::capabilityAgents::playbackController::ButtonCommand_v1_1, and alexaClientSDK::capabilityAgents::playbackController::ButtonCommand_v1_0.

getEventPayload()

virtual std::string alexaClientSDK::capabilityAgents::playbackController::PlaybackCommand::getEventPayload ( ) const

pure virtual

Get the Event's payload of this command

Returns

Event's payload

Implemented in alexaClientSDK::capabilityAgents::playbackController::ToggleCommand, alexaClientSDK::capabilityAgents::playbackController::ButtonCommand_v1_1, and alexaClientSDK::capabilityAgents::playbackController::ButtonCommand_v1_0.

toggleToCommand()

static const PlaybackCommand& alexaClientSDK::capabilityAgents::playbackController::PlaybackCommand::toggleToCommand ( avsCommon::avs::PlaybackToggle  toggle, bool  action  )

static

Convert a Toggle to a PlaybackCommand

Parameters

toggle

a Toggle

Returns

The matched PlaybackCommand

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  , const PlaybackCommand &  command  )

friend

Write a command value to an ostream as a string.

Parameters

stream	The stream to write the value to.
command	The PlaybackCommand value to write to the ostream as a string.

Returns

The ostream that was passed in and written to.

Member Data Documentation

m_name

const std::string alexaClientSDK::capabilityAgents::playbackController::PlaybackCommand::m_name

protected

The distinct AVS name of a command.

---

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

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