Namespaces
	test

Classes
struct	AdapterPlaybackState

struct	AdapterSessionState

class	AdapterState

struct	DiscoveredPlayerInfo

class	ExternalMediaAdapterHandlerInterface

class	ExternalMediaAdapterInterface

class	ExternalMediaPlayerInterface

class	ExternalMediaPlayerObserverInterface

struct	ObservablePlaybackStateProperties

struct	ObservableSessionProperties

struct	PlayerInfo

struct	PlayerInfoBase

Enumerations
enum	AdapterEvent { AdapterEvent::CHANGE_REPORT, AdapterEvent::REQUEST_TOKEN, AdapterEvent::LOGIN, AdapterEvent::LOGOUT, AdapterEvent::PLAYER_EVENT, AdapterEvent::PLAYER_ERROR_EVENT }
	Enumeration class for events sent by adapters to AVS. More...

enum	RequestType { RequestType::INIT, RequestType::DEINIT, RequestType::LOGIN, RequestType::LOGOUT, RequestType::REGISTER, RequestType::PLAY, RequestType::RESUME, RequestType::PAUSE, RequestType::STOP, RequestType::PAUSE_RESUME_TOGGLE, RequestType::NEXT, RequestType::PREVIOUS, RequestType::START_OVER, RequestType::FAST_FORWARD, RequestType::REWIND, RequestType::ENABLE_REPEAT_ONE, RequestType::DISABLE_REPEAT_ONE, RequestType::ENABLE_REPEAT, RequestType::DISABLE_REPEAT, RequestType::ENABLE_SHUFFLE, RequestType::DISABLE_SHUFFLE, RequestType::FAVORITE, RequestType::DESELECT_FAVORITE, RequestType::UNFAVORITE, RequestType::DESELECT_UNFAVORITE, RequestType::SEEK, RequestType::ADJUST_SEEK, RequestType::SET_VOLUME, RequestType::ADJUST_VOLUME, RequestType::SET_MUTE, RequestType::SET_DISPLAY_NAME, RequestType::GET_INFO, RequestType::ADD_USER, RequestType::RESET_USER, RequestType::NONE }

enum	SupportedPlaybackOperation { SupportedPlaybackOperation::PLAY, SupportedPlaybackOperation::RESUME, SupportedPlaybackOperation::PAUSE, SupportedPlaybackOperation::STOP, SupportedPlaybackOperation::NEXT, SupportedPlaybackOperation::PREVIOUS, SupportedPlaybackOperation::START_OVER, SupportedPlaybackOperation::FAST_FORWARD, SupportedPlaybackOperation::REWIND, SupportedPlaybackOperation::ENABLE_REPEAT, SupportedPlaybackOperation::DISABLE_REPEAT, SupportedPlaybackOperation::ENABLE_REPEAT_ONE, SupportedPlaybackOperation::DISABLE_REPEAT_ONE, SupportedPlaybackOperation::ENABLE_SHUFFLE, SupportedPlaybackOperation::DISABLE_SHUFFLE, SupportedPlaybackOperation::FAVORITE, SupportedPlaybackOperation::UNFAVORITE, SupportedPlaybackOperation::SEEK, SupportedPlaybackOperation::ADJUST_SEEK }

enum	ChangeCauseType { ChangeCauseType::VOICE_INTERACTION, ChangeCauseType::PHYSICAL_INTERACTION, ChangeCauseType::APP_INTERACTION, ChangeCauseType::RULE_TRIGGER, ChangeCauseType::PERIODIC_POLL }

enum	Favorites { Favorites::FAVORITED, Favorites::UNFAVORITED, Favorites::NOT_RATED }

enum	MediaType { MediaType::TRACK, MediaType::PODCAST, MediaType::STATION, MediaType::AD, MediaType::SAMPLE, MediaType::OTHER }

enum	Navigation { Navigation::DEFAULT, Navigation::NONE, Navigation::FOREGROUND }

enum	ValidationMethod { ValidationMethod::SIGNING_CERTIFICATE, ValidationMethod::GENERATED_CERTIFICATE, ValidationMethod::NONE }
	Enum describing the available validation methods for External Media Players. More...

