alexaClientSDK::capabilityAgents::aip Namespace Reference

Namespaces
	test

Classes
class	AudioInputProcessor
struct	AudioProvider

Enumerations
enum	ASRProfile { ASRProfile::CLOSE_TALK, ASRProfile::NEAR_FIELD, ASRProfile::FAR_FIELD, ASRProfile::UNDEFINED }
enum	Initiator { Initiator::PRESS_AND_HOLD, Initiator::TAP, Initiator::WAKEWORD }

Functions
std::ostream &	operator<< (std::ostream &stream, ASRProfile profile)
std::string	asrProfileToString (ASRProfile profile)
ASRProfile	getASRProfile (const std::string &input)
std::string	initiatorToString (Initiator initiator)

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).
UNDEFINED	Indicates that ASR profile is undefined.

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.

getASRProfile()

ASRProfile alexaClientSDK::capabilityAgents::aip::getASRProfile ( const std::string &  input )

inline

This function reverse maps the provided string to corresponding ASRProfile Implementation as specified by asrProfileToString

Parameters

input

string to convert to corresponding ASRProfile

Returns

ASRProfile that corresponds to the input string. In case of error the API returns ASRProfile::UNDEFINED

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.