alexaClientSDK::capabilityAgents::aip Namespace Reference

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 std::string	encodingFormatToString (avsCommon::utils::AudioFormat::Encoding encoding)
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 void	submitInstanceEntryMetric (const std::shared_ptr< MetricRecorderInterface > &metricRecorder, const std::string &segmentId, const std::string &name, const std::map< std::string, std::string > &metadata={})
static std::shared_ptr< avsCommon::avs::CapabilityConfiguration >	getSpeechRecognizerCapabilityConfiguration (const LocaleAssetsManagerInterface &assetsManager)
static bool	resolveMessageRequest (const std::shared_ptr< avsCommon::avs::EditableMessageRequest > &request, const std::string &resolveKey, AudioInputProcessor::EncodingFormatResponse encodingFormats, const std::unordered_map< std::string, std::vector< std::shared_ptr< avsCommon::avs::MessageRequest::NamedReader >>> &attachmentReaders, const std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > &metricRecorder)
std::string	generateSupportedWakeWordsJson (const std::string &scope, const LocaleAssetsManagerInterface::WakeWordsSets &wakeWordsCombination)
bool	resolveMessageRequest (const std::shared_ptr< EditableMessageRequest > &request, const std::string &resolveKey, AudioInputProcessor::EncodingFormatResponse encodingFormats, const std::unordered_map< std::string, std::vector< std::shared_ptr< MessageRequest::NamedReader >>> &attachmentReaders, const std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > &metricRecorder)

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	WAKEWORD_DETECTION_SEGMENT_UPLOADED_OPUS = "AIP_WAKEWORD_DETECTION_SEGMENT_UPLOADED_OPUS"
	Name of audio bytes stream metric Opus. More...
static const std::string	WAKEWORD_DETECTION_SEGMENT_UPLOADED_PCM = "AIP_WAKEWORD_DETECTION_SEGMENT_UPLOADED_PCM"
	Name of audio bytes stream metric PCM. More...
static const std::string	RECOGNIZE_START_SEND_MESSAGE = "RECOGNIZE_EVENT_IS_BUILT"
	Recognize EVENT is built for AIP metric source. More...
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	ACQUIRE_POWER_RESOURCE = "ACQUIRE_POWER_RESOURCE"
	The duration metric for acquire power resource. More...
static const std::string	ACQUIRE_POWER_RESOURCE_ACTIVITY = METRIC_ACTIVITY_NAME_PREFIX_AIP + ACQUIRE_POWER_RESOURCE
static const std::string	RELEASE_POWER_RESOURCE = "RELEASE_POWER_RESOURCE"
	The duration metric for release power resource. More...
static const std::string	RELEASE_POWER_RESOURCE_ACTIVITY = METRIC_ACTIVITY_NAME_PREFIX_AIP + RELEASE_POWER_RESOURCE
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::string	INITIATOR_PREFIX = "INITIATOR_"
	The recognize request initiator metric. More...
static const std::string	INITIATOR_ACTIVITY_NAME_PREFIX = METRIC_ACTIVITY_NAME_PREFIX_AIP + INITIATOR_PREFIX
static const std::string	AUDIO_ENCODING_FORMAT_METRIC_NAME = "AUDIO_ENCODING_FORMAT"
	AudioEncodingFormat Activity Name for AIP metric source. More...
static const std::string	AUDIO_ENCODING_FORMAT_ACTIVITY_NAME
static const std::string	AUDIO_ENCODING_FORMAT_OPUS = "OPUSAudioEncoding"
static const std::string	AUDIO_ENCODING_FORMAT_LPCM = "LPCMAudioEncoding"
static const std::string	DEFAULT_RESOLVE_KEY = "DEFAULT_RESOLVE_KEY"
	The default resolveKey used as a placeholder when only one encoding format is configured for AudioInputProcessor. More...
static const std::string	ENTRY_METRIC_ACTOR_NAME = "AudioInputProcessor"
	Keys for instance entry metric specific fields. More...
static const std::string	ENTRY_METRIC_ACTIVITY_NAME = METRIC_ACTIVITY_NAME_PREFIX_AIP + ENTRY_METRIC_ACTOR_NAME
static const std::string	ENTRY_METRIC_KEY_SEGMENT_ID = "segment_id"
static const std::string	ENTRY_METRIC_KEY_ACTOR = "actor"
static const std::string	ENTRY_METRIC_KEY_ENTRY_TYPE = "entry_type"
static const std::string	ENTRY_METRIC_KEY_ENTRY_NAME = "entry_name"
static const std::string	ENTRY_METRIC_NAME_STATE_CHANGE = "StateChange"
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
static const int	WAKEWORD_DETECTION_SEGMENT_SIZE_BYTES_OPUS = 5209
	Threshold number of bytes for OPUS Encoded Wakeword detection. More...
