AlexaClientSDK  1.20.1
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Namespaces | Classes | Functions | Variables
alexaClientSDK::capabilityAgents::playbackController Namespace Reference

Namespaces

 test
 

Classes

class  ButtonCommand_v1_0
 
class  ButtonCommand_v1_1
 
class  PlaybackCommand
 
class  PlaybackController
 
class  PlaybackMessageRequest
 
class  PlaybackRouter
 
class  ToggleCommand
 

Functions

static const std::string TAG ("PlaybackCommand")
 String to identify log entries originating from this file. More...
 
std::ostream & operator<< (std::ostream &stream, const PlaybackCommand &command)
 
static const std::string TAG ("PlaybackController")
 String to identify log entries originating from this file. More...
 
static std::shared_ptr< CapabilityConfigurationgetPlaybackControllerCapabilityConfiguration ()
 
static const std::string TAG ("PlaybackRouter")
 String to identify log entries originating from this file. More...
 

Variables

static const std::string BUTTON_COMMAND_EVENT_NAME = "ButtonCommandIssued"
 
static const std::string TOGGLE_COMMAND_EVENT_NAME = "ToggleCommandIssued"
 
static const std::string PLAYBACK_TOGGLE_ACTION_SELECT = "SELECT"
 
static const std::string PLAYBACK_TOGGLE_ACTION_DESELECT = "DESELECT"
 
static const std::string PLAYBACK_TOGGLE_NAME_SHUFFLE = "SHUFFLE"
 
static const std::string PLAYBACK_TOGGLE_NAME_LOOP = "LOOP"
 
static const std::string PLAYBACK_TOGGLE_NAME_REPEAT = "REPEAT"
 
static const std::string PLAYBACK_TOGGLE_NAME_THUMBSUP = "THUMBSUP"
 
static const std::string PLAYBACK_TOGGLE_NAME_THUMBSDOWN = "THUMBSDOWN"
 
static const std::string PLAYBACK_NAME_UNKNOWN = "UNKNOWN"
 
static const std::string PLAYBACK_CONTROLLER_EVENT_NAME_KEY = "name"
 
static const std::string PLAYBACK_CONTROLLER_EVENT_ACTION_KEY = "action"
 
static const std::string JSON_EMPTY_PAYLOAD = "{}"
 
static const std::string JSON_BEGIN = "{\""
 
static const std::string JSON_COLON = "\": \""
 
static const std::string JSON_COMMA = "\", \""
 
static const std::string JSON_END = "\"}"
 
static const ButtonCommand_v1_0 g_playButton_v1_0 = ButtonCommand_v1_0("PlayCommandIssued")
 PlayCommandIssued event. More...
 
static const ButtonCommand_v1_0 g_pauseButton_v1_0 = ButtonCommand_v1_0("PauseCommandIssued")
 PauseCommandIssued event. More...
 
static const ButtonCommand_v1_0 g_nextButton_v1_0 = ButtonCommand_v1_0("NextCommandIssued")
 NextCommandIssued event. More...
 
static const ButtonCommand_v1_0 g_previousButton_v1_0 = ButtonCommand_v1_0("PreviousCommandIssued")
 PreviousCommandIssued event. More...
 
static const ButtonCommand_v1_1 g_skipForwardButton_v1_0 = ButtonCommand_v1_1("SKIPFORWARD")
 SKIPFORWARD command. More...
 
static const ButtonCommand_v1_1 g_skipBackwardButton_v1_0 = ButtonCommand_v1_1("SKIPBACKWARD")
 SKIPBACKWARD command. More...
 
static const ButtonCommand_v1_1 g_unknownButton_v1_0 = ButtonCommand_v1_1(PLAYBACK_NAME_UNKNOWN)
 Unknown command. More...
 
static const ToggleCommand g_shuffleSelectToggle = ToggleCommand(PLAYBACK_TOGGLE_NAME_SHUFFLE, true)
 SHUFFLE command with action = SELECT More...
 
static const ToggleCommand g_shuffleDeselectToggle = ToggleCommand(PLAYBACK_TOGGLE_NAME_SHUFFLE, false)
 SHUFFLE command with action = DESELECT More...
 
static const ToggleCommand g_loopSelectToggle = ToggleCommand(PLAYBACK_TOGGLE_NAME_LOOP, true)
 LOOP command with action = SELECT More...
 
