alexaClientSDK::capabilityAgents::playbackController::ToggleCommand Class Reference

#include <PlaybackCommand.h>

Inheritance diagram for alexaClientSDK::capabilityAgents::playbackController::ToggleCommand:

Collaboration diagram for alexaClientSDK::capabilityAgents::playbackController::ToggleCommand:

Public Member Functions
	ToggleCommand (const std::string &name, bool action)
PlaybackCommand functions.
std::string	getEventName () const override
std::string	getEventPayload () const override
Public Member Functions inherited from alexaClientSDK::capabilityAgents::playbackController::PlaybackCommand
	PlaybackCommand (const std::string &name)
virtual	~PlaybackCommand ()=default

Additional Inherited Members
Static Public Member Functions inherited from alexaClientSDK::capabilityAgents::playbackController::PlaybackCommand
static const PlaybackCommand &	buttonToCommand (avsCommon::avs::PlaybackButton button)
static const PlaybackCommand &	toggleToCommand (avsCommon::avs::PlaybackToggle toggle, bool action)
Protected Attributes inherited from alexaClientSDK::capabilityAgents::playbackController::PlaybackCommand
const std::string	m_name
	The distinct AVS name of a command. More...

Detailed Description

This class represents a PlaybackController 1.1 interface ToggleCommandIssued.

Constructor & Destructor Documentation

ToggleCommand()

alexaClientSDK::capabilityAgents::playbackController::ToggleCommand::ToggleCommand	(	const std::string &	name,
		bool	action
	)

Constructor

Parameters

name	Command name.
action	The action for this command. @ true indicates the *_SELECT variant of a command, and @ false indicates the *_DESELECT variant.

Member Function Documentation

getEventName()

std::string alexaClientSDK::capabilityAgents::playbackController::ToggleCommand::getEventName ( ) const

overridevirtual

Get the event name associated with this command.

Returns

Event name.

Implements alexaClientSDK::capabilityAgents::playbackController::PlaybackCommand.

getEventPayload()

std::string alexaClientSDK::capabilityAgents::playbackController::ToggleCommand::getEventPayload ( ) const

overridevirtual

Get the Event's payload of this command

Returns

Event's payload

Implements alexaClientSDK::capabilityAgents::playbackController::PlaybackCommand.

---

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

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