Namespaces
	test

Classes
struct	AudioItem
	Struct which contains all the fields which define an audio item for a `Play` directive. More...

class	AudioPlayer

class	ProgressTimer

Typedefs
using	MediaPlayerState = avsCommon::utils::mediaPlayer::MediaPlayerState

Enumerations
enum	ClearBehavior { ClearBehavior::CLEAR_ENQUEUED, ClearBehavior::CLEAR_ALL }
	Used to determine clear queue behavior. More...

enum	StreamFormat { StreamFormat::AUDIO_MPEG, StreamFormat::UNKNOWN }
	Specifies the format of a binary audio attachment in a `Play` directive. More...

Functions
std::string	clearBehaviorToString (ClearBehavior clearBehavior)

bool	stringToClearBehavior (const std::string &text, ClearBehavior *clearBehavior)

std::ostream &	operator<< (std::ostream &stream, const ClearBehavior &clearBehavior)

bool	convertToValue (const rapidjson::Value &documentNode, ClearBehavior *clearBehavior)

std::string	streamFormatToString (StreamFormat streamFormat)

bool	stringToStreamFormat (const std::string &text, StreamFormat *streamFormat)

std::ostream &	operator<< (std::ostream &stream, const StreamFormat &streamFormat)

bool	convertToValue (const rapidjson::Value &documentNode, StreamFormat *streamFormat)

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

static bool	compareUrlNotQuery (const std::string &url1, const std::string &url2)

static std::shared_ptr< avsCommon::avs::CapabilityConfiguration >	getAudioPlayerCapabilityConfiguration (Fingerprint fingerprint)

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

static void	submitAnnotatedMetric (const std::shared_ptr< MetricRecorderInterface > &metricRecorder, const std::string &baseMetric, const std::string &annotation)

static audio::MixingBehavior	getMixingBehavior (const std::string &messageID, const rapidjson::Value &payload, const std::shared_ptr< MetricRecorderInterface > &metricRecorder)

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

std::ostream &	operator<< (std::ostream &stream, ProgressTimer::State state)

Variables
static const std::string	AUDIOPLAYER_CAPABILITY_INTERFACE_TYPE = "AlexaInterface"

static const std::string	AUDIOPLAYER_CAPABILITY_INTERFACE_NAME = "AudioPlayer"
	AudioPlayer interface name. More...

static const std::string	AUDIOPLAYER_CAPABILITY_INTERFACE_VERSION = "1.4"
	AudioPlayer interface version. More...

static const std::string	FINGERPRINT_KEY = "fingerprint"
	The fingerprint key used in `AudioPlayer` configurations. More...

static const std::string	PACKAGE_KEY = "package"
	The package key used in `AudioPlayer` fingerprint. More...

static const std::string	BUILD_TYPE_KEY = "buildType"
	The buildType key used in `AudioPlayer` fingerprint. More...

static const std::string	VERSION_NUMBER_KEY = "versionNumber"
	The versionNumber key used in `AudioPlayer` fingerprint. More...

static const AudioPlayer::SourceId	ERROR_SOURCE_ID = MediaPlayerInterface::ERROR
	A link to `MediaPlayerInterface::ERROR`. More...

static const std::string	CHANNEL_NAME = FocusManagerInterface::CONTENT_CHANNEL_NAME
	The name of the `FocusManager` channel used by `AudioPlayer`. More...

static const std::string	NAMESPACE = "AudioPlayer"
	The namespace for this capability agent. More...

static const NamespaceAndName	PLAY {NAMESPACE, "Play"}
	The `Play` directive signature. More...

static const NamespaceAndName	STOP {NAMESPACE, "Stop"}
	The `Stop` directive signature. More...

static const NamespaceAndName	CLEAR_QUEUE {NAMESPACE, "ClearQueue"}
	The `ClearQueue` directive signature. More...

static const NamespaceAndName	UPDATE_PROGRESS_REPORT_INTERVAL {NAMESPACE, "UpdateProgressReportInterval"}
	The `UpdateProgressReportInterval` directive signature. More...

static const NamespaceAndName	STATE {NAMESPACE, "PlaybackState"}
	The `AudioPlayer` context state signature. More...

static const std::string	CID_PREFIX {"cid:"}
	Prefix for content ID prefix in the url property of the directive payload. More...