static const int	WAKEWORD_DETECTION_SEGMENT_SIZE_BYTES_PCM = 40480
	Threshold number of bytes for PCM Encoded Wakeword detection. More...

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.

encodingFormatToString()

static std::string alexaClientSDK::capabilityAgents::aip::encodingFormatToString ( avsCommon::utils::AudioFormat::Encoding  encoding )

static

Helper function to get string values of encoding audio format, which are used in Recognize event.

Parameters

encoding

Target encoding format

Returns

String name of the encoding format

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.

resolveMessageRequest() [1/2]

static bool alexaClientSDK::capabilityAgents::aip::resolveMessageRequest ( const std::shared_ptr< avsCommon::avs::EditableMessageRequest > &  request, const std::string &  resolveKey, AudioInputProcessor::EncodingFormatResponse  encodingFormats, const std::unordered_map< std::string, std::vector< std::shared_ptr< avsCommon::avs::MessageRequest::NamedReader >>> &  attachmentReaders, const std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > &  metricRecorder  )

static

Resolving method to be called in lambda function that will be passed to MessageRequest as MessageRequestResolveFunction

Parameters

[in,out]	request	EditableMessageRequest to resolve
	resolveKey	Provided resolve key
	encodingFormats	Mappings from resolveKey to encoding format
	attachmentReaders	Mappings from resolveKey to attachment readers
	metricRecorder	MetricRecorderInterface object to emit metrics

Returns

true if the message is resolved successfully, else false

resolveMessageRequest() [2/2]

bool alexaClientSDK::capabilityAgents::aip::resolveMessageRequest	(	const std::shared_ptr< EditableMessageRequest > &	request,
		const std::string &	resolveKey,
		AudioInputProcessor::EncodingFormatResponse	encodingFormats,
		const std::unordered_map< std::string, std::vector< std::shared_ptr< MessageRequest::NamedReader >>> &	attachmentReaders,
		const std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > &	metricRecorder
	)

submitInstanceEntryMetric()

static void alexaClientSDK::capabilityAgents::aip::submitInstanceEntryMetric ( const std::shared_ptr< MetricRecorderInterface > &  metricRecorder, const std::string &  segmentId, const std::string &  name, const std::map< std::string, std::string > &  metadata = {}  )

static

Creates and records an instance entry metric with the given identifiers and metadata.

Parameters

metricRecorder	The MetricRecorderInterface which records Metric events.
segmentId	The segmentId corresponding to this metric event.
name	The name of this metric
metadata	Any metadata to be associated with this metric; default is empty

submitMetric() [1/2]

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() [2/2]

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

ACQUIRE_POWER_RESOURCE

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

static

The duration metric for acquire power resource.

ACQUIRE_POWER_RESOURCE_ACTIVITY

const std::string alexaClientSDK::capabilityAgents::aip::ACQUIRE_POWER_RESOURCE_ACTIVITY = METRIC_ACTIVITY_NAME_PREFIX_AIP + ACQUIRE_POWER_RESOURCE

static

AUDIO_ATTACHMENT_FIELD_NAME

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

static

The field name for the user voice attachment.

AUDIO_ENCODING_FORMAT_ACTIVITY_NAME

const std::string alexaClientSDK::capabilityAgents::aip::AUDIO_ENCODING_FORMAT_ACTIVITY_NAME

static

Initial value:

=
    METRIC_ACTIVITY_NAME_PREFIX_AIP + AUDIO_ENCODING_FORMAT_METRIC_NAME

AUDIO_ENCODING_FORMAT_LPCM

const std::string alexaClientSDK::capabilityAgents::aip::AUDIO_ENCODING_FORMAT_LPCM = "LPCMAudioEncoding"

static

AUDIO_ENCODING_FORMAT_METRIC_NAME

const std::string alexaClientSDK::capabilityAgents::aip::AUDIO_ENCODING_FORMAT_METRIC_NAME = "AUDIO_ENCODING_FORMAT"

static

AudioEncodingFormat Activity Name for AIP metric source.