Functions
std::string	adapterEventToString (AdapterEvent event)

std::ostream &	operator<< (std::ostream &stream, const AdapterEvent &event)

rapidjson::Value	buildSupportedOperations (const std::set< acsdkExternalMediaPlayerInterfaces::SupportedPlaybackOperation > &supportedOperations, rapidjson::Document::AllocatorType &allocator)

bool	buildMediaState (rapidjson::Value *document, const AdapterPlaybackState &playbackState, rapidjson::Document::AllocatorType &allocator)

rapidjson::Value	buildPlaybackState (const acsdkExternalMediaPlayerInterfaces::AdapterPlaybackState &playbackState, rapidjson::Document::AllocatorType &allocator)

rapidjson::Value	buildSessionState (const acsdkExternalMediaPlayerInterfaces::AdapterSessionState &sessionState, rapidjson::Document::AllocatorType &allocator)

bool	buildDefaultPlayerState (rapidjson::Value *document, rapidjson::Document::AllocatorType &allocator)

std::string	getEmpContextString (acsdkExternalMediaPlayerInterfaces::AdapterState adapterState)

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")

std::string	navigationToString (Navigation navigation)

std::ostream &	operator<< (std::ostream &stream, const Navigation &navigation)

Navigation	stringToNavigation (const std::string &str)

std::string	RequestTypeToString (RequestType requestType)

std::string	SupportedPlaybackOperationToString (SupportedPlaybackOperation operation)

std::string	ChangeTriggerToString (ChangeCauseType changeType)

std::string	RatingToString (Favorites rating)

std::string	MediaTypeToString (MediaType mediaType)

std::string	SHUFFLE_STATUS_STRING (bool shuffleEnabled)

std::string	REPEAT_STATUS_STRING (bool repeatEnabled)

std::string	validationMethodToString (ValidationMethod value)
	Converts the ValidationMethod enum to a string representation. More...

bool	operator== (const ObservableSessionProperties &observableSessionPropertiesA, const ObservableSessionProperties &observableSessionPropertiesB)

bool	operator== (const ObservablePlaybackStateProperties &observableA, const ObservablePlaybackStateProperties &observableB)

Variables
const std::vector< int >	SESSION_RETRY_TABLE

avsCommon::utils::RetryTimer	SESSION_RETRY_TIMER
	The retry timer for session management (token fetch/changeReport send). More...

const avsCommon::avs::NamespaceAndName	CHANGE_REPORT

const avsCommon::avs::NamespaceAndName	REQUEST_TOKEN

const avsCommon::avs::NamespaceAndName	LOGIN

const avsCommon::avs::NamespaceAndName	LOGOUT

const avsCommon::avs::NamespaceAndName	PLAYER_EVENT

const avsCommon::avs::NamespaceAndName	PLAYER_ERROR_EVENT

std::map< AdapterEvent, std::pair< std::string, std::string > >	eventNameSpaceNameMap

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 char	AGENT_KEY [] = "agent"
	The const char for agent key. More...

const char	PLAYER_ID [] = "playerId"

const char	ENDPOINT_ID [] = "endpointId"

const char	LOGGED_IN [] = "loggedIn"

const char	USERNAME [] = "username"

const char	IS_GUEST [] = "isGuest"

const char	LAUNCHED [] = "launched"

const char	ACTIVE [] = "active"

const char	SPI_VERSION [] = "spiVersion"

const char	PLAYER_COOKIE [] = "playerCookie"

const char	SKILL_TOKEN [] = "skillToken"

const char	PLAYBACK_SESSION_ID [] = "playbackSessionId"

const char	STATE [] = "state"

const char	OPERATIONS [] = "supportedOperations"

const char	MEDIA [] = "media"

const char	POSITIONINMS [] = "positionMilliseconds"

const char	SHUFFLE [] = "shuffle"

const char	REPEAT [] = "repeat"

const char	FAVORITE [] = "favorite"

const char	PLAYBACK_SOURCE [] = "playbackSource"

const char	TYPE [] = "type"

const char	PLAYBACK_SOURCE_ID [] = "playbackSourceId"

const char	PLAYBACK_ID [] = "playbackId"