static const char	TOKEN_KEY [] = "token"
	The token key used in `AudioPlayer` events. More...

static const char	OFFSET_KEY [] = "offsetInMilliseconds"
	The offset key used in `AudioPlayer` events. More...

static const char	PLAYBACK_ATTRIBUTES_KEY [] = "playbackAttributes"
	The playbackAttributes key used in `AudioPlayer` events. More...

static const char	NAME_KEY [] = "name"
	The name key used in `AudioPlayer` events. More...

static const char	CODEC_KEY [] = "codec"
	The codec key used in `AudioPlayer` events. More...

static const char	SAMPLING_RATE_IN_HERTZ_KEY [] = "samplingRateInHertz"
	The samplingRateInHertz key used in `AudioPlayer` events. More...

static const char	DATA_RATE_IN_BITS_PER_SECOND_KEY [] = "dataRateInBitsPerSecond"
	The dateRateInBitsPerSecond key used in `AudioPlayer` events. More...

static const char	PLAYBACK_REPORTS_KEY [] = "playbackReports"
	The playbackReports key used in `AudioPlayer` events. More...

static const char	START_OFFSET_KEY [] = "startOffsetInMilliseconds"
	The startOffsetInMilliseconds key used in `AudioPlayer` events. More...

static const char	END_OFFSET_KEY [] = "endOffsetInMilliseconds"
	The endOffsetInMilliseconds key used in `AudioPlayer` events. More...

static const char	ACTIVITY_KEY [] = "playerActivity"
	The activity key used in `AudioPlayer` events. More...

static const char	CAPTION_KEY [] = "caption"
	The key for the "captionData" property in the directive payload. More...

static const char	CAPTION_TYPE_KEY [] = "type"
	The key under "captionData" containing the caption type. More...

static const char	CAPTION_CONTENT_KEY [] = "content"
	The key under "captionData" containing the caption content. More...

static const char	STUTTER_DURATION_KEY [] = "stutterDurationInMilliseconds"
	The stutter key used in `AudioPlayer` events. More...

static const std::chrono::seconds	TIMEOUT {2}
	The duration to wait for a state change in `onFocusChanged` before failing. More...

static const audio::MixingBehavior	DEFAULT_MIXING_BEHAVIOR = audio::MixingBehavior::BEHAVIOR_PAUSE
	default mixing behavior More...

static const std::string	AUDIO_PLAYER_METRIC_PREFIX = "AUDIO_PLAYER-"
	prefix for metrics emitted from the AudioPlayer CA More...

static const std::string	UNSUPPORTED_INTERRUPTED_BEHAVIOR = "UNSUPPORTED_INTERRUPTED_BEHAVIOR_PLAY_DIRECTIVE"
	Metric to catch unsupported/missing interruptedBehavior. More...

static const std::string	MISSING_INTERRUPTED_BEHAVIOR = "MISSING_INTERRUPTED_BEHAVIOR_PLAY_DIRECTIVE"

static const std::string	PREPARE_PLAY_DIRECTIVE_RECEIVED = "PREPARE_PLAY_DIRECTIVE_RECEIVED"
	playback metrics use for AudioPlayer UPL 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...

static const std::string	PLAYBACK_STARTED = "PLAYBACK_STARTED"
	Metric used to trigger UPL recording for play. More...

static const std::string	PLAYBACK_STOPPED = "PLAYBACK_STOPPED"
	Metric used to trigger UPL recording for stop. More...

static const std::string	METADATA_UNFILTERED_ENCOUNTERED = "UnfilteredMetadataEncountered"
	Metrics for filtered and unfiltered metadata. More...

static const std::string	METADATA_FILTERED_ENCOUNTERED = "FilteredMetadataEncountered"

static const std::string	MEDIA_PLAYBACK_TIME = "MediaPlaybackTime"
	Total play time metric. More...

static const std::string	TRACK_TO_TRACK_TIME = "AutoProgressionLatency"
	Track to Track time metric. More...

static const std::string	TRACK_PROGRESSION_FATAL = "TrackProgressionFatalError"
	Playback error during auto-progression. More...

static const std::string	MID_PLAYBACK_FATAL = "PlaybackFatalError"
	Fatal error mid-playback. More...

