AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Namespaces | Classes | Functions | Variables
alexaClientSDK::kwd Namespace Reference

Namespaces

 test
 

Classes

class  AbstractKeywordDetector
 
class  KeywordDetectorProvider
 
class  SensoryKeywordDetector
 

Functions

static const std::string TAG ("SensoryKeywordDetector")
 String to identify log entries originating from this file. More...
 
static bool isAudioFormatCompatibleWithSensory (avsCommon::utils::AudioFormat audioFormat)
 
static std::string getSensoryDetails (SnsrSession session, SnsrRC result)
 
static const std::string TAG ("AbstractKeywordDetector")
 String to identify log entries originating from this file. More...
 

Variables

static const size_t HERTZ_PER_KILOHERTZ = 1000
 The number of hertz per kilohertz. More...
 
const std::chrono::milliseconds TIMEOUT_FOR_READ_CALLS = std::chrono::milliseconds(1000)
 The timeout to use for read calls to the SharedDataStream. More...
 
static const unsigned int SENSORY_COMPATIBLE_SAMPLE_RATE = 16000
 The Sensory compatible AVS sample rate of 16 kHz. More...
 
static const unsigned int SENSORY_COMPATIBLE_SAMPLE_SIZE_IN_BITS = 16
 The Sensory compatible bits per sample of 16. More...
 
static const unsigned int SENSORY_COMPATIBLE_NUM_CHANNELS = 1
 The Sensory compatible number of channels, which is 1. More...
 
static const avsCommon::utils::AudioFormat::Encoding SENSORY_COMPATIBLE_ENCODING
 The Sensory compatible audio encoding of LPCM. More...
 
static const avsCommon::utils::AudioFormat::Endianness SENSORY_COMPATIBLE_ENDIANNESS
 The Sensory compatible endianness which is little endian. More...
 

Function Documentation

◆ getSensoryDetails()

static std::string alexaClientSDK::kwd::getSensoryDetails ( SnsrSession  session,
SnsrRC  result 
)
static

Returns information about the ongoing sensory session. Primarily used to populate error messages.

Parameters
sessionThe Sensory session handle.
resultThe Sensory return code.
Returns
The pertinent message about the sensory session in string format.

◆ isAudioFormatCompatibleWithSensory()

static bool alexaClientSDK::kwd::isAudioFormatCompatibleWithSensory ( avsCommon::utils::AudioFormat  audioFormat)
static

Checks to see if an avsCommon::utils::AudioFormat is compatible with Sensory.

Parameters
audioFormatThe audio format to check.
Returns
true if the audio format is compatible with Sensory and false otherwise.

◆ TAG() [1/2]

static const std::string alexaClientSDK::kwd::TAG ( "AbstractKeywordDetector"  )
static

String to identify log entries originating from this file.

◆ TAG() [2/2]

static const std::string alexaClientSDK::kwd::TAG ( "SensoryKeywordDetector"  )
static

String to identify log entries originating from this file.

Variable Documentation

◆ HERTZ_PER_KILOHERTZ

const size_t alexaClientSDK::kwd::HERTZ_PER_KILOHERTZ = 1000
static

The number of hertz per kilohertz.

◆ SENSORY_COMPATIBLE_ENCODING

const avsCommon::utils::AudioFormat::Encoding alexaClientSDK::kwd::SENSORY_COMPATIBLE_ENCODING
static
Initial value:
=
avsCommon::utils::AudioFormat::Encoding::LPCM

The Sensory compatible audio encoding of LPCM.

◆ SENSORY_COMPATIBLE_ENDIANNESS

const avsCommon::utils::AudioFormat::Endianness alexaClientSDK::kwd::SENSORY_COMPATIBLE_ENDIANNESS
static
Initial value:
=
avsCommon::utils::AudioFormat::Endianness::LITTLE

The Sensory compatible endianness which is little endian.

◆ SENSORY_COMPATIBLE_NUM_CHANNELS

const unsigned int alexaClientSDK::kwd::SENSORY_COMPATIBLE_NUM_CHANNELS = 1
static

The Sensory compatible number of channels, which is 1.

◆ SENSORY_COMPATIBLE_SAMPLE_RATE

const unsigned int alexaClientSDK::kwd::SENSORY_COMPATIBLE_SAMPLE_RATE = 16000
static

The Sensory compatible AVS sample rate of 16 kHz.

◆ SENSORY_COMPATIBLE_SAMPLE_SIZE_IN_BITS

const unsigned int alexaClientSDK::kwd::SENSORY_COMPATIBLE_SAMPLE_SIZE_IN_BITS = 16
static

The Sensory compatible bits per sample of 16.

◆ TIMEOUT_FOR_READ_CALLS

const std::chrono::milliseconds alexaClientSDK::kwd::TIMEOUT_FOR_READ_CALLS = std::chrono::milliseconds(1000)

The timeout to use for read calls to the SharedDataStream.

AlexaClientSDK 1.25.0 - Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0