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

Namespaces

 test
 
 utils
 

Classes

class  AudioInjectorMicrophone
 This represents a microphone which injects audio data into the shared data stream. More...
 
class  DevicePropertyAggregator
 
class  DeviceProtocolTracer
 
class  FileBasedAudioInjector
 

Functions

static const std::string TAG ("AudioInjectorMicrophone")
 String to identify log entries originating from this file. More...
 
static unsigned int calculateMaxSampleCountPerTimeout (unsigned int sampleRateHz)
 
static std::string toString (bool value)
 
static const std::string TAG ("DeviceProtocolTracer")
 String to identify log entries originating from this file. More...
 
static const std::string TAG ("FileBasedAudioInjector")
 String to identify log entries originating from this file. More...
 

Variables

static const std::chrono::milliseconds TIMEOUT_FOR_WRITING {500}
 The timeout to use for writing to the SharedDataStream. More...
 
static constexpr unsigned int MILLISECONDS_PER_SECOND = 1000
 Milliseconds per second. More...
 
static const std::string TAG {"DevicePropertyAggregator"}
 String to identify log entries originating from this file. More...
 
static const std::string INVALID_VALUE {"INVALID"}
 String to identify invalid property value. More...
 
static const std::string IDLE {"IDLE"}
 String to identify IDLE property value. More...
 
static const std::string NONE {"NONE"}
 String to identify NONE property value. More...
 
static const std::chrono::seconds TIMEOUT {2}
 Timeout value to wait for asynchronous operations. More...
 
static const std::set< std::string > listOfSynchronousProperties
 The list of Synchronous Properties that need to be retrieved before returning all device properties. More...
 
static const unsigned int DEFAULT_MAX_MESSAGES = 1
 Maximum number of trace messages stored in the device protocol tracer. More...
 

Function Documentation

◆ calculateMaxSampleCountPerTimeout()

static unsigned int alexaClientSDK::diagnostics::calculateMaxSampleCountPerTimeout ( unsigned int  sampleRateHz)
inlinestatic

◆ TAG() [1/3]

static const std::string alexaClientSDK::diagnostics::TAG ( "AudioInjectorMicrophone"  )
static

String to identify log entries originating from this file.

◆ TAG() [2/3]

static const std::string alexaClientSDK::diagnostics::TAG ( "FileBasedAudioInjector"  )
static

String to identify log entries originating from this file.

◆ TAG() [3/3]

static const std::string alexaClientSDK::diagnostics::TAG ( "DeviceProtocolTracer"  )
static

String to identify log entries originating from this file.

◆ toString()

static std::string alexaClientSDK::diagnostics::toString ( bool  value)
static

Standard method to convert bool to string.

Parameters
valueThe boolean value.
Returns
The string representation.

Variable Documentation

◆ DEFAULT_MAX_MESSAGES

const unsigned int alexaClientSDK::diagnostics::DEFAULT_MAX_MESSAGES = 1
static

Maximum number of trace messages stored in the device protocol tracer.

◆ IDLE

const std::string alexaClientSDK::diagnostics::IDLE {"IDLE"}
static

String to identify IDLE property value.

◆ INVALID_VALUE

const std::string alexaClientSDK::diagnostics::INVALID_VALUE {"INVALID"}
static

String to identify invalid property value.

◆ listOfSynchronousProperties

const std::set<std::string> alexaClientSDK::diagnostics::listOfSynchronousProperties
static
Initial value:

The list of Synchronous Properties that need to be retrieved before returning all device properties.

◆ MILLISECONDS_PER_SECOND

constexpr unsigned int alexaClientSDK::diagnostics::MILLISECONDS_PER_SECOND = 1000
static

Milliseconds per second.

◆ NONE

const std::string alexaClientSDK::diagnostics::NONE {"NONE"}
static

String to identify NONE property value.

◆ TAG

const std::string alexaClientSDK::diagnostics::TAG {"DevicePropertyAggregator"}
static

String to identify log entries originating from this file.

◆ TIMEOUT

const std::chrono::seconds alexaClientSDK::diagnostics::TIMEOUT {2}
static

Timeout value to wait for asynchronous operations.

◆ TIMEOUT_FOR_WRITING

const std::chrono::milliseconds alexaClientSDK::diagnostics::TIMEOUT_FOR_WRITING {500}
static

The timeout to use for writing 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