static const std::string	TRACK_TIME_ON_QUEUE = "TrackTimeOnQueue"
	Time spent on queue. More...

static const std::vector< std::string >	METADATA_WHITELIST = {"title"}

static const std::chrono::seconds	METADATA_EVENT_RATE {1}
	Min time between metadata events. More...

Typedef Documentation

◆ MediaPlayerState

using alexaClientSDK::capabilityAgents::audioPlayer::MediaPlayerState = typedef avsCommon::utils::mediaPlayer::MediaPlayerState

Enumeration Type Documentation

◆ ClearBehavior

enum alexaClientSDK::capabilityAgents::audioPlayer::ClearBehavior

strong

Used to determine clear queue behavior.

Enumerator
CLEAR_ENQUEUED	Clears the queue and continues to play the currently playing stream.
CLEAR_ALL	Clears the entire playback queue and stops the currently playing stream (if applicable).

◆ StreamFormat

enum alexaClientSDK::capabilityAgents::audioPlayer::StreamFormat

strong

Specifies the format of a binary audio attachment in a Play directive.

Enumerator
AUDIO_MPEG	Audio is in mpeg format.
UNKNOWN	Audio is an unknown/unsupported format.

Function Documentation

◆ clearBehaviorToString()

std::string alexaClientSDK::capabilityAgents::audioPlayer::clearBehaviorToString ( ClearBehavior clearBehavior )

inline

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

Parameters

clearBehavior The ClearBehavior to convert.

Returns: The AVS-compliant string representation of clearBehavior.

◆ compareUrlNotQuery()

static bool alexaClientSDK::capabilityAgents::audioPlayer::compareUrlNotQuery	(	const std::string &	url1,
		const std::string &	url2
	)

static

Compare two URLs up to the 'query' portion, if one exists.

Parameters

url1	First URL to compare
url2	URL to compare to

Returns: true if the URLs are identical except for their query strings.

◆ convertToValue() [1/2]

bool alexaClientSDK::capabilityAgents::audioPlayer::convertToValue	(	const rapidjson::Value &	documentNode,
		StreamFormat *	streamFormat
	)

inline

Convert a StreamFormat to a rapidjson::Value.

Parameters

documentNode	The `rapidjson::Value` to write to.
streamFormat	The `StreamFormat` to convert.

Returns: true if conversion is successful, else false.

◆ convertToValue() [2/2]

bool alexaClientSDK::capabilityAgents::audioPlayer::convertToValue	(	const rapidjson::Value &	documentNode,
		ClearBehavior *	clearBehavior
	)

inline

Convert a ClearBehavior to a rapidjson::Value.

Parameters

documentNode	The `rapidjson::Value` to write to.
clearBehavior	The `ClearBehavior` to convert.

Returns: true if conversion is successful, else false.

◆ getAudioPlayerCapabilityConfiguration()

std::shared_ptr< CapabilityConfiguration > alexaClientSDK::capabilityAgents::audioPlayer::getAudioPlayerCapabilityConfiguration ( Fingerprint fingerprint )

static

Creates the AudioPlayer capability configuration.

Parameters

fingerprint The Fingerprint of MediaPlayer.

Returns: The AudioPlayer capability configuration.

◆ getMixingBehavior()

static audio::MixingBehavior alexaClientSDK::capabilityAgents::audioPlayer::getMixingBehavior	(	const std::string &	messageID,
		const rapidjson::Value &	payload,
		const std::shared_ptr< MetricRecorderInterface > &	metricRecorder
	)

static

◆ operator<<() [1/3]

std::ostream& alexaClientSDK::capabilityAgents::audioPlayer::operator<<	(	std::ostream &	stream,
		ProgressTimer::State	state
	)

Write a ProgressTimer::State value to an ostream as a string.

Parameters

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

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

◆ operator<<() [2/3]

std::ostream& alexaClientSDK::capabilityAgents::audioPlayer::operator<<	(	std::ostream &	stream,
		const StreamFormat &	streamFormat
	)

inline

Write a StreamFormat value to an ostream.

Parameters

stream	The stream to write the value to.
streamFormat	The `StreamFormat` value to write to the `ostream` as a string.

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

◆ operator<<() [3/3]

