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, const std::string &activityName, const DataPoint &dataPoint, const std::string &dialogRequestId="")

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

Enumeration Type Documentation

◆ ASRProfile

enum alexaClientSDK::capabilityAgents::aip::ASRProfile

strong

Enumerates the different ASR profiles supported by AVS.

See also: https://developer.amazon.com/public/solutions/alexa/alexa-voice-service/reference/speechrecognizer#profiles

Enumerator
CLOSE_TALK	Client determines end of user speech (0 to 2.5 ft).
NEAR_FIELD	Cloud determines end of user speech (0 to 5 ft).
FAR_FIELD	Cloud determines end of user speech (0 to 20+ ft).

◆ Initiator

enum alexaClientSDK::capabilityAgents::aip::Initiator

strong

Enumerates the different initiators supported by AVS.

Enumerator
PRESS_AND_HOLD	Recognize event was initiated by a press-and-hold action.
TAP	Recognize event was initiated by a tap-to-talk action.
WAKEWORD	Recognize event was initiated by a wakeword action.

Function Documentation

◆ asrProfileToString()

std::string alexaClientSDK::capabilityAgents::aip::asrProfileToString ( ASRProfile profile )

inline

Convert the ASRProfile to an AVS-compliant string.

Parameters

profile The profile value to convert to a string.

Returns: String representing the profile value. If the profile given is not valid, an empty string will be returned.

◆ generateSupportedWakeWordsJson()

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).

Parameters

scope	The scope being reported.
wakeWordsCombination	The set of a combination of wake words supported in the given scope.

Returns: A json representation of the scope configuration.

◆ getSpeechRecognizerCapabilityConfiguration()

std::shared_ptr< avsCommon::avs::CapabilityConfiguration > alexaClientSDK::capabilityAgents::aip::getSpeechRecognizerCapabilityConfiguration ( const LocaleAssetsManagerInterface & assetsManager )

static

Creates the SpeechRecognizer capability configuration.

Parameters

assetsManager Responsible for retrieving and changing the wake words and locale.

Returns: The SpeechRecognizer capability configuration.

◆ initiatorToString()

std::string alexaClientSDK::capabilityAgents::aip::initiatorToString ( Initiator initiator )

inline

Convert an Initiator value to an AVS-compliant string.

Parameters

initiator The initiator value to convert to a string.

Returns: The std::string conversion of the Initiator value.

◆ operator<<()

std::ostream& alexaClientSDK::capabilityAgents::aip::operator<<	(	std::ostream &	stream,
		ASRProfile	profile
	)

inline

Write an ASRProfile value to an ostream as an AVS-compliant string.

Parameters

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

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

◆ submitMetric() [1/3]

static void alexaClientSDK::capabilityAgents::aip::submitMetric	(	const std::shared_ptr< MetricRecorderInterface > &	metricRecorder,
		const std::string &	activityName,
		const DataPoint &	dataPoint,
		const std::string &	dialogRequestId = `""`
	)

static

Handles a Metric event by creating and recording it. Failure to create or record the event results in an early return.

Parameters

metricRecorder	The `MetricRecorderInterface` which records Metric events.
activityName	The activityName of the Metric event.
dataPoint	The `DataPoint` of this Metric event (e.g. duration).
dialogRequestId	The dialogRequestId associated with this Metric event; default is empty string.

◆ submitMetric() [2/3]

static void alexaClientSDK::capabilityAgents::aip::submitMetric	(	const std::shared_ptr< MetricRecorderInterface > &	metricRecorder,
		MetricEventBuilder &	metricEventBuilder,
		const std::string &	dialogRequestId = `""`
	)

static

Handles a Metric event by creating and recording it. Failure to create or record the event results in an early return.

Parameters

metricRecorder	The `MetricRecorderInterface` which records Metric events.
metricEventBuilder	The `MetricEventBuilder`.
dialogRequestId	The dialogRequestId associated with this Metric event; default is empty string.

◆ submitMetric() [3/3]

