Namespaces
	test

Classes
class	AuthorizedSender

class	ExternalMediaPlayer

Functions
static const std::string	TAG ("AuthorizedSender")
	String to identify log entries originating from this file. More...

static const std::string	TAG ("ExternalMediaPlayer")
	String to identify log entries originating from this file. More...

static const std::string	EMP_CONFIG_KEY ("externalMediaPlayer")
	The root key for configuration values for the ExternalMediaPlayer. More...

static const std::string	EMP_AGENT_KEY ("agentString")
	Key for the `agent` id string unter the `EMP_CONFIG_KEY` configuration node. More...

static void	submitMetric (const std::shared_ptr< MetricRecorderInterface > &metricRecorder, const std::string metricName, const DataPoint &dataPoint, const std::string &msgId, const std::string &trackId, const std::string &playerId)

static std::shared_ptr< avsCommon::avs::CapabilityConfiguration >	getExternalMediaPlayerCapabilityConfiguration ()

static std::shared_ptr< CapabilityConfiguration >	generateCapabilityConfiguration (const std::string &type, const std::string &interfaceName, const std::string &version)

Variables
static const std::string	EVENT_KEY = "event"
	The event key. More...

static const std::string	HEADER_KEY = "header"
	The header key. More...

static const std::string	PAYLOAD_KEY = "payload"
	The payload key. More...

static const std::string	PLAYER_ID_KEY = "playerId"
	The playerId key. More...

static const std::string	EXTERNALMEDIAPLAYER_STATE_NAMESPACE = "ExternalMediaPlayer"

static const std::string	PLAYBACKSTATEREPORTER_STATE_NAMESPACE = "Alexa.PlaybackStateReporter"

static const std::string	EXTERNALMEDIAPLAYER_NAME = "ExternalMediaPlayerState"

static const std::string	PLAYBACKSTATEREPORTER_NAME = "playbackState"

static const std::string	EXTERNALMEDIAPLAYER_NAMESPACE = "ExternalMediaPlayer"

static const std::string	PLAYBACKCONTROLLER_NAMESPACE = "Alexa.PlaybackController"

static const std::string	PLAYLISTCONTROLLER_NAMESPACE = "Alexa.PlaylistController"

static const std::string	SEEKCONTROLLER_NAMESPACE = "Alexa.SeekController"

static const std::string	FAVORITESCONTROLLER_NAMESPACE = "Alexa.FavoritesController"

static const std::string	ALEXA_INTERFACE_TYPE = "AlexaInterface"
	The AlexaInterface constant type. More...

static const std::string	EXTERNALMEDIAPLAYER_CAPABILITY_INTERFACE_TYPE = ALEXA_INTERFACE_TYPE

static const std::string	EXTERNALMEDIAPLAYER_CAPABILITY_INTERFACE_NAME = "ExternalMediaPlayer"
	ExternalMediaPlayer interface name. More...

static const std::string	EXTERNALMEDIAPLAYER_CAPABILITY_INTERFACE_VERSION = "1.2"
	ExternalMediaPlayer interface version. More...

static const std::string	PLAYBACKSTATEREPORTER_CAPABILITY_INTERFACE_NAME = PLAYBACKSTATEREPORTER_STATE_NAMESPACE
	Alexa.PlaybackStateReporter name. More...

static const std::string	PLAYBACKSTATEREPORTER_CAPABILITY_INTERFACE_VERSION = "1.0"
	Alexa.PlaybackStateReporter version. More...

static const std::string	PLAYBACKCONTROLLER_CAPABILITY_INTERFACE_NAME = PLAYBACKCONTROLLER_NAMESPACE
	Alexa.PlaybackController name. More...

static const std::string	PLAYBACKCONTROLLER_CAPABILITY_INTERFACE_VERSION = "1.0"
	Alexa.PlaybackController version. More...

static const std::string	PLAYLISTCONTROLLER_CAPABILITY_INTERFACE_NAME = PLAYLISTCONTROLLER_NAMESPACE
	Alexa.PlaylistController name. More...

static const std::string	PLAYLISTCONTROLLER_CAPABILITY_INTERFACE_VERSION = "1.0"
	Alexa.PlaylistController version. More...

static const std::string	SEEKCONTROLLER_CAPABILITY_INTERFACE_NAME = SEEKCONTROLLER_NAMESPACE
	Alexa.SeekController name. More...

static const std::string	SEEKCONTROLLER_CAPABILITY_INTERFACE_VERSION = "1.0"
	Alexa.SeekController version. More...

static const std::string	FAVORITESCONTROLLER_CAPABILITY_INTERFACE_NAME = FAVORITESCONTROLLER_NAMESPACE
	Alexa.FavoritesController name. More...

static const std::string	FAVORITESCONTROLLER_CAPABILITY_INTERFACE_VERSION = "1.0"
	Alexa.FavoritesController version. More...

static const NamespaceAndName	PLAY_DIRECTIVE {EXTERNALMEDIAPLAYER_NAMESPACE, "Play"}