static const ToggleCommand g_loopDeselectToggle = ToggleCommand(PLAYBACK_TOGGLE_NAME_LOOP, false)
 LOOP command with action = DESELECT More...
 
static const ToggleCommand g_repeatSelectToggle = ToggleCommand(PLAYBACK_TOGGLE_NAME_REPEAT, true)
 REPEAT command with action = SELECT More...
 
static const ToggleCommand g_repeatDeselectToggle = ToggleCommand(PLAYBACK_TOGGLE_NAME_REPEAT, false)
 REPEAT command with action = DESELECT More...
 
static const ToggleCommand g_thumbsUpSelectToggle = ToggleCommand(PLAYBACK_TOGGLE_NAME_THUMBSUP, true)
 THUMBSUP command with action = SELECT More...
 
static const ToggleCommand g_thumbsUpDeselectToggle = ToggleCommand(PLAYBACK_TOGGLE_NAME_THUMBSUP, false)
 THUMBSUP command with action = DESELECT More...
 
static const ToggleCommand g_thumbsDownSelectToggle = ToggleCommand(PLAYBACK_TOGGLE_NAME_THUMBSDOWN, true)
 THUMBSDOWN command with action = SELECT More...
 
static const ToggleCommand g_thumbsDownDeselectToggle = ToggleCommand(PLAYBACK_TOGGLE_NAME_THUMBSDOWN, false)
 THUMBSDOWN command with action = DESELECT More...
 
static const ToggleCommand g_unknownToggle = ToggleCommand(PLAYBACK_NAME_UNKNOWN, false)
 Unknown toggle. More...
 
static const std::string PLAYBACKCONTROLLER_CAPABILITY_INTERFACE_TYPE = "AlexaInterface"
 
static const std::string PLAYBACKCONTROLLER_CAPABILITY_INTERFACE_NAME = "PlaybackController"
 PlaybackController interface name. More...
 
static const std::string PLAYBACKCONTROLLER_CAPABILITY_INTERFACE_VERSION = "1.1"
 PlaybackController interface version. More...
 
static const std::string PLAYBACK_CONTROLLER_NAMESPACE = "PlaybackController"
 String to identify the AVS namespace of the event we send. More...
 

Function Documentation

◆ getPlaybackControllerCapabilityConfiguration()

std::shared_ptr< CapabilityConfiguration > alexaClientSDK::capabilityAgents::playbackController::getPlaybackControllerCapabilityConfiguration ( )
static

Creates the PlaybackController capability configuration.

Returns
The PlaybackController capability configuration.

◆ operator<<()

std::ostream& alexaClientSDK::capabilityAgents::playbackController::operator<< ( std::ostream &  stream,
const PlaybackCommand command 
)

Write a command value to an ostream as a string.

Parameters
streamThe stream to write the value to.
commandThe PlaybackCommand value to write to the ostream as a string.
Returns
The ostream that was passed in and written to.

◆ TAG() [1/3]

static const std::string alexaClientSDK::capabilityAgents::playbackController::TAG ( "PlaybackRouter"  )
static

String to identify log entries originating from this file.

◆ TAG() [2/3]

static const std::string alexaClientSDK::capabilityAgents::playbackController::TAG ( "PlaybackCommand"  )
static

String to identify log entries originating from this file.

◆ TAG() [3/3]

static const std::string alexaClientSDK::capabilityAgents::playbackController::TAG ( "PlaybackController"  )
static

String to identify log entries originating from this file.

Variable Documentation

◆ BUTTON_COMMAND_EVENT_NAME

const std::string alexaClientSDK::capabilityAgents::playbackController::BUTTON_COMMAND_EVENT_NAME = "ButtonCommandIssued"
static

◆ g_loopDeselectToggle

const ToggleCommand alexaClientSDK::capabilityAgents::playbackController::g_loopDeselectToggle = ToggleCommand(PLAYBACK_TOGGLE_NAME_LOOP, false)
static

LOOP command with action = DESELECT

◆ g_loopSelectToggle

const ToggleCommand alexaClientSDK::capabilityAgents::playbackController::g_loopSelectToggle = ToggleCommand(PLAYBACK_TOGGLE_NAME_LOOP, true)
static

LOOP command with action = SELECT

◆ g_nextButton_v1_0

const ButtonCommand_v1_0 alexaClientSDK::capabilityAgents::playbackController::g_nextButton_v1_0 = ButtonCommand_v1_0("NextCommandIssued")
static