static void alexaClientSDK::capabilityAgents::aip::submitMetric	(	const std::shared_ptr< MetricRecorderInterface >	metricRecorder,
		const std::string &	activityName,
		const DataPoint &	dataPoint,
		const std::shared_ptr< AVSDirective > &	directive = `nullptr`
	)

static

Handles a Metric event by creating and recording it. Failure to create or record the event results in an early return.

Parameters

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.

◆ TAG()

static const std::string alexaClientSDK::capabilityAgents::aip::TAG ( "AudioInputProcessor" )

static

String to identify log entries originating from this file.

Variable Documentation

◆ AUDIO_ATTACHMENT_FIELD_NAME

const std::string alexaClientSDK::capabilityAgents::aip::AUDIO_ATTACHMENT_FIELD_NAME = "audio"

static

The field name for the user voice attachment.

◆ CAPABILITY_INTERFACE_CONFIGURATIONS_KEY

const std::string alexaClientSDK::capabilityAgents::aip::CAPABILITY_INTERFACE_CONFIGURATIONS_KEY = "configurations"

static

Configuration key used to give more details about the device configuration.

◆ CAPABILITY_INTERFACE_DEFAULT_LOCALE

const std::string alexaClientSDK::capabilityAgents::aip::CAPABILITY_INTERFACE_DEFAULT_LOCALE = "DEFAULT"

static

The scope configuration used as default locale wake words support.

◆ CAPABILITY_INTERFACE_SCOPES_KEY

const std::string alexaClientSDK::capabilityAgents::aip::CAPABILITY_INTERFACE_SCOPES_KEY = "scopes"

static

The scope key for each wake words set.

◆ CAPABILITY_INTERFACE_VALUES_KEY

const std::string alexaClientSDK::capabilityAgents::aip::CAPABILITY_INTERFACE_VALUES_KEY = "values"

static

The wake word values for a given scope.

◆ CAPABILITY_INTERFACE_WAKE_WORDS_KEY

const std::string alexaClientSDK::capabilityAgents::aip::CAPABILITY_INTERFACE_WAKE_WORDS_KEY = "wakeWords"

static

Supported wake words key.

◆ CAPABILITY_MAXIMUM_CONCURRENT_WAKEWORDS_KEY

const std::string alexaClientSDK::capabilityAgents::aip::CAPABILITY_MAXIMUM_CONCURRENT_WAKEWORDS_KEY = "maximumConcurrentWakeWords"

static

Supported maximum number of concurrent wakewords key.

◆ CHANNEL_NAME

const std::string alexaClientSDK::capabilityAgents::aip::CHANNEL_NAME = FocusManagerInterface::DIALOG_CHANNEL_NAME

static

The name of the FocusManager channel used by AudioInputProvider.

◆ END_INDEX_KEY

const std::string alexaClientSDK::capabilityAgents::aip::END_INDEX_KEY = "endIndexInSamples"

static

The field identifying the initiator's wakeword end index.

◆ END_OF_SPEECH_OFFSET_FIELD_NAME

const std::string alexaClientSDK::capabilityAgents::aip::END_OF_SPEECH_OFFSET_FIELD_NAME = "endOfSpeechOffsetInMilliseconds"

static

The field name for the end of speech offset, reported in milliseconds, as part of SetEndOfSpeechOffset payload.

◆ END_OF_SPEECH_OFFSET_RECEIVED

const std::string alexaClientSDK::capabilityAgents::aip::END_OF_SPEECH_OFFSET_RECEIVED = "END_OF_SPEECH_OFFSET"

static

End of Speech Offset Received Activity Name for AIP metric source.

◆ END_OF_SPEECH_OFFSET_RECEIVED_ACTIVITY_NAME

const std::string alexaClientSDK::capabilityAgents::aip::END_OF_SPEECH_OFFSET_RECEIVED_ACTIVITY_NAME

static

Initial value:

=

METRIC_ACTIVITY_NAME_PREFIX_AIP + END_OF_SPEECH_OFFSET_RECEIVED

alexaClientSDK::capabilityAgents::aip::METRIC_ACTIVITY_NAME_PREFIX_AIP