static const NamespaceAndName	LOGIN_DIRECTIVE {EXTERNALMEDIAPLAYER_NAMESPACE, "Login"}

static const NamespaceAndName	LOGOUT_DIRECTIVE {EXTERNALMEDIAPLAYER_NAMESPACE, "Logout"}

static const NamespaceAndName	AUTHORIZEDISCOVEREDPLAYERS_DIRECTIVE

static const NamespaceAndName	RESUME_DIRECTIVE {PLAYBACKCONTROLLER_NAMESPACE, "Play"}

static const NamespaceAndName	PAUSE_DIRECTIVE {PLAYBACKCONTROLLER_NAMESPACE, "Pause"}

static const NamespaceAndName	STOP_DIRECTIVE {PLAYBACKCONTROLLER_NAMESPACE, "Stop"}

static const NamespaceAndName	NEXT_DIRECTIVE {PLAYBACKCONTROLLER_NAMESPACE, "Next"}

static const NamespaceAndName	PREVIOUS_DIRECTIVE {PLAYBACKCONTROLLER_NAMESPACE, "Previous"}

static const NamespaceAndName	STARTOVER_DIRECTIVE {PLAYBACKCONTROLLER_NAMESPACE, "StartOver"}

static const NamespaceAndName	REWIND_DIRECTIVE {PLAYBACKCONTROLLER_NAMESPACE, "Rewind"}

static const NamespaceAndName	FASTFORWARD_DIRECTIVE {PLAYBACKCONTROLLER_NAMESPACE, "FastForward"}

static const NamespaceAndName	ENABLEREPEATONE_DIRECTIVE {PLAYLISTCONTROLLER_NAMESPACE, "EnableRepeatOne"}

static const NamespaceAndName	ENABLEREPEAT_DIRECTIVE {PLAYLISTCONTROLLER_NAMESPACE, "EnableRepeat"}

static const NamespaceAndName	DISABLEREPEAT_DIRECTIVE {PLAYLISTCONTROLLER_NAMESPACE, "DisableRepeat"}

static const NamespaceAndName	ENABLESHUFFLE_DIRECTIVE {PLAYLISTCONTROLLER_NAMESPACE, "EnableShuffle"}

static const NamespaceAndName	DISABLESHUFFLE_DIRECTIVE {PLAYLISTCONTROLLER_NAMESPACE, "DisableShuffle"}

static const NamespaceAndName	SEEK_DIRECTIVE {SEEKCONTROLLER_NAMESPACE, "SetSeekPosition"}

static const NamespaceAndName	ADJUSTSEEK_DIRECTIVE {SEEKCONTROLLER_NAMESPACE, "AdjustSeekPosition"}

static const NamespaceAndName	FAVORITE_DIRECTIVE {FAVORITESCONTROLLER_NAMESPACE, "Favorite"}

static const NamespaceAndName	UNFAVORITE_DIRECTIVE {FAVORITESCONTROLLER_NAMESPACE, "Unfavorite"}

static const NamespaceAndName	SESSION_STATE {EXTERNALMEDIAPLAYER_STATE_NAMESPACE, EXTERNALMEDIAPLAYER_NAME}

static const NamespaceAndName	PLAYBACK_STATE {PLAYBACKSTATEREPORTER_STATE_NAMESPACE, PLAYBACKSTATEREPORTER_NAME}

static const char	PLAYERS [] = "players"
	The const char for the players key field in the context. More...

static const char	PLAYER_IN_FOCUS [] = "playerInFocus"
	The const char for the playerInFocus key field in the context. More...

static const int64_t	MAX_PAST_OFFSET = -86400000
	The max relative time in the past that we can seek to in milliseconds(-12hours in ms). More...

static const int64_t	MAX_FUTURE_OFFSET = 86400000
	The max relative time in the past that we can seek to in milliseconds(+12 hours in ms). More...

static const char	AGENT_KEY [] = "agent"
	The agent key. More...

static const char	AUTHORIZED [] = "authorized"
	The authorized key. More...

static const char	DEAUTHORIZED [] = "deauthorized"
	The deauthorized key. More...

static const char	LOCAL_PLAYER_ID [] = "localPlayerId"
	The localPlayerId key. More...

static const char	METADATA [] = "metadata"
	The metadata key. More...

static const char	SPI_VERSION_KEY [] = "spiVersion"
	The spiVersion key. More...

static const char	VALIDATION_METHOD [] = "validationMethod"
	The validationMethod key. More...

static const char	VALIDATION_DATA [] = "validationData"
	The validationData key. More...

static const char	REPORT_DISCOVERED_PLAYERS [] = "ReportDiscoveredPlayers"
	The ReportDiscoveredPlayers Event key. More...

static const char	AUTHORIZATION_COMPLETE [] = "AuthorizationComplete"
	The AuthorizationComplete Event key. More...

static const std::string	AUDIO_PLAYER_METRIC_PREFIX = "AUDIO_PLAYER-"
	Metric name prefix for AudioPlayer metric source. More...