std::ostream& alexaClientSDK::capabilityAgents::audioPlayer::operator<<	(	std::ostream &	stream,
		const ClearBehavior &	clearBehavior
	)

inline

Write a ClearBehavior value to an ostream.

Parameters

stream	The stream to write the value to.
clearBehavior	The `ClearBehavior` value to write to the `ostream` as a string.

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

◆ streamFormatToString()

std::string alexaClientSDK::capabilityAgents::audioPlayer::streamFormatToString ( StreamFormat streamFormat )

inline

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

Parameters

streamFormat The StreamFormat to convert.

Returns: The AVS-compliant string representation of streamFormat.

◆ stringToClearBehavior()

bool alexaClientSDK::capabilityAgents::audioPlayer::stringToClearBehavior	(	const std::string &	text,
		ClearBehavior *	clearBehavior
	)

inline

Convert an AVS-compliant string to a ClearBehavior.

Parameters

	text	The string to convert.
[out]	clearBehavior	The converted `ClearBehavior`.

Returns: true if the string converted succesfully, else false.

◆ stringToStreamFormat()

bool alexaClientSDK::capabilityAgents::audioPlayer::stringToStreamFormat	(	const std::string &	text,
		StreamFormat *	streamFormat
	)

inline

Convert an AVS-compliant string to a StreamFormat.

Parameters

	text	The string to convert.
[out]	streamFormat	The converted `StreamFormat`.

Returns: true if the string converted succesfully, else false.

◆ submitAnnotatedMetric()

static void alexaClientSDK::capabilityAgents::audioPlayer::submitAnnotatedMetric	(	const std::shared_ptr< MetricRecorderInterface > &	metricRecorder,
		const std::string &	baseMetric,
		const std::string &	annotation
	)

static

◆ submitMetric()

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

static

◆ TAG() [1/2]

static const std::string alexaClientSDK::capabilityAgents::audioPlayer::TAG ( "ProgressTimer" )

static

String to identify log entries originating from this file.

◆ TAG() [2/2]

static const std::string alexaClientSDK::capabilityAgents::audioPlayer::TAG ( "AudioPlayer" )

static

String to identify log entries originating from this file.

Variable Documentation

◆ ACTIVITY_KEY

const char alexaClientSDK::capabilityAgents::audioPlayer::ACTIVITY_KEY[] = "playerActivity"

static

The activity key used in AudioPlayer events.

◆ AUDIO_PLAYER_METRIC_PREFIX

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

static

prefix for metrics emitted from the AudioPlayer CA

◆ AUDIOPLAYER_CAPABILITY_INTERFACE_NAME

const std::string alexaClientSDK::capabilityAgents::audioPlayer::AUDIOPLAYER_CAPABILITY_INTERFACE_NAME = "AudioPlayer"

static

AudioPlayer interface name.

◆ AUDIOPLAYER_CAPABILITY_INTERFACE_TYPE

const std::string alexaClientSDK::capabilityAgents::audioPlayer::AUDIOPLAYER_CAPABILITY_INTERFACE_TYPE = "AlexaInterface"

static

AudioPlayer capability constants AudioPlayer interface type

◆ AUDIOPLAYER_CAPABILITY_INTERFACE_VERSION

const std::string alexaClientSDK::capabilityAgents::audioPlayer::AUDIOPLAYER_CAPABILITY_INTERFACE_VERSION = "1.4"

static

AudioPlayer interface version.

◆ BUILD_TYPE_KEY

const std::string alexaClientSDK::capabilityAgents::audioPlayer::BUILD_TYPE_KEY = "buildType"

static

The buildType key used in AudioPlayer fingerprint.

◆ CAPTION_CONTENT_KEY

const char alexaClientSDK::capabilityAgents::audioPlayer::CAPTION_CONTENT_KEY[] = "content"

static

The key under "captionData" containing the caption content.

◆ CAPTION_KEY

const char alexaClientSDK::capabilityAgents::audioPlayer::CAPTION_KEY[] = "caption"

static

The key for the "captionData" property in the directive payload.

◆ CAPTION_TYPE_KEY

const char alexaClientSDK::capabilityAgents::audioPlayer::CAPTION_TYPE_KEY[] = "type"

static

The key under "captionData" containing the caption type.

◆ CHANNEL_NAME