const char	TRACKNAME [] = "trackName"

const char	TRACK_ID [] = "trackId"

const char	TRACK_NUMBER [] = "trackNumber"

const char	ARTIST [] = "artist"

const char	ARTIST_ID [] = "artistId"

const char	ALBUM [] = "album"

const char	ALBUM_ID [] = "albumId"

const char	COVER_URLS [] = "coverUrls"

const char	TINY_URL [] = "tiny"

const char	SMALL_URL [] = "small"

const char	MEDIUM_URL [] = "medium"

const char	LARGE_URL [] = "large"

const char	COVER_ID [] = "coverId"

const char	MEDIA_PROVIDER [] = "mediaProvider"

const char	MEDIA_TYPE [] = "mediaType"

const char	DURATIONINMS [] = "durationInMilliseconds"

const char	VALUE [] = "value"

Enumeration Type Documentation

◆ AdapterEvent

enum alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterEvent

strong

Enumeration class for events sent by adapters to AVS.

Enumerator
CHANGE_REPORT	ChangeReport event sent after adapter's initialization succeeds/fails.
REQUEST_TOKEN	Event to request token from third party.
LOGIN	Login event when a guest user logs in.
LOGOUT	Logout event when a user logs out.
PLAYER_EVENT	PlayerEvent to announce all kinds of player events - like play/pause/next etc.
PLAYER_ERROR_EVENT	PlayerErrorEvent to report all errors from the adapters.

◆ ChangeCauseType

enum alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ChangeCauseType

strong

Enum which identifies how a state change was triggered.

Enumerator
VOICE_INTERACTION	The state change was triggered as result of voice interaction.
PHYSICAL_INTERACTION	Change was triggered by a physical interaction.
APP_INTERACTION	Change was triggered by an app interaction.
RULE_TRIGGER	Change was triggered by a rule.
PERIODIC_POLL	Change was triggered by periodic polling.

◆ Favorites

enum alexaClientSDK::acsdkExternalMediaPlayerInterfaces::Favorites

strong

Enum which identifies the ratings of a track.

Enumerator
FAVORITED	Favorite rating.
UNFAVORITED	Unfavorite rating.
NOT_RATED	track not rated.

◆ MediaType

enum alexaClientSDK::acsdkExternalMediaPlayerInterfaces::MediaType

strong

Enum which identifies the media type.

Enumerator
TRACK	The media is track.
PODCAST	The media is a podcast.
STATION	The media is a station.
AD	The media is an ad.
SAMPLE	The media is a sample.
OTHER	The media type is something other than track/podcast/station/ad/sample.

◆ Navigation

enum alexaClientSDK::acsdkExternalMediaPlayerInterfaces::Navigation

strong

Type of navigation when external media player app is first invoked via AVS

Enumerator
DEFAULT	Source dependant behavior
NONE	No navigation should occur
FOREGROUND	External app should take foreground

◆ RequestType

enum alexaClientSDK::acsdkExternalMediaPlayerInterfaces::RequestType

strong

Enum class for the different Request Types that an ExternalMediaAdapter handles.

Enumerator
INIT	Initialization.
DEINIT	DeInitialization.
LOGIN	Login.
LOGOUT	Logout.
REGISTER	Register.
PLAY	Play.
RESUME	Resume.
PAUSE	Pause.
STOP	Stop.
PAUSE_RESUME_TOGGLE	Pause or Resume depending on current state.
NEXT	Next.
PREVIOUS	Previous.
START_OVER	Starover from the beginning.
FAST_FORWARD	Fast-forward.
REWIND	rewind
ENABLE_REPEAT_ONE	Enable Repeat of a track.
DISABLE_REPEAT_ONE	Disable Repeat of a track.
ENABLE_REPEAT	Enable Loop on.
DISABLE_REPEAT	Disable loop on.
ENABLE_SHUFFLE	Enable shuffle.
DISABLE_SHUFFLE	Disable shuffle.
FAVORITE	Mark a track as favorite.(thumbs up true)
DESELECT_FAVORITE	Unmark a track as favorite.(thumbs up false)
UNFAVORITE	Mark a track as not a favorite.(thumbs down true)
DESELECT_UNFAVORITE	Unmark a track as not a favorite.(thumbs down false)
SEEK	Seek to a given offset.
ADJUST_SEEK	Seek to an offset relative to the current offset.
SET_VOLUME	Set volume level to a given volume.
ADJUST_VOLUME	Adjust volume level relative to the existing volume.
SET_MUTE	Set mute to true/false.
SET_DISPLAY_NAME	Set the name the external media player will show for this device.
GET_INFO	Get Info.
ADD_USER	Add User Message.
RESET_USER	Reset User Message.
NONE	None means there are no pending requests.

