![]() |
AlexaClientSDK
1.22.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
|
Namespaces | |
test | |
Classes | |
class | AudioInputProcessor |
struct | AudioProvider |
Enumerations | |
enum | ASRProfile { ASRProfile::CLOSE_TALK, ASRProfile::NEAR_FIELD, ASRProfile::FAR_FIELD } |
enum | Initiator { Initiator::PRESS_AND_HOLD, Initiator::TAP, Initiator::WAKEWORD } |
Functions | |
std::ostream & | operator<< (std::ostream &stream, ASRProfile profile) |
std::string | asrProfileToString (ASRProfile profile) |
std::string | initiatorToString (Initiator initiator) |
static const std::string | TAG ("AudioInputProcessor") |
String to identify log entries originating from this file. More... | |
static void | submitMetric (const std::shared_ptr< MetricRecorderInterface > &metricRecorder, MetricEventBuilder &metricEventBuilder, const std::string &dialogRequestId="") |
static void | submitMetric (const std::shared_ptr< MetricRecorderInterface > metricRecorder, const std::string &activityName, const DataPoint &dataPoint, const std::shared_ptr< AVSDirective > &directive=nullptr) |
static std::shared_ptr< avsCommon::avs::CapabilityConfiguration > | getSpeechRecognizerCapabilityConfiguration (const LocaleAssetsManagerInterface &assetsManager) |
std::string | generateSupportedWakeWordsJson (const std::string &scope, const LocaleAssetsManagerInterface::WakeWordsSets &wakeWordsCombination) |
Variables | |
static const std::string | SPEECHRECOGNIZER_CAPABILITY_INTERFACE_TYPE = "AlexaInterface" |
static const std::string | SPEECHRECOGNIZER_CAPABILITY_INTERFACE_NAME = "SpeechRecognizer" |
SpeechRecognizer interface name. More... | |
static const std::string | SPEECHRECOGNIZER_CAPABILITY_INTERFACE_VERSION = "2.3" |
SpeechRecognizer interface version. More... | |
static const std::string | CAPABILITY_INTERFACE_CONFIGURATIONS_KEY = "configurations" |
Configuration key used to give more details about the device configuration. More... | |
static const std::string | CAPABILITY_INTERFACE_WAKE_WORDS_KEY = "wakeWords" |
Supported wake words key. More... | |
static const std::string | CAPABILITY_MAXIMUM_CONCURRENT_WAKEWORDS_KEY = "maximumConcurrentWakeWords" |
Supported maximum number of concurrent wakewords key. More... | |
static const std::string | CAPABILITY_INTERFACE_SCOPES_KEY = "scopes" |
The scope key for each wake words set. More... | |
static const std::string | CAPABILITY_INTERFACE_VALUES_KEY = "values" |
The wake word values for a given scope. More... | |
static const std::string | CAPABILITY_INTERFACE_DEFAULT_LOCALE = "DEFAULT" |
The scope configuration used as default locale wake words support. More... | |
static const std::string | CHANNEL_NAME = FocusManagerInterface::DIALOG_CHANNEL_NAME |
The name of the FocusManager channel used by AudioInputProvider . More... | |
static const std::string | NAMESPACE = "SpeechRecognizer" |
The namespace for this capability agent. More... | |
static const avsCommon::avs::NamespaceAndName | STOP_CAPTURE {NAMESPACE, "StopCapture"} |
The StopCapture directive signature. More... | |
static const avsCommon::avs::NamespaceAndName | EXPECT_SPEECH {NAMESPACE, "ExpectSpeech"} |
The ExpectSpeech directive signature. More... | |
static const avsCommon::avs::NamespaceAndName | SET_END_OF_SPEECH_OFFSET {NAMESPACE, "SetEndOfSpeechOffset"} |
The SetEndOfSpeechOffset directive signature. More... | |
static const avsCommon::avs::NamespaceAndName | SET_WAKE_WORD_CONFIRMATION {NAMESPACE, "SetWakeWordConfirmation"} |
The SetWakeWordConfirmation directive signature. More... | |
static const avsCommon::avs::NamespaceAndName | SET_SPEECH_CONFIRMATION {NAMESPACE, "SetSpeechConfirmation"} |
The SetSpeechConfirmation directive signature. More... | |
static const avsCommon::avs::NamespaceAndName | SET_WAKE_WORDS {NAMESPACE, "SetWakeWords"} |
The SetWakeWords directive signature. More... | |
static const std::string | INITIATOR_KEY = "initiator" |
The field identifying the initiator. More... | |
static const std::string | PROFILE_KEY = "profile" |
The field identifying the initiator's profile. More... | |
static const std::string | FORMAT_KEY = "format" |
The field identifying the initiator's format. More... | |
static const std::string | TYPE_KEY = "type" |
The field identifying the initiator's type. More... | |
static const std::string | TOKEN_KEY = "token" |
The field identifying the initiator's token. More... | |
static const std::string | PAYLOAD_KEY = "payload" |
The field identifying the initiator's payload. More... | |
static const std::string | WAKEWORD_INDICES_KEY = "wakeWordIndices" |
The field identifying the initiator's wakeword indices. More... | |
static const std::string | START_INDEX_KEY = "startIndexInSamples" |
The field identifying the initiator's wakeword start index. More... | |
static const std::string | END_INDEX_KEY = "endIndexInSamples" |
The field identifying the initiator's wakeword end index. More... | |
static const std::string | WAKE_WORD_KEY = "wakeWord" |
The field identifying the initiator's wake word. More... | |
static const std::string | AUDIO_ATTACHMENT_FIELD_NAME = "audio" |
The field name for the user voice attachment. More... | |
static const std::string | KWD_METADATA_FIELD_NAME = "wakewordEngineMetadata" |
The field name for the wake word engine metadata. More... | |
static const std::string | START_OF_SPEECH_TIMESTAMP_FIELD_NAME = "startOfSpeechTimestamp" |
static const std::string | END_OF_SPEECH_OFFSET_FIELD_NAME = "endOfSpeechOffsetInMilliseconds" |
The field name for the end of speech offset, reported in milliseconds, as part of SetEndOfSpeechOffset payload. More... | |
static const std::string | WAKE_WORD_CONFIRMATION_CHANGED_EVENT_NAME = "WakeWordConfirmationChanged" |
The value of the WakeWordConfirmationChanged Event name. More... | |
static const std::string | WAKE_WORD_CONFIRMATION_REPORT_EVENT_NAME = "WakeWordConfirmationReport" |
The value of the WakeWordConfirmationReport Event name. More... | |
static const std::string | WAKE_WORD_CONFIRMATION_PAYLOAD_KEY = "wakeWordConfirmation" |
The value of the payload key for wakeWordConfirmation. More... | |
static const std::string | SPEECH_CONFIRMATION_CHANGED_EVENT_NAME = "SpeechConfirmationChanged" |
The value of the SpeechConfirmationChanged Event name. More... | |
static const std::string | SPEECH_CONFIRMATION_REPORT_EVENT_NAME = "SpeechConfirmationReport" |
The value of the SpeechConfirmationReport Event name. More... | |
static const std::string | SPEECH_CONFIRMATION_PAYLOAD_KEY = "speechConfirmation" |
The value of the payload key for speechConfirmation. More... | |
static const std::string | WAKE_WORDS_CHANGED_EVENT_NAME = "WakeWordsChanged" |
The value of the WakeWordsChanged Event name. More... | |
static const std::string | WAKE_WORDS_REPORT_EVENT_NAME = "WakeWordsReport" |
The value of the WakeWordsReport Event name. More... | |
static const std::string | WAKE_WORDS_PAYLOAD_KEY = "wakeWords" |
The value of the payload key for wake words. More... | |
static const std::string | POWER_RESOURCE_COMPONENT_NAME = "AudioInputProcessor" |
The component name of power management. More... | |
static const std::string | METRIC_ACTIVITY_NAME_PREFIX_AIP = "AIP-" |
Metric Activity Name Prefix for AIP metric source. More... | |
static const std::string | START_OF_UTTERANCE = "START_OF_UTTERANCE" |
Start of Utterance Activity Name for AIP metric source. More... | |
static const std::string | START_OF_UTTERANCE_ACTIVITY_NAME = METRIC_ACTIVITY_NAME_PREFIX_AIP + START_OF_UTTERANCE |
static const std::string | START_OF_STREAM_TIMESTAMP = "START_OF_STREAM_TIMESTAMP" |
Wakeword Activity Name for AIP metric source. More... | |
static const std::string | WW_DURATION = "WW_DURATION" |
static const std::string | WW_DURATION_ACTIVITY_NAME = METRIC_ACTIVITY_NAME_PREFIX_AIP + WW_DURATION |
static const std::string | STOP_CAPTURE_RECEIVED = "STOP_CAPTURE" |
Stop Capture Received Activity Name for AIP metric source. More... | |
static const std::string | STOP_CAPTURE_RECEIVED_ACTIVITY_NAME = METRIC_ACTIVITY_NAME_PREFIX_AIP + STOP_CAPTURE_RECEIVED |
static const std::string | END_OF_SPEECH_OFFSET_RECEIVED = "END_OF_SPEECH_OFFSET" |
End of Speech Offset Received Activity Name for AIP metric source. More... | |
static const std::string | END_OF_SPEECH_OFFSET_RECEIVED_ACTIVITY_NAME |
static const std::string | STOP_CAPTURE_TO_END_OF_SPEECH_METRIC_NAME = "STOP_CAPTURE_TO_END_OF_SPEECH" |
The duration metric for short time out. More... | |
static const std::string | STOP_CAPTURE_TO_END_OF_SPEECH_ACTIVITY_NAME |
static const std::chrono::milliseconds | PREROLL_DURATION = std::chrono::milliseconds(500) |
Preroll duration is a fixed 500ms. More... | |
static const int | MILLISECONDS_PER_SECOND = 1000 |
|
strong |
|
inline |
Convert the ASRProfile
to an AVS-compliant string.
profile | The profile value to convert to a string. |
std::string alexaClientSDK::capabilityAgents::aip::generateSupportedWakeWordsJson | ( | const std::string & | scope, |
const LocaleAssetsManagerInterface::WakeWordsSets & | wakeWordsCombination | ||
) |
Generate supported wake words json capability configuration for a given scope (default, language or locale).
scope | The scope being reported. |
wakeWordsCombination | The set of a combination of wake words supported in the given scope. |
|
static |
Creates the SpeechRecognizer capability configuration.
assetsManager | Responsible for retrieving and changing the wake words and locale. |
|
inline |
Convert an Initiator
value to an AVS-compliant string.
initiator | The initiator value to convert to a string. |
std::string
conversion of the Initiator
value.
|
inline |
Write an ASRProfile
value to an ostream
as an AVS-compliant string.
stream | The stream to write the value to. |
profile | The profile value to write to the ostream as a string. |
ostream
that was passed in and written to.
|
static |
Handles a Metric event by creating and recording it. Failure to create or record the event results in an early return.
metricRecorder | The MetricRecorderInterface which records Metric events. |
metricEventBuilder | The MetricEventBuilder . |
dialogRequestId | The dialogRequestId associated with this Metric event; default is empty string. |
|
static |
Handles a Metric event by creating and recording it. Failure to create or record the event results in an early return.
metricRecorder | The MetricRecorderInterface which records Metric events. |
activityName | The activityName of the Metric event. |
dataPoint | The DataPoint of this Metric event (e.g. duration). |
directive | The AVSDirective associated with this Metric event; default is nullptr. |
|
static |
String to identify log entries originating from this file.
|
static |
The field name for the user voice attachment.
|
static |
Configuration key used to give more details about the device configuration.
|
static |
The scope configuration used as default locale wake words support.
|
static |
The scope key for each wake words set.
|
static |
The wake word values for a given scope.
|
static |
Supported wake words key.
|
static |
Supported maximum number of concurrent wakewords key.
|
static |
The name of the FocusManager
channel used by AudioInputProvider
.
|
static |
The field identifying the initiator's wakeword end index.
|
static |
The field name for the end of speech offset, reported in milliseconds, as part of SetEndOfSpeechOffset payload.
|
static |
End of Speech Offset Received Activity Name for AIP metric source.
|
static |
|
static |
The ExpectSpeech directive signature.
|
static |
The field identifying the initiator's format.
|
static |
The field identifying the initiator.
|
static |
The field name for the wake word engine metadata.
|
static |
Metric Activity Name Prefix for AIP metric source.
|
static |
|
static |
The namespace for this capability agent.
|
static |
The field identifying the initiator's payload.
|
static |
The component name of power management.
|
static |
Preroll duration is a fixed 500ms.
|
static |
The field identifying the initiator's profile.
|
static |
The SetEndOfSpeechOffset directive signature.
|
static |
The SetSpeechConfirmation directive signature.
|
static |
The SetWakeWordConfirmation directive signature.
|
static |
The SetWakeWords directive signature.
|
static |
The value of the SpeechConfirmationChanged Event name.
|
static |
The value of the payload key for speechConfirmation.
|
static |
The value of the SpeechConfirmationReport Event name.
|
static |
SpeechRecognizer interface name.
|
static |
SpeechRecognizer capability constants SpeechRecognizer interface type
|
static |
SpeechRecognizer interface version.
|
static |
The field identifying the initiator's wakeword start index.
|
static |
The field name for the start of speech timestamp, reported in milliseconds since epoch. This field is provided to the Recognize event and it's sent back as part of SetEndOfSpeechOffset payload.
|
static |
Wakeword Activity Name for AIP metric source.
|
static |
Start of Utterance Activity Name for AIP metric source.
|
static |
|
static |
The StopCapture directive signature.
|
static |
Stop Capture Received Activity Name for AIP metric source.
|
static |
|
static |
|
static |
The duration metric for short time out.
|
static |
The field identifying the initiator's token.
|
static |
The field identifying the initiator's type.
|
static |
The value of the WakeWordConfirmationChanged Event name.
|
static |
The value of the payload key for wakeWordConfirmation.
|
static |
The value of the WakeWordConfirmationReport Event name.
|
static |
The field identifying the initiator's wake word.
|
static |
The value of the WakeWordsChanged Event name.
|
static |
The value of the payload key for wake words.
|
static |
The value of the WakeWordsReport Event name.
|
static |
The field identifying the initiator's wakeword indices.
|
static |
|
static |
AlexaClientSDK 1.22.0 - Copyright 2016-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0