static const std::string	PLAY_DIRECTIVE_RECEIVED = "PLAY_DIRECTIVE_RECEIVED"
	The directive received metric is used in place of 'first bytes' for UPL because pre-buffering may distort the metric. More...

static const std::string	STOP_DIRECTIVE_RECEIVED = "STOP_DIRECTIVE_RECEIVED"
	The directive received metric is used in place of 'first bytes' for Stop UPL because there are no bytes involved. More...

auto	audioNonBlockingPolicy = BlockingPolicy(BlockingPolicy::MEDIUM_AUDIO, false)

auto	neitherNonBlockingPolicy = BlockingPolicy(BlockingPolicy::MEDIUMS_NONE, false)

static DirectiveHandlerConfiguration	g_configuration

static std::unordered_map< PlaybackButton, RequestType >	g_buttonToRequestType

static std::unordered_map< PlaybackToggle, std::pair< RequestType, RequestType > >	g_toggleToRequestType

Function Documentation

◆ EMP_AGENT_KEY()

static const std::string alexaClientSDK::capabilityAgents::externalMediaPlayer::EMP_AGENT_KEY ( "agentString" )

static

Key for the agent id string unter the EMP_CONFIG_KEY configuration node.

◆ EMP_CONFIG_KEY()

static const std::string alexaClientSDK::capabilityAgents::externalMediaPlayer::EMP_CONFIG_KEY ( "externalMediaPlayer" )

static

The root key for configuration values for the ExternalMediaPlayer.

◆ generateCapabilityConfiguration()

static std::shared_ptr<CapabilityConfiguration> alexaClientSDK::capabilityAgents::externalMediaPlayer::generateCapabilityConfiguration	(	const std::string &	type,
		const std::string &	interfaceName,
		const std::string &	version
	)

static

Generate a CapabilityConfiguration object.

Parameters

type	The Capability interface type.
interfaceName	The Capability interface name.
version	The Capability interface verison.

◆ getExternalMediaPlayerCapabilityConfiguration()

std::shared_ptr< CapabilityConfiguration > alexaClientSDK::capabilityAgents::externalMediaPlayer::getExternalMediaPlayerCapabilityConfiguration ( )

static

Creates the ExternalMediaPlayer capability configuration.

Returns: The ExternalMediaPlayer capability configuration.

◆ submitMetric()

static void alexaClientSDK::capabilityAgents::externalMediaPlayer::submitMetric	(	const std::shared_ptr< MetricRecorderInterface > &	metricRecorder,
		const std::string	metricName,
		const DataPoint &	dataPoint,
		const std::string &	msgId,
		const std::string &	trackId,
		const std::string &	playerId
	)

static

Handles a Metric event by creating and recording it. Failure to create or record the event results in an early return.

Parameters

metricRecorder	The `MetricRecorderInterface` which records Metric events.
metricName	The name of the Metric event.
dataPoint	The `DataPoint` of this Metric event (e.g. duration).
msgId	The message id string from the retrieved from the directive.
trackId	The track id string from the retrieved from the directive.
playerId	The player id string from the retrieved from the directive.

◆ TAG() [1/2]

static const std::string alexaClientSDK::capabilityAgents::externalMediaPlayer::TAG ( "AuthorizedSender" )

static

String to identify log entries originating from this file.

◆ TAG() [2/2]

static const std::string alexaClientSDK::capabilityAgents::externalMediaPlayer::TAG ( "ExternalMediaPlayer" )

static

String to identify log entries originating from this file.

Variable Documentation

◆ ADJUSTSEEK_DIRECTIVE

const NamespaceAndName alexaClientSDK::capabilityAgents::externalMediaPlayer::ADJUSTSEEK_DIRECTIVE {SEEKCONTROLLER_NAMESPACE, "AdjustSeekPosition"}

static

◆ AGENT_KEY

const char alexaClientSDK::capabilityAgents::externalMediaPlayer::AGENT_KEY[] = "agent"

static

The agent key.

◆ ALEXA_INTERFACE_TYPE

const std::string alexaClientSDK::capabilityAgents::externalMediaPlayer::ALEXA_INTERFACE_TYPE = "AlexaInterface"

static

The AlexaInterface constant type.

◆ AUDIO_PLAYER_METRIC_PREFIX

const std::string alexaClientSDK::capabilityAgents::externalMediaPlayer::AUDIO_PLAYER_METRIC_PREFIX = "AUDIO_PLAYER-"

static

Metric name prefix for AudioPlayer metric source.

◆ audioNonBlockingPolicy

auto alexaClientSDK::capabilityAgents::externalMediaPlayer::audioNonBlockingPolicy = BlockingPolicy(BlockingPolicy::MEDIUM_AUDIO, false)

◆ AUTHORIZATION_COMPLETE

const char alexaClientSDK::capabilityAgents::externalMediaPlayer::AUTHORIZATION_COMPLETE[] = "AuthorizationComplete"

static

The AuthorizationComplete Event key.