static const std::string METRIC_ACTIVITY_NAME_PREFIX_AIP

Metric Activity Name Prefix for AIP metric source.

Definition: AudioInputProcessor.cpp:182

alexaClientSDK::capabilityAgents::aip::END_OF_SPEECH_OFFSET_RECEIVED

static const std::string END_OF_SPEECH_OFFSET_RECEIVED

End of Speech Offset Received Activity Name for AIP metric source.

Definition: AudioInputProcessor.cpp:198

◆ EXPECT_SPEECH

const avsCommon::avs::NamespaceAndName alexaClientSDK::capabilityAgents::aip::EXPECT_SPEECH {NAMESPACE, "ExpectSpeech"}

static

The ExpectSpeech directive signature.

◆ FORMAT_KEY

const std::string alexaClientSDK::capabilityAgents::aip::FORMAT_KEY = "format"

static

The field identifying the initiator's format.

◆ INITIATOR_KEY

const std::string alexaClientSDK::capabilityAgents::aip::INITIATOR_KEY = "initiator"

static

The field identifying the initiator.

◆ KWD_METADATA_FIELD_NAME

const std::string alexaClientSDK::capabilityAgents::aip::KWD_METADATA_FIELD_NAME = "wakewordEngineMetadata"

static

The field name for the wake word engine metadata.

◆ METRIC_ACTIVITY_NAME_PREFIX_AIP

const std::string alexaClientSDK::capabilityAgents::aip::METRIC_ACTIVITY_NAME_PREFIX_AIP = "AIP-"

static

Metric Activity Name Prefix for AIP metric source.

◆ MILLISECONDS_PER_SECOND

const int alexaClientSDK::capabilityAgents::aip::MILLISECONDS_PER_SECOND = 1000

static

◆ NAMESPACE

const std::string alexaClientSDK::capabilityAgents::aip::NAMESPACE = "SpeechRecognizer"

static

The namespace for this capability agent.

◆ PAYLOAD_KEY

const std::string alexaClientSDK::capabilityAgents::aip::PAYLOAD_KEY = "payload"

static

The field identifying the initiator's payload.

◆ POWER_RESOURCE_COMPONENT_NAME

const std::string alexaClientSDK::capabilityAgents::aip::POWER_RESOURCE_COMPONENT_NAME = "AudioInputProcessor"

static

The component name of power management.

◆ PREROLL_DURATION

const std::chrono::milliseconds alexaClientSDK::capabilityAgents::aip::PREROLL_DURATION = std::chrono::milliseconds(500)

static

Preroll duration is a fixed 500ms.

◆ PROFILE_KEY

const std::string alexaClientSDK::capabilityAgents::aip::PROFILE_KEY = "profile"

static

The field identifying the initiator's profile.

◆ SET_END_OF_SPEECH_OFFSET

const avsCommon::avs::NamespaceAndName alexaClientSDK::capabilityAgents::aip::SET_END_OF_SPEECH_OFFSET {NAMESPACE, "SetEndOfSpeechOffset"}

static

The SetEndOfSpeechOffset directive signature.

◆ SET_SPEECH_CONFIRMATION

const avsCommon::avs::NamespaceAndName alexaClientSDK::capabilityAgents::aip::SET_SPEECH_CONFIRMATION {NAMESPACE, "SetSpeechConfirmation"}

static

The SetSpeechConfirmation directive signature.

◆ SET_WAKE_WORD_CONFIRMATION

const avsCommon::avs::NamespaceAndName alexaClientSDK::capabilityAgents::aip::SET_WAKE_WORD_CONFIRMATION {NAMESPACE, "SetWakeWordConfirmation"}

static

The SetWakeWordConfirmation directive signature.

◆ SET_WAKE_WORDS

const avsCommon::avs::NamespaceAndName alexaClientSDK::capabilityAgents::aip::SET_WAKE_WORDS {NAMESPACE, "SetWakeWords"}

static

The SetWakeWords directive signature.