AUDIO_ENCODING_FORMAT_OPUS

const std::string alexaClientSDK::capabilityAgents::aip::AUDIO_ENCODING_FORMAT_OPUS = "OPUSAudioEncoding"

static

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.

DEFAULT_RESOLVE_KEY

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

static

The default resolveKey used as a placeholder when only one encoding format is configured for AudioInputProcessor.

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

ENTRY_METRIC_ACTIVITY_NAME

const std::string alexaClientSDK::capabilityAgents::aip::ENTRY_METRIC_ACTIVITY_NAME = METRIC_ACTIVITY_NAME_PREFIX_AIP + ENTRY_METRIC_ACTOR_NAME

static

ENTRY_METRIC_ACTOR_NAME

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

static

Keys for instance entry metric specific fields.

ENTRY_METRIC_KEY_ACTOR

const std::string alexaClientSDK::capabilityAgents::aip::ENTRY_METRIC_KEY_ACTOR = "actor"

static

ENTRY_METRIC_KEY_ENTRY_NAME

const std::string alexaClientSDK::capabilityAgents::aip::ENTRY_METRIC_KEY_ENTRY_NAME = "entry_name"

static

ENTRY_METRIC_KEY_ENTRY_TYPE

const std::string alexaClientSDK::capabilityAgents::aip::ENTRY_METRIC_KEY_ENTRY_TYPE = "entry_type"

static

ENTRY_METRIC_KEY_SEGMENT_ID

const std::string alexaClientSDK::capabilityAgents::aip::ENTRY_METRIC_KEY_SEGMENT_ID = "segment_id"

static

ENTRY_METRIC_NAME_STATE_CHANGE

const std::string alexaClientSDK::capabilityAgents::aip::ENTRY_METRIC_NAME_STATE_CHANGE = "StateChange"

static

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_ACTIVITY_NAME_PREFIX

const std::string alexaClientSDK::capabilityAgents::aip::INITIATOR_ACTIVITY_NAME_PREFIX = METRIC_ACTIVITY_NAME_PREFIX_AIP + INITIATOR_PREFIX

static

INITIATOR_KEY

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

static

The field identifying the initiator.

INITIATOR_PREFIX

const std::string alexaClientSDK::capabilityAgents::aip::INITIATOR_PREFIX = "INITIATOR_"

static

The recognize request initiator metric.

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.

RECOGNIZE_START_SEND_MESSAGE

const std::string alexaClientSDK::capabilityAgents::aip::RECOGNIZE_START_SEND_MESSAGE = "RECOGNIZE_EVENT_IS_BUILT"

static

Recognize EVENT is built for AIP metric source.

RELEASE_POWER_RESOURCE

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

static

The duration metric for release power resource.

RELEASE_POWER_RESOURCE_ACTIVITY

const std::string alexaClientSDK::capabilityAgents::aip::RELEASE_POWER_RESOURCE_ACTIVITY = METRIC_ACTIVITY_NAME_PREFIX_AIP + RELEASE_POWER_RESOURCE

static

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

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_DETECTION_SEGMENT_SIZE_BYTES_OPUS

const int alexaClientSDK::capabilityAgents::aip::WAKEWORD_DETECTION_SEGMENT_SIZE_BYTES_OPUS = 5209

static

Threshold number of bytes for OPUS Encoded Wakeword detection.

WAKEWORD_DETECTION_SEGMENT_SIZE_BYTES_PCM

const int alexaClientSDK::capabilityAgents::aip::WAKEWORD_DETECTION_SEGMENT_SIZE_BYTES_PCM = 40480

static

Threshold number of bytes for PCM Encoded Wakeword detection.

WAKEWORD_DETECTION_SEGMENT_UPLOADED_OPUS

const std::string alexaClientSDK::capabilityAgents::aip::WAKEWORD_DETECTION_SEGMENT_UPLOADED_OPUS = "AIP_WAKEWORD_DETECTION_SEGMENT_UPLOADED_OPUS"

static

Name of audio bytes stream metric Opus.

WAKEWORD_DETECTION_SEGMENT_UPLOADED_PCM

const std::string alexaClientSDK::capabilityAgents::aip::WAKEWORD_DETECTION_SEGMENT_UPLOADED_PCM = "AIP_WAKEWORD_DETECTION_SEGMENT_UPLOADED_PCM"

static

Name of audio bytes stream metric PCM.

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