◆ AUTHORIZED

const char alexaClientSDK::capabilityAgents::externalMediaPlayer::AUTHORIZED[] = "authorized"

static

The authorized key.

◆ AUTHORIZEDISCOVEREDPLAYERS_DIRECTIVE

const NamespaceAndName alexaClientSDK::capabilityAgents::externalMediaPlayer::AUTHORIZEDISCOVEREDPLAYERS_DIRECTIVE

static

Initial value:

{EXTERNALMEDIAPLAYER_NAMESPACE,

"AuthorizeDiscoveredPlayers"}

alexaClientSDK::capabilityAgents::externalMediaPlayer::EXTERNALMEDIAPLAYER_NAMESPACE

static const std::string EXTERNALMEDIAPLAYER_NAMESPACE

Definition: ExternalMediaPlayer.cpp:75

◆ DEAUTHORIZED

const char alexaClientSDK::capabilityAgents::externalMediaPlayer::DEAUTHORIZED[] = "deauthorized"

static

The deauthorized key.

◆ DISABLEREPEAT_DIRECTIVE

const NamespaceAndName alexaClientSDK::capabilityAgents::externalMediaPlayer::DISABLEREPEAT_DIRECTIVE {PLAYLISTCONTROLLER_NAMESPACE, "DisableRepeat"}

static

◆ DISABLESHUFFLE_DIRECTIVE

const NamespaceAndName alexaClientSDK::capabilityAgents::externalMediaPlayer::DISABLESHUFFLE_DIRECTIVE {PLAYLISTCONTROLLER_NAMESPACE, "DisableShuffle"}

static

◆ ENABLEREPEAT_DIRECTIVE

const NamespaceAndName alexaClientSDK::capabilityAgents::externalMediaPlayer::ENABLEREPEAT_DIRECTIVE {PLAYLISTCONTROLLER_NAMESPACE, "EnableRepeat"}

static

◆ ENABLEREPEATONE_DIRECTIVE

const NamespaceAndName alexaClientSDK::capabilityAgents::externalMediaPlayer::ENABLEREPEATONE_DIRECTIVE {PLAYLISTCONTROLLER_NAMESPACE, "EnableRepeatOne"}

static

◆ ENABLESHUFFLE_DIRECTIVE

const NamespaceAndName alexaClientSDK::capabilityAgents::externalMediaPlayer::ENABLESHUFFLE_DIRECTIVE {PLAYLISTCONTROLLER_NAMESPACE, "EnableShuffle"}

static

◆ EVENT_KEY

const std::string alexaClientSDK::capabilityAgents::externalMediaPlayer::EVENT_KEY = "event"

static

The event key.

◆ EXTERNALMEDIAPLAYER_CAPABILITY_INTERFACE_NAME

const std::string alexaClientSDK::capabilityAgents::externalMediaPlayer::EXTERNALMEDIAPLAYER_CAPABILITY_INTERFACE_NAME = "ExternalMediaPlayer"

static

ExternalMediaPlayer interface name.

◆ EXTERNALMEDIAPLAYER_CAPABILITY_INTERFACE_TYPE

const std::string alexaClientSDK::capabilityAgents::externalMediaPlayer::EXTERNALMEDIAPLAYER_CAPABILITY_INTERFACE_TYPE = ALEXA_INTERFACE_TYPE

static

ExternalMediaPlayer capability constants ExternalMediaPlayer interface type

◆ EXTERNALMEDIAPLAYER_CAPABILITY_INTERFACE_VERSION

const std::string alexaClientSDK::capabilityAgents::externalMediaPlayer::EXTERNALMEDIAPLAYER_CAPABILITY_INTERFACE_VERSION = "1.2"

static

ExternalMediaPlayer interface version.

◆ EXTERNALMEDIAPLAYER_NAME

const std::string alexaClientSDK::capabilityAgents::externalMediaPlayer::EXTERNALMEDIAPLAYER_NAME = "ExternalMediaPlayerState"

static

◆ EXTERNALMEDIAPLAYER_NAMESPACE

const std::string alexaClientSDK::capabilityAgents::externalMediaPlayer::EXTERNALMEDIAPLAYER_NAMESPACE = "ExternalMediaPlayer"

static

◆ EXTERNALMEDIAPLAYER_STATE_NAMESPACE

const std::string alexaClientSDK::capabilityAgents::externalMediaPlayer::EXTERNALMEDIAPLAYER_STATE_NAMESPACE = "ExternalMediaPlayer"

static

◆ FASTFORWARD_DIRECTIVE

const NamespaceAndName alexaClientSDK::capabilityAgents::externalMediaPlayer::FASTFORWARD_DIRECTIVE {PLAYBACKCONTROLLER_NAMESPACE, "FastForward"}

static

◆ FAVORITE_DIRECTIVE

const NamespaceAndName alexaClientSDK::capabilityAgents::externalMediaPlayer::FAVORITE_DIRECTIVE {FAVORITESCONTROLLER_NAMESPACE, "Favorite"}