NextCommandIssued event.

◆ g_pauseButton_v1_0

const ButtonCommand_v1_0 alexaClientSDK::capabilityAgents::playbackController::g_pauseButton_v1_0 = ButtonCommand_v1_0("PauseCommandIssued")
static

PauseCommandIssued event.

◆ g_playButton_v1_0

const ButtonCommand_v1_0 alexaClientSDK::capabilityAgents::playbackController::g_playButton_v1_0 = ButtonCommand_v1_0("PlayCommandIssued")
static

PlayCommandIssued event.

◆ g_previousButton_v1_0

const ButtonCommand_v1_0 alexaClientSDK::capabilityAgents::playbackController::g_previousButton_v1_0 = ButtonCommand_v1_0("PreviousCommandIssued")
static

PreviousCommandIssued event.

◆ g_repeatDeselectToggle

const ToggleCommand alexaClientSDK::capabilityAgents::playbackController::g_repeatDeselectToggle = ToggleCommand(PLAYBACK_TOGGLE_NAME_REPEAT, false)
static

REPEAT command with action = DESELECT

◆ g_repeatSelectToggle

const ToggleCommand alexaClientSDK::capabilityAgents::playbackController::g_repeatSelectToggle = ToggleCommand(PLAYBACK_TOGGLE_NAME_REPEAT, true)
static

REPEAT command with action = SELECT

◆ g_shuffleDeselectToggle

const ToggleCommand alexaClientSDK::capabilityAgents::playbackController::g_shuffleDeselectToggle = ToggleCommand(PLAYBACK_TOGGLE_NAME_SHUFFLE, false)
static

SHUFFLE command with action = DESELECT

◆ g_shuffleSelectToggle

const ToggleCommand alexaClientSDK::capabilityAgents::playbackController::g_shuffleSelectToggle = ToggleCommand(PLAYBACK_TOGGLE_NAME_SHUFFLE, true)
static

SHUFFLE command with action = SELECT

◆ g_skipBackwardButton_v1_0

const ButtonCommand_v1_1 alexaClientSDK::capabilityAgents::playbackController::g_skipBackwardButton_v1_0 = ButtonCommand_v1_1("SKIPBACKWARD")
static

SKIPBACKWARD command.

◆ g_skipForwardButton_v1_0

const ButtonCommand_v1_1 alexaClientSDK::capabilityAgents::playbackController::g_skipForwardButton_v1_0 = ButtonCommand_v1_1("SKIPFORWARD")
static

SKIPFORWARD command.

◆ g_thumbsDownDeselectToggle

const ToggleCommand alexaClientSDK::capabilityAgents::playbackController::g_thumbsDownDeselectToggle = ToggleCommand(PLAYBACK_TOGGLE_NAME_THUMBSDOWN, false)
static

THUMBSDOWN command with action = DESELECT

◆ g_thumbsDownSelectToggle

const ToggleCommand alexaClientSDK::capabilityAgents::playbackController::g_thumbsDownSelectToggle = ToggleCommand(PLAYBACK_TOGGLE_NAME_THUMBSDOWN, true)
static

THUMBSDOWN command with action = SELECT

◆ g_thumbsUpDeselectToggle

const ToggleCommand alexaClientSDK::capabilityAgents::playbackController::g_thumbsUpDeselectToggle = ToggleCommand(PLAYBACK_TOGGLE_NAME_THUMBSUP, false)
static

THUMBSUP command with action = DESELECT

◆ g_thumbsUpSelectToggle

const ToggleCommand alexaClientSDK::capabilityAgents::playbackController::g_thumbsUpSelectToggle = ToggleCommand(PLAYBACK_TOGGLE_NAME_THUMBSUP, true)
static

THUMBSUP command with action = SELECT

◆ g_unknownButton_v1_0

const ButtonCommand_v1_1 alexaClientSDK::capabilityAgents::playbackController::g_unknownButton_v1_0 = ButtonCommand_v1_1(PLAYBACK_NAME_UNKNOWN)
static

Unknown command.

◆ g_unknownToggle

const ToggleCommand alexaClientSDK::capabilityAgents::playbackController::g_unknownToggle = ToggleCommand(PLAYBACK_NAME_UNKNOWN, false)
static

Unknown toggle.

◆ JSON_BEGIN

const std::string alexaClientSDK::capabilityAgents::playbackController::JSON_BEGIN = "{\""
static

