AlexaClientSDK
1.19.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
|
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... | |
using alexaClientSDK::capabilityAgents::audioPlayer::MediaPlayerState = typedef avsCommon::utils::mediaPlayer::MediaPlayerState |
|
inline |
Convert a ClearBehavior
to an AVS-compliant std::string
.
clearBehavior | The ClearBehavior to convert. |
clearBehavior
.
|
static |
Compare two URLs up to the 'query' portion, if one exists.
url1 | First URL to compare |
url2 | URL to compare to |
|
inline |
Convert a StreamFormat
to a rapidjson::Value
.
documentNode | The rapidjson::Value to write to. |
streamFormat | The StreamFormat to convert. |
true
if conversion is successful, else false
.
|
inline |
Convert a ClearBehavior
to a rapidjson::Value
.
documentNode | The rapidjson::Value to write to. |
clearBehavior | The ClearBehavior to convert. |
true
if conversion is successful, else false
.
|
static |
Creates the AudioPlayer capability configuration.
fingerprint | The Fingerprint of MediaPlayer . |
|
static |
std::ostream& alexaClientSDK::capabilityAgents::audioPlayer::operator<< | ( | std::ostream & | stream, |
ProgressTimer::State | state | ||
) |
Write a ProgressTimer::State
value to an ostream
as a string.
stream | The stream to write the value to. |
state | The state to write to the ostream as a string. |
ostream
that was passed in and written to.
|
inline |
Write a StreamFormat
value to an ostream
.
stream | The stream to write the value to. |
streamFormat | The StreamFormat value to write to the ostream as a string. |
ostream
that was passed in and written to.
|
inline |
Write a ClearBehavior
value to an ostream
.
stream | The stream to write the value to. |
clearBehavior | The ClearBehavior value to write to the ostream as a string. |
ostream
that was passed in and written to.
|
inline |
Convert a StreamFormat
to an AVS-compliant std::string
.
streamFormat | The StreamFormat to convert. |
streamFormat
.
|
inline |
Convert an AVS-compliant string
to a ClearBehavior
.
text | The string to convert. | |
[out] | clearBehavior | The converted ClearBehavior . |
true
if the string converted succesfully, else false
.
|
inline |
Convert an AVS-compliant string
to a StreamFormat
.
text | The string to convert. | |
[out] | streamFormat | The converted StreamFormat . |
true
if the string converted succesfully, else false
.
|
static |
|
static |
|
static |
String to identify log entries originating from this file.
|
static |
String to identify log entries originating from this file.
|
static |
The activity key used in AudioPlayer
events.
|
static |
prefix for metrics emitted from the AudioPlayer CA
|
static |
AudioPlayer interface name.
|
static |
AudioPlayer capability constants AudioPlayer interface type
|
static |
AudioPlayer interface version.
|
static |
The buildType key used in AudioPlayer
fingerprint.
|
static |
The key under "captionData" containing the caption content.
|
static |
The key for the "captionData" property in the directive payload.
|
static |
The key under "captionData" containing the caption type.
|
static |
The name of the FocusManager
channel used by AudioPlayer
.
|
static |
Prefix for content ID prefix in the url property of the directive payload.
|
static |
The ClearQueue
directive signature.
|
static |
The codec key used in AudioPlayer
events.
|
static |
The dateRateInBitsPerSecond key used in AudioPlayer
events.
|
static |
default mixing behavior
|
static |
The endOffsetInMilliseconds key used in AudioPlayer
events.
|
static |
A link to MediaPlayerInterface::ERROR
.
|
static |
The fingerprint key used in AudioPlayer
configurations.
|
static |
Total play time metric.
|
static |
Min time between metadata events.
|
static |
|
static |
Metrics for filtered and unfiltered metadata.
|
static |
whitelisted metadata to send to server. This is done to avoid excessive traffic must be all lower-case
|
static |
Fatal error mid-playback.
|
static |
|
static |
The name key used in AudioPlayer
events.
|
static |
The namespace for this capability agent.
|
static |
The offset key used in AudioPlayer
events.
|
static |
The package key used in AudioPlayer
fingerprint.
|
static |
The Play
directive signature.
|
static |
The directive received metric is used in place of 'first bytes' for UPL because pre-buffering may distort the metric.
|
static |
The playbackAttributes key used in AudioPlayer
events.
|
static |
The playbackReports key used in AudioPlayer
events.
|
static |
Metric used to trigger UPL recording for play.
|
static |
Metric used to trigger UPL recording for stop.
|
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
|
static |
The samplingRateInHertz key used in AudioPlayer
events.
|
static |
The startOffsetInMilliseconds key used in AudioPlayer
events.
|
static |
The AudioPlayer
context state signature.
|
static |
The Stop
directive signature.
|
static |
The directive received metric is used in place of 'first bytes' for Stop UPL because there are no bytes involved.
|
static |
The stutter key used in AudioPlayer
events.
|
static |
The duration to wait for a state change in onFocusChanged
before failing.
|
static |
The token key used in AudioPlayer
events.
|
static |
Playback error during auto-progression.
|
static |
Time spent on queue.
|
static |
Track to Track time metric.
|
static |
Metric to catch unsupported/missing interruptedBehavior.
|
static |
The UpdateProgressReportInterval
directive signature.
|
static |
The versionNumber key used in AudioPlayer
fingerprint.
AlexaClientSDK 1.19.0 - Copyright 2016-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0