const std::string alexaClientSDK::capabilityAgents::audioPlayer::CHANNEL_NAME = FocusManagerInterface::CONTENT_CHANNEL_NAME

static

The name of the FocusManager channel used by AudioPlayer.

◆ CID_PREFIX

const std::string alexaClientSDK::capabilityAgents::audioPlayer::CID_PREFIX {"cid:"}

static

Prefix for content ID prefix in the url property of the directive payload.

◆ CLEAR_QUEUE

const NamespaceAndName alexaClientSDK::capabilityAgents::audioPlayer::CLEAR_QUEUE {NAMESPACE, "ClearQueue"}

static

The ClearQueue directive signature.

◆ CODEC_KEY

const char alexaClientSDK::capabilityAgents::audioPlayer::CODEC_KEY[] = "codec"

static

The codec key used in AudioPlayer events.

◆ DATA_RATE_IN_BITS_PER_SECOND_KEY

const char alexaClientSDK::capabilityAgents::audioPlayer::DATA_RATE_IN_BITS_PER_SECOND_KEY[] = "dataRateInBitsPerSecond"

static

The dateRateInBitsPerSecond key used in AudioPlayer events.

◆ DEFAULT_MIXING_BEHAVIOR

const audio::MixingBehavior alexaClientSDK::capabilityAgents::audioPlayer::DEFAULT_MIXING_BEHAVIOR = audio::MixingBehavior::BEHAVIOR_PAUSE

static

default mixing behavior

◆ END_OFFSET_KEY

const char alexaClientSDK::capabilityAgents::audioPlayer::END_OFFSET_KEY[] = "endOffsetInMilliseconds"

static

The endOffsetInMilliseconds key used in AudioPlayer events.

◆ ERROR_SOURCE_ID

const AudioPlayer::SourceId alexaClientSDK::capabilityAgents::audioPlayer::ERROR_SOURCE_ID = MediaPlayerInterface::ERROR

static

A link to MediaPlayerInterface::ERROR.

◆ FINGERPRINT_KEY

const std::string alexaClientSDK::capabilityAgents::audioPlayer::FINGERPRINT_KEY = "fingerprint"

static

The fingerprint key used in AudioPlayer configurations.

◆ MEDIA_PLAYBACK_TIME

const std::string alexaClientSDK::capabilityAgents::audioPlayer::MEDIA_PLAYBACK_TIME = "MediaPlaybackTime"

static

Total play time metric.

◆ METADATA_EVENT_RATE

const std::chrono::seconds alexaClientSDK::capabilityAgents::audioPlayer::METADATA_EVENT_RATE {1}

static

Min time between metadata events.

◆ METADATA_FILTERED_ENCOUNTERED

const std::string alexaClientSDK::capabilityAgents::audioPlayer::METADATA_FILTERED_ENCOUNTERED = "FilteredMetadataEncountered"

static

◆ METADATA_UNFILTERED_ENCOUNTERED

const std::string alexaClientSDK::capabilityAgents::audioPlayer::METADATA_UNFILTERED_ENCOUNTERED = "UnfilteredMetadataEncountered"

static

Metrics for filtered and unfiltered metadata.

◆ METADATA_WHITELIST

const std::vector<std::string> alexaClientSDK::capabilityAgents::audioPlayer::METADATA_WHITELIST = {"title"}

static

whitelisted metadata to send to server. This is done to avoid excessive traffic must be all lower-case

◆ MID_PLAYBACK_FATAL

const std::string alexaClientSDK::capabilityAgents::audioPlayer::MID_PLAYBACK_FATAL = "PlaybackFatalError"

static

Fatal error mid-playback.

◆ MISSING_INTERRUPTED_BEHAVIOR

const std::string alexaClientSDK::capabilityAgents::audioPlayer::MISSING_INTERRUPTED_BEHAVIOR = "MISSING_INTERRUPTED_BEHAVIOR_PLAY_DIRECTIVE"

static

◆ NAME_KEY

const char alexaClientSDK::capabilityAgents::audioPlayer::NAME_KEY[] = "name"

static

The name key used in AudioPlayer events.

◆ NAMESPACE

const std::string alexaClientSDK::capabilityAgents::audioPlayer::NAMESPACE = "AudioPlayer"

static

The namespace for this capability agent.