◆ SupportedPlaybackOperation

enum alexaClientSDK::acsdkExternalMediaPlayerInterfaces::SupportedPlaybackOperation

strong

Enumerator
PLAY	Play.
RESUME	Resume.
PAUSE	Pause.
STOP	Stop.
NEXT	Next.
PREVIOUS	Previous.
START_OVER	Start over a track from the beginning.
FAST_FORWARD	Fast-forward.
REWIND	rewind
ENABLE_REPEAT	Enable Loop on.
DISABLE_REPEAT	Disable loop on.
ENABLE_REPEAT_ONE	Enable repeat of a track .
DISABLE_REPEAT_ONE	Disable repeat of a track.
ENABLE_SHUFFLE	Enable shuffle.
DISABLE_SHUFFLE	Disable shuffle.
FAVORITE	Mark a track as favorite.(thumbs up)
UNFAVORITE	Mark a track as not a favorite.(thumbs down)
SEEK	Seek to a given offset.
ADJUST_SEEK	Seek to an offset relative to the current offset.

◆ ValidationMethod

enum alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ValidationMethod

strong

Enum describing the available validation methods for External Media Players.

Enumerator
SIGNING_CERTIFICATE	Use a signing certificate for validation.
GENERATED_CERTIFICATE	Use a generated certificate.
NONE	No validation.

Function Documentation

◆ adapterEventToString()

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::adapterEventToString ( AdapterEvent event )

inline

Convert an AdapterEvent to string

Parameters

event Event to convert

Returns: Event in string format

◆ buildDefaultPlayerState()

bool alexaClientSDK::acsdkExternalMediaPlayerInterfaces::buildDefaultPlayerState	(	rapidjson::Value *	document,
		rapidjson::Document::AllocatorType &	allocator
	)

Method to build the default player.

Parameters

document	The JSON Value to write the default player state into.
allocator	The rapidjson allocator, required for the results of this function to be merge-able with other rapidjson::Value objects.

Returns: true if the build of default player state was successful, false otherwise.

◆ buildMediaState()

bool alexaClientSDK::acsdkExternalMediaPlayerInterfaces::buildMediaState	(	rapidjson::Value *	document,
		const AdapterPlaybackState &	playbackState,
		rapidjson::Document::AllocatorType &	allocator
	)

Method to convert a Media state to JSON.

Parameters

document	The JSON Value to write the Media state into.
playbackState	The playback state of the adapter.
The	rapidjson allocator, required for the results of this function to be merge-able with other rapidjson::Value objects.

Returns: true if the build of Media state was successful, false otherwise.

◆ buildPlaybackState()

rapidjson::Value alexaClientSDK::acsdkExternalMediaPlayerInterfaces::buildPlaybackState	(	const acsdkExternalMediaPlayerInterfaces::AdapterPlaybackState &	playbackState,
		rapidjson::Document::AllocatorType &	allocator
	)

Method to convert a playbackState to JSON.

Parameters

playbackState	The playback state of the adapter.
The	rapidjson allocator, required for the results of this function to be merge-able with other rapidjson::Value objects.

Returns: The rapidjson::Value representing the playback state JSON.

◆ buildSessionState()

rapidjson::Value alexaClientSDK::acsdkExternalMediaPlayerInterfaces::buildSessionState	(	const acsdkExternalMediaPlayerInterfaces::AdapterSessionState &	sessionState,
		rapidjson::Document::AllocatorType &	allocator
	)

Method to convert session state to JSON.

Parameters

sessionState	The session state of the adapter.
The	rapidjson allocator, required for the results of this function to be mergable with other rapidjson::Value objects.