◆ SPEECH_CONFIRMATION_CHANGED_EVENT_NAME

const std::string alexaClientSDK::capabilityAgents::aip::SPEECH_CONFIRMATION_CHANGED_EVENT_NAME = "SpeechConfirmationChanged"

static

The value of the SpeechConfirmationChanged Event name.

◆ SPEECH_CONFIRMATION_PAYLOAD_KEY

const std::string alexaClientSDK::capabilityAgents::aip::SPEECH_CONFIRMATION_PAYLOAD_KEY = "speechConfirmation"

static

The value of the payload key for speechConfirmation.

◆ SPEECH_CONFIRMATION_REPORT_EVENT_NAME

const std::string alexaClientSDK::capabilityAgents::aip::SPEECH_CONFIRMATION_REPORT_EVENT_NAME = "SpeechConfirmationReport"

static

The value of the SpeechConfirmationReport Event name.

◆ SPEECHRECOGNIZER_CAPABILITY_INTERFACE_NAME

const std::string alexaClientSDK::capabilityAgents::aip::SPEECHRECOGNIZER_CAPABILITY_INTERFACE_NAME = "SpeechRecognizer"

static

SpeechRecognizer interface name.

◆ SPEECHRECOGNIZER_CAPABILITY_INTERFACE_TYPE

const std::string alexaClientSDK::capabilityAgents::aip::SPEECHRECOGNIZER_CAPABILITY_INTERFACE_TYPE = "AlexaInterface"

static

SpeechRecognizer capability constants SpeechRecognizer interface type

◆ SPEECHRECOGNIZER_CAPABILITY_INTERFACE_VERSION

const std::string alexaClientSDK::capabilityAgents::aip::SPEECHRECOGNIZER_CAPABILITY_INTERFACE_VERSION = "2.3"

static

SpeechRecognizer interface version.

◆ START_INDEX_KEY

const std::string alexaClientSDK::capabilityAgents::aip::START_INDEX_KEY = "startIndexInSamples"

static

The field identifying the initiator's wakeword start index.

◆ START_OF_SPEECH_TIMESTAMP_FIELD_NAME

const std::string alexaClientSDK::capabilityAgents::aip::START_OF_SPEECH_TIMESTAMP_FIELD_NAME = "startOfSpeechTimestamp"

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.

◆ START_OF_STREAM_TIMESTAMP

const std::string alexaClientSDK::capabilityAgents::aip::START_OF_STREAM_TIMESTAMP = "START_OF_STREAM_TIMESTAMP"

static

Wakeword Activity Name for AIP metric source.

◆ START_OF_UTTERANCE

const std::string alexaClientSDK::capabilityAgents::aip::START_OF_UTTERANCE = "START_OF_UTTERANCE"

static

Start of Utterance Activity Name for AIP metric source.

◆ START_OF_UTTERANCE_ACTIVITY_NAME

const std::string alexaClientSDK::capabilityAgents::aip::START_OF_UTTERANCE_ACTIVITY_NAME = METRIC_ACTIVITY_NAME_PREFIX_AIP + START_OF_UTTERANCE

static

◆ STOP_CAPTURE

const avsCommon::avs::NamespaceAndName alexaClientSDK::capabilityAgents::aip::STOP_CAPTURE {NAMESPACE, "StopCapture"}

static

The StopCapture directive signature.

◆ STOP_CAPTURE_RECEIVED

const std::string alexaClientSDK::capabilityAgents::aip::STOP_CAPTURE_RECEIVED = "STOP_CAPTURE"

static

Stop Capture Received Activity Name for AIP metric source.

◆ STOP_CAPTURE_RECEIVED_ACTIVITY_NAME

const std::string alexaClientSDK::capabilityAgents::aip::STOP_CAPTURE_RECEIVED_ACTIVITY_NAME = METRIC_ACTIVITY_NAME_PREFIX_AIP + STOP_CAPTURE_RECEIVED

static

◆ STOP_CAPTURE_TO_END_OF_SPEECH_ACTIVITY_NAME