◆ OFFSET_KEY

const char alexaClientSDK::capabilityAgents::audioPlayer::OFFSET_KEY[] = "offsetInMilliseconds"

static

The offset key used in AudioPlayer events.

◆ PACKAGE_KEY

const std::string alexaClientSDK::capabilityAgents::audioPlayer::PACKAGE_KEY = "package"

static

The package key used in AudioPlayer fingerprint.

◆ PLAY

const NamespaceAndName alexaClientSDK::capabilityAgents::audioPlayer::PLAY {NAMESPACE, "Play"}

static

The Play directive signature.

◆ PLAY_DIRECTIVE_RECEIVED

const std::string alexaClientSDK::capabilityAgents::audioPlayer::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_ATTRIBUTES_KEY

const char alexaClientSDK::capabilityAgents::audioPlayer::PLAYBACK_ATTRIBUTES_KEY[] = "playbackAttributes"

static

The playbackAttributes key used in AudioPlayer events.

◆ PLAYBACK_REPORTS_KEY

const char alexaClientSDK::capabilityAgents::audioPlayer::PLAYBACK_REPORTS_KEY[] = "playbackReports"

static

The playbackReports key used in AudioPlayer events.

◆ PLAYBACK_STARTED

const std::string alexaClientSDK::capabilityAgents::audioPlayer::PLAYBACK_STARTED = "PLAYBACK_STARTED"

static

Metric used to trigger UPL recording for play.

◆ PLAYBACK_STOPPED

const std::string alexaClientSDK::capabilityAgents::audioPlayer::PLAYBACK_STOPPED = "PLAYBACK_STOPPED"

static

Metric used to trigger UPL recording for stop.

◆ PREPARE_PLAY_DIRECTIVE_RECEIVED

const std::string alexaClientSDK::capabilityAgents::audioPlayer::PREPARE_PLAY_DIRECTIVE_RECEIVED = "PREPARE_PLAY_DIRECTIVE_RECEIVED"

static

playback metrics use for AudioPlayer UPL

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

◆ SAMPLING_RATE_IN_HERTZ_KEY

const char alexaClientSDK::capabilityAgents::audioPlayer::SAMPLING_RATE_IN_HERTZ_KEY[] = "samplingRateInHertz"

static

The samplingRateInHertz key used in AudioPlayer events.

◆ START_OFFSET_KEY

const char alexaClientSDK::capabilityAgents::audioPlayer::START_OFFSET_KEY[] = "startOffsetInMilliseconds"

static

The startOffsetInMilliseconds key used in AudioPlayer events.

◆ STATE

const NamespaceAndName alexaClientSDK::capabilityAgents::audioPlayer::STATE {NAMESPACE, "PlaybackState"}

static

The AudioPlayer context state signature.

◆ STOP

const NamespaceAndName alexaClientSDK::capabilityAgents::audioPlayer::STOP {NAMESPACE, "Stop"}

static

The Stop directive signature.

◆ STOP_DIRECTIVE_RECEIVED

const std::string alexaClientSDK::capabilityAgents::audioPlayer::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.

◆ STUTTER_DURATION_KEY

const char alexaClientSDK::capabilityAgents::audioPlayer::STUTTER_DURATION_KEY[] = "stutterDurationInMilliseconds"

static

The stutter key used in AudioPlayer events.

◆ TIMEOUT

const std::chrono::seconds alexaClientSDK::capabilityAgents::audioPlayer::TIMEOUT {2}

static

The duration to wait for a state change in onFocusChanged before failing.

◆ TOKEN_KEY

const char alexaClientSDK::capabilityAgents::audioPlayer::TOKEN_KEY[] = "token"

static

The token key used in AudioPlayer events.

◆ TRACK_PROGRESSION_FATAL

const std::string alexaClientSDK::capabilityAgents::audioPlayer::TRACK_PROGRESSION_FATAL = "TrackProgressionFatalError"

static

Playback error during auto-progression.

◆ TRACK_TIME_ON_QUEUE

const std::string alexaClientSDK::capabilityAgents::audioPlayer::TRACK_TIME_ON_QUEUE = "TrackTimeOnQueue"

static

Time spent on queue.

◆ TRACK_TO_TRACK_TIME