◆ JSON_COLON

const std::string alexaClientSDK::capabilityAgents::playbackController::JSON_COLON = "\": \""
static

◆ JSON_COMMA

const std::string alexaClientSDK::capabilityAgents::playbackController::JSON_COMMA = "\", \""
static

◆ JSON_EMPTY_PAYLOAD

const std::string alexaClientSDK::capabilityAgents::playbackController::JSON_EMPTY_PAYLOAD = "{}"
static

◆ JSON_END

const std::string alexaClientSDK::capabilityAgents::playbackController::JSON_END = "\"}"
static

◆ PLAYBACK_CONTROLLER_EVENT_ACTION_KEY

const std::string alexaClientSDK::capabilityAgents::playbackController::PLAYBACK_CONTROLLER_EVENT_ACTION_KEY = "action"
static

◆ PLAYBACK_CONTROLLER_EVENT_NAME_KEY

const std::string alexaClientSDK::capabilityAgents::playbackController::PLAYBACK_CONTROLLER_EVENT_NAME_KEY = "name"
static

◆ PLAYBACK_CONTROLLER_NAMESPACE

const std::string alexaClientSDK::capabilityAgents::playbackController::PLAYBACK_CONTROLLER_NAMESPACE = "PlaybackController"
static

String to identify the AVS namespace of the event we send.

◆ PLAYBACK_NAME_UNKNOWN

const std::string alexaClientSDK::capabilityAgents::playbackController::PLAYBACK_NAME_UNKNOWN = "UNKNOWN"
static

◆ PLAYBACK_TOGGLE_ACTION_DESELECT

const std::string alexaClientSDK::capabilityAgents::playbackController::PLAYBACK_TOGGLE_ACTION_DESELECT = "DESELECT"
static

◆ PLAYBACK_TOGGLE_ACTION_SELECT

const std::string alexaClientSDK::capabilityAgents::playbackController::PLAYBACK_TOGGLE_ACTION_SELECT = "SELECT"
static

◆ PLAYBACK_TOGGLE_NAME_LOOP

const std::string alexaClientSDK::capabilityAgents::playbackController::PLAYBACK_TOGGLE_NAME_LOOP = "LOOP"
static

◆ PLAYBACK_TOGGLE_NAME_REPEAT

const std::string alexaClientSDK::capabilityAgents::playbackController::PLAYBACK_TOGGLE_NAME_REPEAT = "REPEAT"
static

◆ PLAYBACK_TOGGLE_NAME_SHUFFLE

const std::string alexaClientSDK::capabilityAgents::playbackController::PLAYBACK_TOGGLE_NAME_SHUFFLE = "SHUFFLE"
static

◆ PLAYBACK_TOGGLE_NAME_THUMBSDOWN

const std::string alexaClientSDK::capabilityAgents::playbackController::PLAYBACK_TOGGLE_NAME_THUMBSDOWN = "THUMBSDOWN"
static

◆ PLAYBACK_TOGGLE_NAME_THUMBSUP

const std::string alexaClientSDK::capabilityAgents::playbackController::PLAYBACK_TOGGLE_NAME_THUMBSUP = "THUMBSUP"
static

◆ PLAYBACKCONTROLLER_CAPABILITY_INTERFACE_NAME

const std::string alexaClientSDK::capabilityAgents::playbackController::PLAYBACKCONTROLLER_CAPABILITY_INTERFACE_NAME = "PlaybackController"
static

PlaybackController interface name.

◆ PLAYBACKCONTROLLER_CAPABILITY_INTERFACE_TYPE

const std::string alexaClientSDK::capabilityAgents::playbackController::PLAYBACKCONTROLLER_CAPABILITY_INTERFACE_TYPE = "AlexaInterface"
static

PlaybackController capability constants PlaybackController interface type

◆ PLAYBACKCONTROLLER_CAPABILITY_INTERFACE_VERSION

const std::string alexaClientSDK::capabilityAgents::playbackController::PLAYBACKCONTROLLER_CAPABILITY_INTERFACE_VERSION = "1.1"
static

PlaybackController interface version.

◆ TOGGLE_COMMAND_EVENT_NAME

const std::string alexaClientSDK::capabilityAgents::playbackController::TOGGLE_COMMAND_EVENT_NAME = "ToggleCommandIssued"
static

AlexaClientSDK 1.20.1 - Copyright 2016-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0