const std::string alexaClientSDK::capabilityAgents::aip::STOP_CAPTURE_TO_END_OF_SPEECH_ACTIVITY_NAME

static

Initial value:

=

METRIC_ACTIVITY_NAME_PREFIX_AIP + STOP_CAPTURE_TO_END_OF_SPEECH_METRIC_NAME

alexaClientSDK::capabilityAgents::aip::METRIC_ACTIVITY_NAME_PREFIX_AIP

static const std::string METRIC_ACTIVITY_NAME_PREFIX_AIP

Metric Activity Name Prefix for AIP metric source.

Definition: AudioInputProcessor.cpp:182

alexaClientSDK::capabilityAgents::aip::STOP_CAPTURE_TO_END_OF_SPEECH_METRIC_NAME

static const std::string STOP_CAPTURE_TO_END_OF_SPEECH_METRIC_NAME

The duration metric for short time out.

Definition: AudioInputProcessor.cpp:203

◆ STOP_CAPTURE_TO_END_OF_SPEECH_METRIC_NAME

const std::string alexaClientSDK::capabilityAgents::aip::STOP_CAPTURE_TO_END_OF_SPEECH_METRIC_NAME = "STOP_CAPTURE_TO_END_OF_SPEECH"

static

The duration metric for short time out.

◆ TOKEN_KEY

const std::string alexaClientSDK::capabilityAgents::aip::TOKEN_KEY = "token"

static

The field identifying the initiator's token.

◆ TYPE_KEY

const std::string alexaClientSDK::capabilityAgents::aip::TYPE_KEY = "type"

static

The field identifying the initiator's type.

◆ WAKE_WORD_CONFIRMATION_CHANGED_EVENT_NAME

const std::string alexaClientSDK::capabilityAgents::aip::WAKE_WORD_CONFIRMATION_CHANGED_EVENT_NAME = "WakeWordConfirmationChanged"

static

The value of the WakeWordConfirmationChanged Event name.

◆ WAKE_WORD_CONFIRMATION_PAYLOAD_KEY

const std::string alexaClientSDK::capabilityAgents::aip::WAKE_WORD_CONFIRMATION_PAYLOAD_KEY = "wakeWordConfirmation"

static

The value of the payload key for wakeWordConfirmation.

◆ WAKE_WORD_CONFIRMATION_REPORT_EVENT_NAME

const std::string alexaClientSDK::capabilityAgents::aip::WAKE_WORD_CONFIRMATION_REPORT_EVENT_NAME = "WakeWordConfirmationReport"

static

The value of the WakeWordConfirmationReport Event name.

◆ WAKE_WORD_KEY

const std::string alexaClientSDK::capabilityAgents::aip::WAKE_WORD_KEY = "wakeWord"

static

The field identifying the initiator's wake word.

◆ WAKE_WORDS_CHANGED_EVENT_NAME

const std::string alexaClientSDK::capabilityAgents::aip::WAKE_WORDS_CHANGED_EVENT_NAME = "WakeWordsChanged"

static

The value of the WakeWordsChanged Event name.

◆ WAKE_WORDS_PAYLOAD_KEY

const std::string alexaClientSDK::capabilityAgents::aip::WAKE_WORDS_PAYLOAD_KEY = "wakeWords"

static

The value of the payload key for wake words.

◆ WAKE_WORDS_REPORT_EVENT_NAME

const std::string alexaClientSDK::capabilityAgents::aip::WAKE_WORDS_REPORT_EVENT_NAME = "WakeWordsReport"

static

The value of the WakeWordsReport Event name.

◆ WAKEWORD_INDICES_KEY

const std::string alexaClientSDK::capabilityAgents::aip::WAKEWORD_INDICES_KEY = "wakeWordIndices"

static

The field identifying the initiator's wakeword indices.

◆ WW_DURATION

const std::string alexaClientSDK::capabilityAgents::aip::WW_DURATION = "WW_DURATION"

static

◆ WW_DURATION_ACTIVITY_NAME