static

◆ FAVORITESCONTROLLER_CAPABILITY_INTERFACE_NAME

const std::string alexaClientSDK::capabilityAgents::externalMediaPlayer::FAVORITESCONTROLLER_CAPABILITY_INTERFACE_NAME = FAVORITESCONTROLLER_NAMESPACE

static

Alexa.FavoritesController name.

◆ FAVORITESCONTROLLER_CAPABILITY_INTERFACE_VERSION

const std::string alexaClientSDK::capabilityAgents::externalMediaPlayer::FAVORITESCONTROLLER_CAPABILITY_INTERFACE_VERSION = "1.0"

static

Alexa.FavoritesController version.

◆ FAVORITESCONTROLLER_NAMESPACE

const std::string alexaClientSDK::capabilityAgents::externalMediaPlayer::FAVORITESCONTROLLER_NAMESPACE = "Alexa.FavoritesController"

static

◆ g_buttonToRequestType

std::unordered_map<PlaybackButton, RequestType> alexaClientSDK::capabilityAgents::externalMediaPlayer::g_buttonToRequestType

static

Initial value:

= {
    {PlaybackButton::PLAY, RequestType::PAUSE_RESUME_TOGGLE},
    {PlaybackButton::PAUSE, RequestType::PAUSE_RESUME_TOGGLE},
    {PlaybackButton::NEXT, RequestType::NEXT},
    {PlaybackButton::PREVIOUS, RequestType::PREVIOUS}}

◆ g_configuration

DirectiveHandlerConfiguration alexaClientSDK::capabilityAgents::externalMediaPlayer::g_configuration

static

Initial value:

= {{AUTHORIZEDISCOVEREDPLAYERS_DIRECTIVE, audioNonBlockingPolicy},
                                                        {PLAY_DIRECTIVE, audioNonBlockingPolicy},
                                                        {LOGIN_DIRECTIVE, neitherNonBlockingPolicy},
                                                        {LOGOUT_DIRECTIVE, neitherNonBlockingPolicy},
                                                        {RESUME_DIRECTIVE, audioNonBlockingPolicy},
                                                        {PAUSE_DIRECTIVE, audioNonBlockingPolicy},
                                                        {STOP_DIRECTIVE, audioNonBlockingPolicy},
                                                        {NEXT_DIRECTIVE, audioNonBlockingPolicy},
                                                        {PREVIOUS_DIRECTIVE, audioNonBlockingPolicy},
                                                        {STARTOVER_DIRECTIVE, audioNonBlockingPolicy},
                                                        {REWIND_DIRECTIVE, audioNonBlockingPolicy},
                                                        {FASTFORWARD_DIRECTIVE, audioNonBlockingPolicy},
                                                        {ENABLEREPEATONE_DIRECTIVE, neitherNonBlockingPolicy},
                                                        {ENABLEREPEAT_DIRECTIVE, neitherNonBlockingPolicy},
                                                        {DISABLEREPEAT_DIRECTIVE, neitherNonBlockingPolicy},
                                                        {ENABLESHUFFLE_DIRECTIVE, neitherNonBlockingPolicy},
                                                        {DISABLESHUFFLE_DIRECTIVE, neitherNonBlockingPolicy},
                                                        {SEEK_DIRECTIVE, audioNonBlockingPolicy},
                                                        {ADJUSTSEEK_DIRECTIVE, audioNonBlockingPolicy},
                                                        {FAVORITE_DIRECTIVE, neitherNonBlockingPolicy},
                                                        {UNFAVORITE_DIRECTIVE, neitherNonBlockingPolicy}}

◆ g_toggleToRequestType

std::unordered_map<PlaybackToggle, std::pair<RequestType, RequestType> > alexaClientSDK::capabilityAgents::externalMediaPlayer::g_toggleToRequestType

static

Initial value:

= {
    {PlaybackToggle::SHUFFLE, std::make_pair(RequestType::ENABLE_SHUFFLE, RequestType::DISABLE_SHUFFLE)},
    {PlaybackToggle::LOOP, std::make_pair(RequestType::ENABLE_REPEAT, RequestType::DISABLE_REPEAT)},
    {PlaybackToggle::REPEAT, std::make_pair(RequestType::ENABLE_REPEAT_ONE, RequestType::DISABLE_REPEAT_ONE)},
    {PlaybackToggle::THUMBS_UP, std::make_pair(RequestType::FAVORITE, RequestType::DESELECT_FAVORITE)},
    {PlaybackToggle::THUMBS_DOWN, std::make_pair(RequestType::UNFAVORITE, RequestType::DESELECT_UNFAVORITE)}}

◆ HEADER_KEY

const std::string alexaClientSDK::capabilityAgents::externalMediaPlayer::HEADER_KEY = "header"

static

The header key.

◆ LOCAL_PLAYER_ID

const char alexaClientSDK::capabilityAgents::externalMediaPlayer::LOCAL_PLAYER_ID[] = "localPlayerId"

static

The localPlayerId key.