Returns: The rapidjson::Value representing the session state in JSON.

◆ buildSupportedOperations()

rapidjson::Value alexaClientSDK::acsdkExternalMediaPlayerInterfaces::buildSupportedOperations	(	const std::set< acsdkExternalMediaPlayerInterfaces::SupportedPlaybackOperation > &	supportedOperations,
		rapidjson::Document::AllocatorType &	allocator
	)

Method to iterate over a collection of supported operation in playback state and convert to JSON.

Parameters

supportedOperations	The collection of supported operations from the current playback state.
allocator	The rapidjson allocator, required for the results of this function to be mergable with other rapidjson::Value objects.

Returns: The rapidjson::Value representing the array.

◆ ChangeTriggerToString()

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ChangeTriggerToString ( ChangeCauseType changeType )

inline

Convert a ChangeCauseType to an AVS-compliant std::string.

Parameters

changeType The ChangeCauseType to convert.

Returns: The AVS-compliant string representation of changeType.

◆ EMP_AGENT_KEY()

static const std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::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::acsdkExternalMediaPlayerInterfaces::EMP_CONFIG_KEY ( "externalMediaPlayer" )

static

The root key for configuration values for the ExternalMediaPlayer.

◆ getEmpContextString()

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::getEmpContextString ( acsdkExternalMediaPlayerInterfaces::AdapterState adapterState )

Method to get EmpContext string. Specifically for spotify adapter state.

Parameters

adapterState The state of the adapter.

Returns: string Representing session state and playback state for the Spotify adapter state

◆ MediaTypeToString()

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::MediaTypeToString ( MediaType mediaType )

inline

Convert a Favorites to an AVS-compliant std::string.

Parameters

mediaType The MediaType to convert.

Returns: The AVS-compliant string representation of mediaType.

◆ navigationToString()

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::navigationToString ( Navigation navigation )

inline

Convert navigation enum to a string

Parameters

navigation Navigation to convert

Returns: Navigation in string form

◆ operator<<() [1/2]

std::ostream& alexaClientSDK::acsdkExternalMediaPlayerInterfaces::operator<<	(	std::ostream &	stream,
		const AdapterEvent &	event
	)

inline

Write a AdapterEvent to an ostream.

Parameters

stream	The stream to write the value to.
event	The `AdapterEvent` value to write to the `ostream` as a string.

Returns: The ostream that was passed in and written to.

◆ operator<<() [2/2]

std::ostream& alexaClientSDK::acsdkExternalMediaPlayerInterfaces::operator<<	(	std::ostream &	stream,
		const Navigation &	navigation
	)

inline

Write a Navigation to an ostream.

Parameters

stream	The stream to write the value to.
event	The `Navigation` value to write to the `ostream` as a string.

Returns: The ostream that was passed in and written to.

◆ operator==() [1/2]

bool alexaClientSDK::acsdkExternalMediaPlayerInterfaces::operator==	(	const ObservableSessionProperties &	observableSessionPropertiesA,
		const ObservableSessionProperties &	observableSessionPropertiesB
	)

inline

◆ operator==() [2/2]

bool alexaClientSDK::acsdkExternalMediaPlayerInterfaces::operator==	(	const ObservablePlaybackStateProperties &	observableA,
		const ObservablePlaybackStateProperties &	observableB
	)

inline

◆ RatingToString()

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::RatingToString ( Favorites rating )

inline

Convert a Favorites to an AVS-compliant std::string.

Parameters

rating The ChangeCauseType to convert.

Returns: The AVS-compliant string representation of rating.

◆ REPEAT_STATUS_STRING()

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::REPEAT_STATUS_STRING ( bool repeatEnabled )

inline

◆ RequestTypeToString()

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::RequestTypeToString ( RequestType requestType )

inline

Convert a RequestType to an AVS-compliant std::string.

Parameters

requestType The RequestType to convert.

Returns: The AVS-compliant string representation of RequestType

◆ SHUFFLE_STATUS_STRING()

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::SHUFFLE_STATUS_STRING ( bool shuffleEnabled )

inline

◆ stringToNavigation()

