![]() |
AlexaClientSDK
1.22.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
|
Namespaces | |
test | |
Classes | |
class | SpeechSynthesizer |
Typedefs | |
using | MediaPlayerState = avsCommon::utils::mediaPlayer::MediaPlayerState |
Functions | |
static std::shared_ptr< avsCommon::avs::CapabilityConfiguration > | getSpeechSynthesizerCapabilityConfiguration () |
Variables | |
static const constexpr char * | SPEAK_MEDIA_PLAYER_NAME = "SpeakMediaPlayer" |
String to identify the speak media player to render audio. More... | |
static const std::string | SPEECHSYNTHESIZER_CAPABILITY_INTERFACE_TYPE = "AlexaInterface" |
static const std::string | SPEECHSYNTHESIZER_CAPABILITY_INTERFACE_NAME = "SpeechSynthesizer" |
SpeechSynthesizer interface name. More... | |
static const std::string | SPEECHSYNTHESIZER_CAPABILITY_INTERFACE_VERSION = "1.3" |
SpeechSynthesizer interface version. More... | |
static const std::string | TAG {"SpeechSynthesizer"} |
String to identify log entries originating from this file. More... | |
static const std::string | NAMESPACE {"SpeechSynthesizer"} |
The namespace for the SpeechSynthesizer capability agent. More... | |
static const NamespaceAndName | SPEAK {NAMESPACE, "Speak"} |
The Speak directive signature. More... | |
static const NamespaceAndName | CONTEXT_MANAGER_SPEECH_STATE {NAMESPACE, "SpeechState"} |
The state information NamespaceAndName to send to the ContextManager . More... | |
static const std::string | CHANNEL_NAME = FocusManagerInterface::DIALOG_CHANNEL_NAME |
The name of the FocusManager channel used by the SpeechSynthesizer . More... | |
static std::string | SPEECH_STARTED_EVENT_NAME {"SpeechStarted"} |
The name of the event to send to the AVS server once audio starting playing. More... | |
static std::string | SPEECH_FINISHED_EVENT_NAME {"SpeechFinished"} |
The name of the event to send to the AVS server once audio finishes playing. More... | |
static std::string | SPEECH_INTERRUPTED_EVENT_NAME {"SpeechInterrupted"} |
The name of the event to send to the AVS server once audio playing has been interrupted. More... | |
static const char | KEY_URL [] = "url" |
The key used to look up the "url" property in the directive payload. More... | |
static const char | KEY_TOKEN [] = "token" |
The key for the "token" property in the directive payload string and "SpeechState" string. More... | |
static const char | KEY_FORMAT [] = "format" |
The key used to look the "format" property in the directive payload string. More... | |
static const char | KEY_CAPTION [] = "caption" |
The key for the "captionData" property in the directive payload. More... | |
static const char | KEY_CAPTION_TYPE [] = "type" |
The key under "captionData" containing the caption type. More... | |
static const char | KEY_CAPTION_CONTENT [] = "content" |
The key under "captionData" containing the caption content. More... | |
static const char | KEY_PLAY_BEHAVIOR [] = "playBehavior" |
The key used to look the "playBehavior" property in the directive payload string. More... | |
static const std::string | FORMAT {"AUDIO_MPEG"} |
The expected format value in the directive payload. 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 | KEY_OFFSET_IN_MILLISECONDS [] = "offsetInMilliseconds" |
The key for the "offsetInMilliseconds" property in the event context. More... | |
static const char | KEY_PLAYER_ACTIVITY [] = "playerActivity" |
The "playerActivity" key used to build "SpeechState" string. More... | |
static const char | KEY_ANALYZERS [] = "analyzers" |
The "analyzers" key used to retrieve analyzer data from directive. More... | |
static const char | KEY_ANALYZERS_INTERFACE [] = "interface" |
The key used to retrieve the audio analyzer name from directive. More... | |
static const char | KEY_ANALYZERS_ENABLED [] = "enabled" |
The key used to retrieve the audio analyzer enabled state from directive. More... | |
static const char | PLAYER_STATE_PLAYING [] = "PLAYING" |
The player activity value used to build the "SpeechState" string. More... | |
static const char | PLAYER_STATE_FINISHED [] = "FINISHED" |
The player activity value used to build the "SpeechState" string. More... | |
static const char | PLAYER_STATE_INTERRUPTED [] = "INTERRUPTED" |
The player activity value used to build the "SpeechState" string. More... | |
static const std::chrono::seconds | STATE_CHANGE_TIMEOUT {5} |
The duration to wait for a state change in onFocusChanged before failing. More... | |
static const std::string | POWER_RESOURCE_COMPONENT_NAME {"SpeechSynthesizer"} |
The component name of power resource. More... | |
static const std::string | SPEECH_SYNTHESIZER_METRIC_PREFIX = "SPEECH_SYNTHESIZER-" |
Metric prefix for SpeechSynthesizer metric source. More... | |
static const std::string | FIRST_BYTES_AUDIO = "FIRST_BYTES_AUDIO" |
Metric to emit when received first audio bytes. More... | |
static const std::string | TTS_STARTED = "TTS_STARTED" |
Metric to emit at the start of TTS. More... | |
static const std::string | TTS_FINISHED = "TTS_FINISHED" |
Metric to emit when TTS finishes. More... | |
static const std::string | DIALOG_REQUEST_ID_KEY = "DIALOG_REQUEST_ID" |
Key name for the dialogRequestId metric information. More... | |
static const std::string | BUFFER_UNDERRUN = "ERROR.TTS_BUFFER_UNDERRUN" |
Metric to emit on TTS buffer underrrun. More... | |
using alexaClientSDK::capabilityAgents::speechSynthesizer::MediaPlayerState = typedef avsCommon::utils::mediaPlayer::MediaPlayerState |
|
static |
Creates the SpeechSynthesizer capability configuration.
|
static |
Metric to emit on TTS buffer underrrun.
|
static |
The name of the FocusManager
channel used by the SpeechSynthesizer
.
|
static |
Prefix for content ID prefix in the url property of the directive payload.
|
static |
The state information NamespaceAndName
to send to the ContextManager
.
|
static |
Key name for the dialogRequestId metric information.
|
static |
Metric to emit when received first audio bytes.
|
static |
The expected format value in the directive payload.
|
static |
The "analyzers" key used to retrieve analyzer data from directive.
|
static |
The key used to retrieve the audio analyzer enabled state from directive.
|
static |
The key used to retrieve the audio analyzer name from directive.
|
static |
The key for the "captionData" property in the directive payload.
|
static |
The key under "captionData" containing the caption content.
|
static |
The key under "captionData" containing the caption type.
|
static |
The key used to look the "format" property in the directive payload string.
|
static |
The key for the "offsetInMilliseconds" property in the event context.
|
static |
The key used to look the "playBehavior" property in the directive payload string.
|
static |
The "playerActivity" key used to build "SpeechState" string.
|
static |
The key for the "token" property in the directive payload string and "SpeechState" string.
|
static |
The key used to look up the "url" property in the directive payload.
|
static |
The namespace for the SpeechSynthesizer
capability agent.
|
static |
The player activity value used to build the "SpeechState" string.
|
static |
The player activity value used to build the "SpeechState" string.
|
static |
The player activity value used to build the "SpeechState" string.
|
static |
The component name of power resource.
|
static |
The Speak
directive signature.
|
staticconstexpr |
String to identify the speak media player to render audio.
|
static |
The name of the event to send to the AVS server once audio finishes playing.
|
static |
The name of the event to send to the AVS server once audio playing has been interrupted.
|
static |
The name of the event to send to the AVS server once audio starting playing.
|
static |
Metric prefix for SpeechSynthesizer metric source.
|
static |
SpeechSynthesizer interface name.
|
static |
SpeechSynthesizer capability constants SpeechSynthesizer interface type
|
static |
SpeechSynthesizer interface version.
|
static |
The duration to wait for a state change in onFocusChanged
before failing.
|
static |
String to identify log entries originating from this file.
|
static |
Metric to emit when TTS finishes.
|
static |
Metric to emit at the start of TTS.
AlexaClientSDK 1.22.0 - Copyright 2016-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0