◆ LOGIN_DIRECTIVE

const NamespaceAndName alexaClientSDK::capabilityAgents::externalMediaPlayer::LOGIN_DIRECTIVE {EXTERNALMEDIAPLAYER_NAMESPACE, "Login"}

static

◆ LOGOUT_DIRECTIVE

const NamespaceAndName alexaClientSDK::capabilityAgents::externalMediaPlayer::LOGOUT_DIRECTIVE {EXTERNALMEDIAPLAYER_NAMESPACE, "Logout"}

static

◆ MAX_FUTURE_OFFSET

const int64_t alexaClientSDK::capabilityAgents::externalMediaPlayer::MAX_FUTURE_OFFSET = 86400000

static

The max relative time in the past that we can seek to in milliseconds(+12 hours in ms).

◆ MAX_PAST_OFFSET

const int64_t alexaClientSDK::capabilityAgents::externalMediaPlayer::MAX_PAST_OFFSET = -86400000

static

The max relative time in the past that we can seek to in milliseconds(-12hours in ms).

◆ METADATA

const char alexaClientSDK::capabilityAgents::externalMediaPlayer::METADATA[] = "metadata"

static

The metadata key.

◆ neitherNonBlockingPolicy

auto alexaClientSDK::capabilityAgents::externalMediaPlayer::neitherNonBlockingPolicy = BlockingPolicy(BlockingPolicy::MEDIUMS_NONE, false)

◆ NEXT_DIRECTIVE

const NamespaceAndName alexaClientSDK::capabilityAgents::externalMediaPlayer::NEXT_DIRECTIVE {PLAYBACKCONTROLLER_NAMESPACE, "Next"}

static

◆ PAUSE_DIRECTIVE

const NamespaceAndName alexaClientSDK::capabilityAgents::externalMediaPlayer::PAUSE_DIRECTIVE {PLAYBACKCONTROLLER_NAMESPACE, "Pause"}

static

◆ PAYLOAD_KEY

const std::string alexaClientSDK::capabilityAgents::externalMediaPlayer::PAYLOAD_KEY = "payload"

static

The payload key.

◆ PLAY_DIRECTIVE

const NamespaceAndName alexaClientSDK::capabilityAgents::externalMediaPlayer::PLAY_DIRECTIVE {EXTERNALMEDIAPLAYER_NAMESPACE, "Play"}

static

◆ PLAY_DIRECTIVE_RECEIVED

const std::string alexaClientSDK::capabilityAgents::externalMediaPlayer::PLAY_DIRECTIVE_RECEIVED = "PLAY_DIRECTIVE_RECEIVED"

static

The directive received metric is used in place of 'first bytes' for UPL because pre-buffering may distort the metric.

◆ PLAYBACK_STATE

const NamespaceAndName alexaClientSDK::capabilityAgents::externalMediaPlayer::PLAYBACK_STATE {PLAYBACKSTATEREPORTER_STATE_NAMESPACE, PLAYBACKSTATEREPORTER_NAME}

static

◆ PLAYBACKCONTROLLER_CAPABILITY_INTERFACE_NAME

const std::string alexaClientSDK::capabilityAgents::externalMediaPlayer::PLAYBACKCONTROLLER_CAPABILITY_INTERFACE_NAME = PLAYBACKCONTROLLER_NAMESPACE

static

Alexa.PlaybackController name.

◆ PLAYBACKCONTROLLER_CAPABILITY_INTERFACE_VERSION

const std::string alexaClientSDK::capabilityAgents::externalMediaPlayer::PLAYBACKCONTROLLER_CAPABILITY_INTERFACE_VERSION = "1.0"

static

Alexa.PlaybackController version.

◆ PLAYBACKCONTROLLER_NAMESPACE

const std::string alexaClientSDK::capabilityAgents::externalMediaPlayer::PLAYBACKCONTROLLER_NAMESPACE = "Alexa.PlaybackController"

static

◆ PLAYBACKSTATEREPORTER_CAPABILITY_INTERFACE_NAME

const std::string alexaClientSDK::capabilityAgents::externalMediaPlayer::PLAYBACKSTATEREPORTER_CAPABILITY_INTERFACE_NAME = PLAYBACKSTATEREPORTER_STATE_NAMESPACE

static

Alexa.PlaybackStateReporter name.

◆ PLAYBACKSTATEREPORTER_CAPABILITY_INTERFACE_VERSION

const std::string alexaClientSDK::capabilityAgents::externalMediaPlayer::PLAYBACKSTATEREPORTER_CAPABILITY_INTERFACE_VERSION = "1.0"

static

Alexa.PlaybackStateReporter version.

◆ PLAYBACKSTATEREPORTER_NAME

const std::string alexaClientSDK::capabilityAgents::externalMediaPlayer::PLAYBACKSTATEREPORTER_NAME = "playbackState"

static

◆ PLAYBACKSTATEREPORTER_STATE_NAMESPACE