Navigation alexaClientSDK::acsdkExternalMediaPlayerInterfaces::stringToNavigation ( const std::string & str )

inline

Convert the given string to a Navigation enum

Parameters

str	String to convert

Returns: Navigation enum

◆ SupportedPlaybackOperationToString()

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::SupportedPlaybackOperationToString ( SupportedPlaybackOperation operation )

inline

Convert a SupportedPlaybackOperation to an AVS-compliant std::string.

Parameters

operation The SupportedPlaybackOperation to convert.

Returns: The AVS-compliant string representation of operation.

◆ validationMethodToString()

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::validationMethodToString ( ValidationMethod value )

inline

Converts the ValidationMethod enum to a string representation.

Variable Documentation

◆ ACTIVE

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ACTIVE[] = "active"

◆ AGENT_KEY

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AGENT_KEY[] = "agent"

static

The const char for agent key.

◆ ALBUM

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ALBUM[] = "album"

◆ ALBUM_ID

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ALBUM_ID[] = "albumId"

◆ ARTIST

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ARTIST[] = "artist"

◆ ARTIST_ID

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ARTIST_ID[] = "artistId"

◆ CHANGE_REPORT

const avsCommon::avs::NamespaceAndName alexaClientSDK::acsdkExternalMediaPlayerInterfaces::CHANGE_REPORT

◆ COVER_ID

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::COVER_ID[] = "coverId"

◆ COVER_URLS

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::COVER_URLS[] = "coverUrls"

◆ DURATIONINMS

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::DURATIONINMS[] = "durationInMilliseconds"

◆ ENDPOINT_ID

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ENDPOINT_ID[] = "endpointId"

◆ eventNameSpaceNameMap

std::map<AdapterEvent, std::pair<std::string, std::string> > alexaClientSDK::acsdkExternalMediaPlayerInterfaces::eventNameSpaceNameMap

◆ FAVORITE

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::FAVORITE[] = "favorite"

◆ IS_GUEST

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::IS_GUEST[] = "isGuest"

◆ LARGE_URL

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::LARGE_URL[] = "large"

◆ LAUNCHED

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::LAUNCHED[] = "launched"

◆ LOGGED_IN

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::LOGGED_IN[] = "loggedIn"

◆ LOGIN

const avsCommon::avs::NamespaceAndName alexaClientSDK::acsdkExternalMediaPlayerInterfaces::LOGIN

◆ LOGOUT

const avsCommon::avs::NamespaceAndName alexaClientSDK::acsdkExternalMediaPlayerInterfaces::LOGOUT

◆ MEDIA

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::MEDIA[] = "media"

◆ MEDIA_PROVIDER

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::MEDIA_PROVIDER[] = "mediaProvider"

◆ MEDIA_TYPE

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::MEDIA_TYPE[] = "mediaType"

◆ MEDIUM_URL

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::MEDIUM_URL[] = "medium"

◆ OPERATIONS

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::OPERATIONS[] = "supportedOperations"

◆ PLAYBACK_ID

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::PLAYBACK_ID[] = "playbackId"

◆ PLAYBACK_SESSION_ID

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::PLAYBACK_SESSION_ID[] = "playbackSessionId"

◆ PLAYBACK_SOURCE

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::PLAYBACK_SOURCE[] = "playbackSource"

◆ PLAYBACK_SOURCE_ID

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::PLAYBACK_SOURCE_ID[] = "playbackSourceId"

◆ PLAYER_COOKIE

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::PLAYER_COOKIE[] = "playerCookie"

◆ PLAYER_ERROR_EVENT

const avsCommon::avs::NamespaceAndName alexaClientSDK::acsdkExternalMediaPlayerInterfaces::PLAYER_ERROR_EVENT

◆ PLAYER_EVENT

const avsCommon::avs::NamespaceAndName alexaClientSDK::acsdkExternalMediaPlayerInterfaces::PLAYER_EVENT

◆ PLAYER_ID

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::PLAYER_ID[] = "playerId"

◆ PLAYER_IN_FOCUS

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::PLAYER_IN_FOCUS[] = "playerInFocus"

static

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

◆ PLAYERS

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::PLAYERS[] = "players"

static

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