const std::string alexaClientSDK::capabilityAgents::audioPlayer::TRACK_TO_TRACK_TIME = "AutoProgressionLatency"

static

Track to Track time metric.

◆ UNSUPPORTED_INTERRUPTED_BEHAVIOR

const std::string alexaClientSDK::capabilityAgents::audioPlayer::UNSUPPORTED_INTERRUPTED_BEHAVIOR = "UNSUPPORTED_INTERRUPTED_BEHAVIOR_PLAY_DIRECTIVE"

static

Metric to catch unsupported/missing interruptedBehavior.

◆ UPDATE_PROGRESS_REPORT_INTERVAL

const NamespaceAndName alexaClientSDK::capabilityAgents::audioPlayer::UPDATE_PROGRESS_REPORT_INTERVAL {NAMESPACE, "UpdateProgressReportInterval"}

static

The UpdateProgressReportInterval directive signature.

◆ VERSION_NUMBER_KEY

const std::string alexaClientSDK::capabilityAgents::audioPlayer::VERSION_NUMBER_KEY = "versionNumber"

static

The versionNumber key used in AudioPlayer fingerprint.

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Typedef Documentation

◆ MediaPlayerState

Enumeration Type Documentation

◆ ClearBehavior

◆ StreamFormat

Function Documentation

◆ clearBehaviorToString()

◆ compareUrlNotQuery()

◆ convertToValue() [1/2]

◆ convertToValue() [2/2]

◆ getAudioPlayerCapabilityConfiguration()

◆ getMixingBehavior()

◆ operator<<() [1/3]

◆ operator<<() [2/3]

◆ operator<<() [3/3]

◆ streamFormatToString()

◆ stringToClearBehavior()

◆ stringToStreamFormat()

◆ submitAnnotatedMetric()

◆ submitMetric()

◆ TAG() [1/2]

◆ TAG() [2/2]

Variable Documentation

◆ ACTIVITY_KEY

◆ AUDIO_PLAYER_METRIC_PREFIX

◆ AUDIOPLAYER_CAPABILITY_INTERFACE_NAME

◆ AUDIOPLAYER_CAPABILITY_INTERFACE_TYPE

◆ AUDIOPLAYER_CAPABILITY_INTERFACE_VERSION

◆ BUILD_TYPE_KEY

◆ CAPTION_CONTENT_KEY

◆ CAPTION_KEY

◆ CAPTION_TYPE_KEY

◆ CHANNEL_NAME

◆ CID_PREFIX

◆ CLEAR_QUEUE

◆ CODEC_KEY

◆ DATA_RATE_IN_BITS_PER_SECOND_KEY

◆ DEFAULT_MIXING_BEHAVIOR

◆ END_OFFSET_KEY

◆ ERROR_SOURCE_ID

◆ FINGERPRINT_KEY

◆ MEDIA_PLAYBACK_TIME

◆ METADATA_EVENT_RATE

◆ METADATA_FILTERED_ENCOUNTERED

◆ METADATA_UNFILTERED_ENCOUNTERED

◆ METADATA_WHITELIST

◆ MID_PLAYBACK_FATAL

◆ MISSING_INTERRUPTED_BEHAVIOR

◆ NAME_KEY

◆ NAMESPACE

◆ OFFSET_KEY

◆ PACKAGE_KEY

◆ PLAY

◆ PLAY_DIRECTIVE_RECEIVED

◆ PLAYBACK_ATTRIBUTES_KEY

◆ PLAYBACK_REPORTS_KEY

◆ PLAYBACK_STARTED

◆ PLAYBACK_STOPPED

◆ PREPARE_PLAY_DIRECTIVE_RECEIVED

◆ SAMPLING_RATE_IN_HERTZ_KEY

◆ START_OFFSET_KEY

◆ STATE

◆ STOP

◆ STOP_DIRECTIVE_RECEIVED

◆ STUTTER_DURATION_KEY

◆ TIMEOUT

◆ TOKEN_KEY

◆ TRACK_PROGRESSION_FATAL

◆ TRACK_TIME_ON_QUEUE

◆ TRACK_TO_TRACK_TIME

◆ UNSUPPORTED_INTERRUPTED_BEHAVIOR

◆ UPDATE_PROGRESS_REPORT_INTERVAL

◆ VERSION_NUMBER_KEY