const std::string alexaClientSDK::capabilityAgents::externalMediaPlayer::PLAYBACKSTATEREPORTER_STATE_NAMESPACE = "Alexa.PlaybackStateReporter"

static

◆ PLAYER_ID_KEY

const std::string alexaClientSDK::capabilityAgents::externalMediaPlayer::PLAYER_ID_KEY = "playerId"

static

The playerId key.

◆ PLAYER_IN_FOCUS

const char alexaClientSDK::capabilityAgents::externalMediaPlayer::PLAYER_IN_FOCUS[] = "playerInFocus"

static

The const char for the playerInFocus key field in the context.

◆ PLAYERS

const char alexaClientSDK::capabilityAgents::externalMediaPlayer::PLAYERS[] = "players"

static

The const char for the players key field in the context.

◆ PLAYLISTCONTROLLER_CAPABILITY_INTERFACE_NAME

const std::string alexaClientSDK::capabilityAgents::externalMediaPlayer::PLAYLISTCONTROLLER_CAPABILITY_INTERFACE_NAME = PLAYLISTCONTROLLER_NAMESPACE

static

Alexa.PlaylistController name.

◆ PLAYLISTCONTROLLER_CAPABILITY_INTERFACE_VERSION

const std::string alexaClientSDK::capabilityAgents::externalMediaPlayer::PLAYLISTCONTROLLER_CAPABILITY_INTERFACE_VERSION = "1.0"

static

Alexa.PlaylistController version.

◆ PLAYLISTCONTROLLER_NAMESPACE

const std::string alexaClientSDK::capabilityAgents::externalMediaPlayer::PLAYLISTCONTROLLER_NAMESPACE = "Alexa.PlaylistController"

static

◆ PREVIOUS_DIRECTIVE

const NamespaceAndName alexaClientSDK::capabilityAgents::externalMediaPlayer::PREVIOUS_DIRECTIVE {PLAYBACKCONTROLLER_NAMESPACE, "Previous"}

static

◆ REPORT_DISCOVERED_PLAYERS

const char alexaClientSDK::capabilityAgents::externalMediaPlayer::REPORT_DISCOVERED_PLAYERS[] = "ReportDiscoveredPlayers"

static

The ReportDiscoveredPlayers Event key.

◆ RESUME_DIRECTIVE

const NamespaceAndName alexaClientSDK::capabilityAgents::externalMediaPlayer::RESUME_DIRECTIVE {PLAYBACKCONTROLLER_NAMESPACE, "Play"}

static

◆ REWIND_DIRECTIVE

const NamespaceAndName alexaClientSDK::capabilityAgents::externalMediaPlayer::REWIND_DIRECTIVE {PLAYBACKCONTROLLER_NAMESPACE, "Rewind"}

static

◆ SEEK_DIRECTIVE

const NamespaceAndName alexaClientSDK::capabilityAgents::externalMediaPlayer::SEEK_DIRECTIVE {SEEKCONTROLLER_NAMESPACE, "SetSeekPosition"}

static

◆ SEEKCONTROLLER_CAPABILITY_INTERFACE_NAME

const std::string alexaClientSDK::capabilityAgents::externalMediaPlayer::SEEKCONTROLLER_CAPABILITY_INTERFACE_NAME = SEEKCONTROLLER_NAMESPACE

static

Alexa.SeekController name.

◆ SEEKCONTROLLER_CAPABILITY_INTERFACE_VERSION

const std::string alexaClientSDK::capabilityAgents::externalMediaPlayer::SEEKCONTROLLER_CAPABILITY_INTERFACE_VERSION = "1.0"

static

Alexa.SeekController version.

◆ SEEKCONTROLLER_NAMESPACE

const std::string alexaClientSDK::capabilityAgents::externalMediaPlayer::SEEKCONTROLLER_NAMESPACE = "Alexa.SeekController"

static

◆ SESSION_STATE

const NamespaceAndName alexaClientSDK::capabilityAgents::externalMediaPlayer::SESSION_STATE {EXTERNALMEDIAPLAYER_STATE_NAMESPACE, EXTERNALMEDIAPLAYER_NAME}

static

◆ SPI_VERSION_KEY

const char alexaClientSDK::capabilityAgents::externalMediaPlayer::SPI_VERSION_KEY[] = "spiVersion"

static

The spiVersion key.

◆ STARTOVER_DIRECTIVE

const NamespaceAndName alexaClientSDK::capabilityAgents::externalMediaPlayer::STARTOVER_DIRECTIVE {PLAYBACKCONTROLLER_NAMESPACE, "StartOver"}

static

◆ STOP_DIRECTIVE

const NamespaceAndName alexaClientSDK::capabilityAgents::externalMediaPlayer::STOP_DIRECTIVE {PLAYBACKCONTROLLER_NAMESPACE, "Stop"}

static

◆ STOP_DIRECTIVE_RECEIVED

const std::string alexaClientSDK::capabilityAgents::externalMediaPlayer::STOP_DIRECTIVE_RECEIVED = "STOP_DIRECTIVE_RECEIVED"