const std::string alexaClientSDK::capabilityAgents::aip::WW_DURATION_ACTIVITY_NAME = METRIC_ACTIVITY_NAME_PREFIX_AIP + WW_DURATION

static

Namespaces

Classes

Enumerations

Functions

Variables

Enumeration Type Documentation

◆ ASRProfile

◆ Initiator

Function Documentation

◆ asrProfileToString()

◆ generateSupportedWakeWordsJson()

◆ getSpeechRecognizerCapabilityConfiguration()

◆ initiatorToString()

◆ operator<<()

◆ submitMetric() [1/3]

◆ submitMetric() [2/3]

◆ submitMetric() [3/3]

◆ TAG()

Variable Documentation

◆ AUDIO_ATTACHMENT_FIELD_NAME

◆ CAPABILITY_INTERFACE_CONFIGURATIONS_KEY

◆ CAPABILITY_INTERFACE_DEFAULT_LOCALE

◆ CAPABILITY_INTERFACE_SCOPES_KEY

◆ CAPABILITY_INTERFACE_VALUES_KEY

◆ CAPABILITY_INTERFACE_WAKE_WORDS_KEY

◆ CAPABILITY_MAXIMUM_CONCURRENT_WAKEWORDS_KEY

◆ CHANNEL_NAME

◆ END_INDEX_KEY

◆ END_OF_SPEECH_OFFSET_FIELD_NAME

◆ END_OF_SPEECH_OFFSET_RECEIVED

◆ END_OF_SPEECH_OFFSET_RECEIVED_ACTIVITY_NAME

◆ EXPECT_SPEECH

◆ FORMAT_KEY

◆ INITIATOR_KEY

◆ KWD_METADATA_FIELD_NAME

◆ METRIC_ACTIVITY_NAME_PREFIX_AIP

◆ MILLISECONDS_PER_SECOND

◆ NAMESPACE

◆ PAYLOAD_KEY

◆ POWER_RESOURCE_COMPONENT_NAME

◆ PREROLL_DURATION

◆ PROFILE_KEY

◆ SET_END_OF_SPEECH_OFFSET

◆ SET_SPEECH_CONFIRMATION

◆ SET_WAKE_WORD_CONFIRMATION

◆ SET_WAKE_WORDS

◆ SPEECH_CONFIRMATION_CHANGED_EVENT_NAME

◆ SPEECH_CONFIRMATION_PAYLOAD_KEY

◆ SPEECH_CONFIRMATION_REPORT_EVENT_NAME

◆ SPEECHRECOGNIZER_CAPABILITY_INTERFACE_NAME

◆ SPEECHRECOGNIZER_CAPABILITY_INTERFACE_TYPE

◆ SPEECHRECOGNIZER_CAPABILITY_INTERFACE_VERSION

◆ START_INDEX_KEY

◆ START_OF_SPEECH_TIMESTAMP_FIELD_NAME

◆ START_OF_STREAM_TIMESTAMP

◆ START_OF_UTTERANCE

◆ START_OF_UTTERANCE_ACTIVITY_NAME

◆ STOP_CAPTURE

◆ STOP_CAPTURE_RECEIVED

◆ STOP_CAPTURE_RECEIVED_ACTIVITY_NAME

◆ STOP_CAPTURE_TO_END_OF_SPEECH_ACTIVITY_NAME

◆ STOP_CAPTURE_TO_END_OF_SPEECH_METRIC_NAME

◆ TOKEN_KEY

◆ TYPE_KEY

◆ WAKE_WORD_CONFIRMATION_CHANGED_EVENT_NAME

◆ WAKE_WORD_CONFIRMATION_PAYLOAD_KEY

◆ WAKE_WORD_CONFIRMATION_REPORT_EVENT_NAME

◆ WAKE_WORD_KEY

◆ WAKE_WORDS_CHANGED_EVENT_NAME

◆ WAKE_WORDS_PAYLOAD_KEY

◆ WAKE_WORDS_REPORT_EVENT_NAME

◆ WAKEWORD_INDICES_KEY

◆ WW_DURATION

◆ WW_DURATION_ACTIVITY_NAME