![]() |
AlexaClientSDK
1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
|
Namespaces | |
android | |
test | |
Classes | |
class | AttachmentReaderSource |
class | BaseStreamSource |
class | IStreamSource |
class | MediaPlayer |
class | Normalizer |
class | OffsetManager |
class | PipelineInterface |
class | PooledMediaPlayerFactory |
class | SourceInterface |
class | SourceObserverInterface |
Typedefs | |
typedef std::vector< avsCommon::utils::mediaPlayer::MediaPlayerObserverInterface::TagKeyValueType > | VectorOfTags |
using | MediaPlayerState = avsCommon::utils::mediaPlayer::MediaPlayerState |
Functions | |
static const std::string | TAG ("PooledMediaPlayerFactory") |
avsCommon::utils::mediaPlayer::ErrorType | gerrorToErrorType (const GError *error, bool remoteResource) |
static const std::string | TAG ("AttachmentReaderSource") |
String to identify log entries originating from this file. More... | |
static const unsigned int | CHUNK_SIZE (4096) |
The number of bytes read from the attachment with each read in the read loop. More... | |
static const std::string | TAG ("BaseStreamSource") |
String to identify log entries originating from this file. More... | |
static std::string | getCapsString (const AudioFormat &audioFormat) |
static avsCommon::utils::mediaPlayer::ErrorType | gstCoreErrorToErrorType (const GstCoreError &error) |
static avsCommon::utils::mediaPlayer::ErrorType | gstLibraryErrorToErrorType (const GstLibraryError &error) |
static avsCommon::utils::mediaPlayer::ErrorType | gstResourceErrorToErrorType (const GstResourceError &error, bool remoteResource) |
static avsCommon::utils::mediaPlayer::ErrorType | gstStreamErrorToErrorType (const GstStreamError &error) |
static const std::string | TAG ("IStreamSource") |
String to identify log entries originating from this file. More... | |
static const unsigned int | CHUNK_SIZE (4096) |
The number of bytes read from the attachment with each read in the read loop. More... | |
static const std::string | TAG ("MediaPlayer") |
String to identify log entries originating from this file. More... | |
static const unsigned int | TIMEOUT_ZERO_NANOSECONDS (0) |
Timeout value for calls to gst_element_get_state() calls. More... | |
static void | collectOneTag (const GstTagList *tagList, const gchar *tag, gpointer pointerToMutableVectorOfTags) |
static short | gainInsideLimit (short gain) |
static const std::string | TAG ("Normalizer") |
String to identify log entries originating from this file. More... | |
static const std::string | TAG ("OffsetManager") |
String to identify log entries originating from this file. More... | |
Variables | |
static const guint | RETRY_INTERVALS_MILLISECONDS [] = {0, 10, 10, 10, 20, 20, 50, 100} |
The interval to wait (in milliseconds) between successive attempts to read audio data when none is available. More... | |
static const std::string | MEDIAPLAYER_CONFIGURATION_ROOT_KEY = "gstreamerMediaPlayer" |
static const std::string | MEDIAPLAYER_AUDIO_SINK_KEY = "audioSink" |
The key in our config file to set the audioSink. More... | |
static const std::string | MEDIAPLAYER_OUTPUT_CONVERSION_ROOT_KEY = "outputConversion" |
The key in our config file to find the output conversion type. More... | |
static const std::unordered_map< std::string, int > | MEDIAPLAYER_ACCEPTED_KEYS |
static std::atomic< MediaPlayer::SourceId > | g_id {1} |
A counter used to increment the source id when a new source is set. More... | |
static const MediaPlayer::SourceId | ERROR_SOURCE_ID = MediaPlayer::ERROR |
A link to MediaPlayerInterface::ERROR . More... | |
static const guint | UNQUEUED_CALLBACK = guint(0) |
A value to indicate an unqueued callback. g_idle_add() only returns ids >= 0. More... | |
static const int8_t | GST_SET_VOLUME_MIN = 0 |
GStreamer Volume Element Minimum. More... | |
static const int8_t | GST_SET_VOLUME_MAX = 1 |
GStreamer Volume Element Maximum. More... | |
static const gdouble | GST_CONTROL_VOLUME_FACTOR = 1000 |
GStreamer Timed Volume Control Element factor. More... | |
static const gdouble | VOLUME_ZERO = 0.0000001 |
Represents the zero volume to avoid the actual 0.0 value. Used as a fix for GStreamer crashing on 0 volume for PCM. More... | |
static const int | MIN_EQUALIZER_LEVEL = -24 |
Mimimum level for equalizer bands. More... | |
static const int | MAX_EQUALIZER_LEVEL = 12 |
Maximum level for equalizer bands. More... | |
static char | GSTREAMER_BASS_BAND_NAME [] = "band0" |
The GStreamer property name for the frequency band 100 Hz. More... | |
static char | GSTREAMER_MIDRANGE_BAND_NAME [] = "band1" |
The GStreamer property name for the frequency band 1.1 kHz. More... | |
static char | GSTREAMER_TREBLE_BAND_NAME [] = "band2" |
The GStreamer property name for the frequency band 11 kHz. More... | |
static constexpr size_t | NUM_OF_CONTENT_READERS = 2 |
using alexaClientSDK::mediaPlayer::MediaPlayerState = typedef avsCommon::utils::mediaPlayer::MediaPlayerState |
typedef std::vector<avsCommon::utils::mediaPlayer::MediaPlayerObserverInterface::TagKeyValueType> alexaClientSDK::mediaPlayer::VectorOfTags |
|
static |
The number of bytes read from the attachment with each read in the read loop.
|
static |
The number of bytes read from the attachment with each read in the read loop.
|
static |
Processes tags found in the tagList. Called through gst_tag_list_foreach.
tagList | List of tags to iterate over. |
tag | A specific tag from the tag list. |
pointerToMutableVectorOfTags | Pointer to VectorOfTags. Use push_back to preserve order. |
|
inlinestatic |
avsCommon::utils::mediaPlayer::ErrorType alexaClientSDK::mediaPlayer::gerrorToErrorType | ( | const GError * | error, |
bool | remoteResource | ||
) |
Convert a GStreamer GError
to an ErrorType
.
error | The GError to convert. |
remoteResource | Indicates whether it should be for a resource that is remote. |
ErrorType
.
|
static |
Method that returns a string to be used in CAPS negotiation (generating right PADS between gstreamer elements based on audio data.) For raw PCM data without header audioFormat information needs to be passed explicitly for a mediaplayer to interpret the audio bytes.
|
static |
|
static |
|
static |
|
static |
|
static |
String to identify log entries originating from this file.
|
static |
String to identify log entries originating from this file.
|
static |
String to identify log entries originating from this file.
|
static |
String to identify log entries originating from this file.
|
static |
String to identify log entries originating from this file.
|
static |
String to identify log entries originating from this file.
|
static |
|
static |
Timeout value for calls to gst_element_get_state()
calls.
|
static |
A link to MediaPlayerInterface::ERROR
.
|
static |
A counter used to increment the source id when a new source is set.
|
static |
GStreamer Timed Volume Control Element factor.
|
static |
GStreamer Volume Element Maximum.
|
static |
GStreamer Volume Element Minimum.
|
static |
The GStreamer property name for the frequency band 100 Hz.
|
static |
The GStreamer property name for the frequency band 1.1 kHz.
|
static |
The GStreamer property name for the frequency band 11 kHz.
|
static |
Maximum level for equalizer bands.
|
static |
The acceptable conversion keys to find in the config file Key strings are mapped to gstreamer capabilities documented here: https://gstreamer.freedesktop.org/documentation/design/mediatype-audio-raw.html
|
static |
The key in our config file to set the audioSink.
|
static |
|
static |
The key in our config file to find the output conversion type.
|
static |
Mimimum level for equalizer bands.
|
staticconstexpr |
Number of readers for UrlContentToAttachmentConverter. We have 2 readers to have an additional parked reader, to ensure that the whole of SDS buffer is conserved until the seek() is called.
|
static |
The interval to wait (in milliseconds) between successive attempts to read audio data when none is available.
|
static |
A value to indicate an unqueued callback. g_idle_add() only returns ids >= 0.
|
static |
Represents the zero volume to avoid the actual 0.0 value. Used as a fix for GStreamer crashing on 0 volume for PCM.
AlexaClientSDK 1.26.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0