static

The directive received metric is used in place of 'first bytes' for Stop UPL because there are no bytes involved.

◆ UNFAVORITE_DIRECTIVE

const NamespaceAndName alexaClientSDK::capabilityAgents::externalMediaPlayer::UNFAVORITE_DIRECTIVE {FAVORITESCONTROLLER_NAMESPACE, "Unfavorite"}

static

◆ VALIDATION_DATA

const char alexaClientSDK::capabilityAgents::externalMediaPlayer::VALIDATION_DATA[] = "validationData"

static

The validationData key.

◆ VALIDATION_METHOD

const char alexaClientSDK::capabilityAgents::externalMediaPlayer::VALIDATION_METHOD[] = "validationMethod"

static

The validationMethod key.

Namespaces

Classes

Functions

Variables

Function Documentation

◆ EMP_AGENT_KEY()

◆ EMP_CONFIG_KEY()

◆ generateCapabilityConfiguration()

◆ getExternalMediaPlayerCapabilityConfiguration()

◆ submitMetric()

◆ TAG() [1/2]

◆ TAG() [2/2]

Variable Documentation

◆ ADJUSTSEEK_DIRECTIVE

◆ AGENT_KEY

◆ ALEXA_INTERFACE_TYPE

◆ AUDIO_PLAYER_METRIC_PREFIX

◆ audioNonBlockingPolicy

◆ AUTHORIZATION_COMPLETE

◆ AUTHORIZED

◆ AUTHORIZEDISCOVEREDPLAYERS_DIRECTIVE

◆ DEAUTHORIZED

◆ DISABLEREPEAT_DIRECTIVE

◆ DISABLESHUFFLE_DIRECTIVE

◆ ENABLEREPEAT_DIRECTIVE

◆ ENABLEREPEATONE_DIRECTIVE

◆ ENABLESHUFFLE_DIRECTIVE

◆ EVENT_KEY

◆ EXTERNALMEDIAPLAYER_CAPABILITY_INTERFACE_NAME

◆ EXTERNALMEDIAPLAYER_CAPABILITY_INTERFACE_TYPE

◆ EXTERNALMEDIAPLAYER_CAPABILITY_INTERFACE_VERSION

◆ EXTERNALMEDIAPLAYER_NAME

◆ EXTERNALMEDIAPLAYER_NAMESPACE

◆ EXTERNALMEDIAPLAYER_STATE_NAMESPACE

◆ FASTFORWARD_DIRECTIVE

◆ FAVORITE_DIRECTIVE

◆ FAVORITESCONTROLLER_CAPABILITY_INTERFACE_NAME

◆ FAVORITESCONTROLLER_CAPABILITY_INTERFACE_VERSION

◆ FAVORITESCONTROLLER_NAMESPACE

◆ g_buttonToRequestType

◆ g_configuration

◆ g_toggleToRequestType

◆ HEADER_KEY

◆ LOCAL_PLAYER_ID

◆ LOGIN_DIRECTIVE

◆ LOGOUT_DIRECTIVE

◆ MAX_FUTURE_OFFSET

◆ MAX_PAST_OFFSET

◆ METADATA

◆ neitherNonBlockingPolicy

◆ NEXT_DIRECTIVE

◆ PAUSE_DIRECTIVE

◆ PAYLOAD_KEY

◆ PLAY_DIRECTIVE

◆ PLAY_DIRECTIVE_RECEIVED

◆ PLAYBACK_STATE

◆ PLAYBACKCONTROLLER_CAPABILITY_INTERFACE_NAME

◆ PLAYBACKCONTROLLER_CAPABILITY_INTERFACE_VERSION

◆ PLAYBACKCONTROLLER_NAMESPACE

◆ PLAYBACKSTATEREPORTER_CAPABILITY_INTERFACE_NAME

◆ PLAYBACKSTATEREPORTER_CAPABILITY_INTERFACE_VERSION

◆ PLAYBACKSTATEREPORTER_NAME

◆ PLAYBACKSTATEREPORTER_STATE_NAMESPACE

◆ PLAYER_ID_KEY

◆ PLAYER_IN_FOCUS

◆ PLAYERS

◆ PLAYLISTCONTROLLER_CAPABILITY_INTERFACE_NAME

◆ PLAYLISTCONTROLLER_CAPABILITY_INTERFACE_VERSION

◆ PLAYLISTCONTROLLER_NAMESPACE

◆ PREVIOUS_DIRECTIVE

◆ REPORT_DISCOVERED_PLAYERS

◆ RESUME_DIRECTIVE

◆ REWIND_DIRECTIVE

◆ SEEK_DIRECTIVE

◆ SEEKCONTROLLER_CAPABILITY_INTERFACE_NAME

◆ SEEKCONTROLLER_CAPABILITY_INTERFACE_VERSION

◆ SEEKCONTROLLER_NAMESPACE

◆ SESSION_STATE

◆ SPI_VERSION_KEY

◆ STARTOVER_DIRECTIVE