◆ POSITIONINMS

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::POSITIONINMS[] = "positionMilliseconds"

◆ REPEAT

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::REPEAT[] = "repeat"

◆ REQUEST_TOKEN

const avsCommon::avs::NamespaceAndName alexaClientSDK::acsdkExternalMediaPlayerInterfaces::REQUEST_TOKEN

◆ SESSION_RETRY_TABLE

const std::vector<int> alexaClientSDK::acsdkExternalMediaPlayerInterfaces::SESSION_RETRY_TABLE

Table with the retry times on subsequent retries for session management (token fetch/changeReport send).

◆ SESSION_RETRY_TIMER

avsCommon::utils::RetryTimer alexaClientSDK::acsdkExternalMediaPlayerInterfaces::SESSION_RETRY_TIMER

The retry timer for session management (token fetch/changeReport send).

◆ SHUFFLE

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::SHUFFLE[] = "shuffle"

◆ SKILL_TOKEN

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::SKILL_TOKEN[] = "skillToken"

◆ SMALL_URL

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::SMALL_URL[] = "small"

◆ SPI_VERSION

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::SPI_VERSION[] = "spiVersion"

◆ STATE

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::STATE[] = "state"

◆ TINY_URL

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::TINY_URL[] = "tiny"

◆ TRACK_ID

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::TRACK_ID[] = "trackId"

◆ TRACK_NUMBER

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::TRACK_NUMBER[] = "trackNumber"

◆ TRACKNAME

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::TRACKNAME[] = "trackName"

◆ TYPE

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::TYPE[] = "type"

◆ USERNAME

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::USERNAME[] = "username"

◆ VALUE

const char alexaClientSDK::acsdkExternalMediaPlayerInterfaces::VALUE[] = "value"

Namespaces

Classes

Enumerations

Functions

Variables

Enumeration Type Documentation

◆ AdapterEvent

◆ ChangeCauseType

◆ Favorites

◆ MediaType

◆ Navigation

◆ RequestType

◆ SupportedPlaybackOperation

◆ ValidationMethod

Function Documentation

◆ adapterEventToString()

◆ buildDefaultPlayerState()

◆ buildMediaState()

◆ buildPlaybackState()

◆ buildSessionState()

◆ buildSupportedOperations()

◆ ChangeTriggerToString()

◆ EMP_AGENT_KEY()

◆ EMP_CONFIG_KEY()

◆ getEmpContextString()

◆ MediaTypeToString()

◆ navigationToString()

◆ operator<<() [1/2]

◆ operator<<() [2/2]

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ RatingToString()

◆ REPEAT_STATUS_STRING()

◆ RequestTypeToString()

◆ SHUFFLE_STATUS_STRING()

◆ stringToNavigation()

◆ SupportedPlaybackOperationToString()

◆ validationMethodToString()

Variable Documentation

◆ ACTIVE

◆ AGENT_KEY

◆ ALBUM

◆ ALBUM_ID

◆ ARTIST

◆ ARTIST_ID

◆ CHANGE_REPORT

◆ COVER_ID

◆ COVER_URLS

◆ DURATIONINMS

◆ ENDPOINT_ID

◆ eventNameSpaceNameMap

◆ FAVORITE

◆ IS_GUEST

◆ LARGE_URL

◆ LAUNCHED

◆ LOGGED_IN

◆ LOGIN

◆ LOGOUT

◆ MEDIA

◆ MEDIA_PROVIDER

◆ MEDIA_TYPE

◆ MEDIUM_URL

◆ OPERATIONS

◆ PLAYBACK_ID

◆ PLAYBACK_SESSION_ID

◆ PLAYBACK_SOURCE

◆ PLAYBACK_SOURCE_ID

◆ PLAYER_COOKIE

◆ PLAYER_ERROR_EVENT

◆ PLAYER_EVENT

◆ PLAYER_ID

◆ PLAYER_IN_FOCUS

◆ PLAYERS

◆ POSITIONINMS

◆ REPEAT

◆ REQUEST_TOKEN

◆ SESSION_RETRY_TABLE

◆ SESSION_RETRY_TIMER

◆ SHUFFLE

◆ SKILL_TOKEN