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

Classes

class  CaptionPresenter
 
class  ConsolePrinter
 
class  ConsoleReader
 
class  DefaultEndpointModeControllerHandler
 
class  DefaultEndpointRangeControllerHandler
 
class  DefaultEndpointToggleControllerHandler
 
class  ExternalCapabilitiesBuilder
 
class  GuiRenderer
 
class  InteractionManager
 
class  KeywordObserver
 
class  LocaleAssetsManager
 
class  PeripheralEndpointModeControllerHandler
 
class  PeripheralEndpointPowerControllerHandler
 
class  PeripheralEndpointRangeControllerHandler
 
class  PeripheralEndpointToggleControllerHandler
 
struct  PlatformSpecificValues
 
class  PortAudioMicrophoneWrapper
 This acts as a wrapper around PortAudio, a cross-platform open-source audio I/O library. More...
 
class  RevokeAuthorizationObserver
 
class  SampleApplication
 Class to manage the top-level components of the AVS Client Application. More...
 
class  SampleEqualizerModeController
 
class  SDKDiagnostics
 
class  UIManager
 
class  UserInputManager
 Observes user input from the console and notifies the interaction manager of the user's intentions. More...
 

Typedefs

using MediaPlayerInterface = alexaClientSDK::avsCommon::utils::mediaPlayer::MediaPlayerInterface
 
using ApplicationMediaInterfaces = alexaClientSDK::avsCommon::sdkInterfaces::ApplicationMediaInterfaces
 

Enumerations

enum  SampleAppReturnCode { OK = EXIT_SUCCESS, ERROR = EXIT_FAILURE, RESTART }
 
enum  SettingsValues : char {
  SettingsValues::LOCALE = '1', SettingsValues::DO_NOT_DISTURB = '2', SettingsValues::WAKEWORD_CONFIRMATION = '3', SettingsValues::SPEECH_CONFIRMATION = '4',
  SettingsValues::TIME_ZONE = '5', SettingsValues::NETWORK_INFO = '6', SettingsValues::ALARM_VOLUME_RAMP = '7', SettingsValues::QUIT = 'q'
}
 

Functions

static void notifyObservers (const ModeControllerInterface::ModeState &modeState, avsCommon::sdkInterfaces::AlexaStateChangeCauseType cause, const std::list< std::shared_ptr< ModeControllerObserverInterface >> &observers)
 
static void notifyObservers (const avsCommon::sdkInterfaces::rangeController::RangeControllerInterface::RangeState &rangeState, avsCommon::sdkInterfaces::AlexaStateChangeCauseType cause, const std::list< std::shared_ptr< avsCommon::sdkInterfaces::rangeController::RangeControllerObserverInterface >> &observers)
 
static void notifyObservers (const avsCommon::sdkInterfaces::toggleController::ToggleControllerInterface::ToggleState &toggleState, avsCommon::sdkInterfaces::AlexaStateChangeCauseType cause, const std::list< std::shared_ptr< avsCommon::sdkInterfaces::toggleController::ToggleControllerObserverInterface >> &observers)
 
static const std::string TAG ("ExternalCapabilitiesBuilder")
 String to identify log entries originating from this file. More...
 
static const std::string AUDIO_ITEM_ID_TAG ("audioItemId")
 Tag for find the AudioItemId in the payload of the RenderPlayerInfo directive. More...
 
static const std::string TEMPLATE_TYPE_TAG ("type")
 Tag for find the template type in the payload of the RenderTemplate directive. More...
 
static const std::string TITLE_NODE ("title")
 Tag for find the title node in the payload of the RenderTemplate directive. More...
 
static const std::string CONTROLS_NODE ("controls")
 Tag for find the controls node in the payload of the RenderTemplate directive. More...
 
static const std::string CONTROLS_NAME_KEY ("name")
 Tag for find the controls name key in the payload of the RenderTemplate directive. More...
 
static const std::string CONTROLS_SELECTED_KEY ("selected")
 Tag for find the controls selected key in the payload of the RenderTemplate directive. More...
 
static const std::string MAIN_TITLE_TAG ("mainTitle")
 Tag for find the maintitle in the title node of the RenderTemplate directive. More...
 
static const std::string BUTTON_NAME_SKIPFORWARD ("SKIP_FORWARD")
 
static const std::string BUTTON_NAME_SKIPBACKWARD ("SKIP_BACKWARD")
 
static std::string boolToSelectedString (bool selected)
 utility for bool to state string More...
 
static const std::string TAG ("InteractionManager")
 String to identify log entries originating from this file. More...
 
static const std::string TAG ("KeywordObserver")
 String to identify log entries originating from this file. More...
 
static void computeStartOfSpeechTimestamp (const avsCommon::avs::AudioInputStream::Index wakewordBeginIndex, const avsCommon::avs::AudioInputStream::Index wakewordEndIndex, const int sampleRateHz, const std::shared_ptr< avsCommon::avs::AudioInputStream > &stream, std::chrono::steady_clock::time_point &startOfSpeechTimestamp)
 
static void notifyObservers (const ModeControllerInterface::ModeState &modeState, avsCommon::sdkInterfaces::AlexaStateChangeCauseType cause, const std::list< std::shared_ptr< ModeControllerObserverInterface >> &observers)
 
static void notifyObservers (const avsCommon::sdkInterfaces::powerController::PowerControllerInterface::PowerState &powerState, avsCommon::sdkInterfaces::AlexaStateChangeCauseType cause, const std::list< std::shared_ptr< avsCommon::sdkInterfaces::powerController::PowerControllerObserverInterface >> &observers)
 
static void notifyObservers (const avsCommon::sdkInterfaces::rangeController::RangeControllerInterface::RangeState &rangeState, avsCommon::sdkInterfaces::AlexaStateChangeCauseType cause, const std::list< std::shared_ptr< avsCommon::sdkInterfaces::rangeController::RangeControllerObserverInterface >> &observers)
 
static void notifyObservers (const avsCommon::sdkInterfaces::toggleController::ToggleControllerInterface::ToggleState &toggleState, avsCommon::sdkInterfaces::AlexaStateChangeCauseType cause, const std::list< std::shared_ptr< avsCommon::sdkInterfaces::toggleController::ToggleControllerObserverInterface >> &observers)
 
static const std::string SAMPLE_APP_CONFIG_ROOT_KEY ("sampleApp")
 
static const std::string PORTAUDIO_CONFIG_ROOT_KEY ("portAudio")
 
static const std::string PORTAUDIO_CONFIG_SUGGESTED_LATENCY_KEY ("suggestedLatency")
 
static const std::string TAG ("PortAudioMicrophoneWrapper")
 String to identify log entries originating from this file. More...
 
static const std::string SAMPLE_APP_CONFIG_KEY ("sampleApp")
 Key for the root node value containing configuration values for SampleApp. More...
 
static const std::string EQUALIZER_CONFIG_KEY ("equalizer")
 Key for the root node value containing configuration values for Equalizer. More...
 
static const std::string FIRMWARE_VERSION_KEY ("firmwareVersion")
 Key for the firmwareVersion value under the SAMPLE_APP_CONFIG_KEY configuration node. More...
 
static const std::string ENDPOINT_KEY ("endpoint")
 Key for the endpoint value under the SAMPLE_APP_CONFIG_KEY configuration node. More...
 
static const std::string DISPLAY_CARD_KEY ("displayCardsSupported")
 Key for setting if display cards are supported or not under the SAMPLE_APP_CONFIG_KEY configuration node. More...
 
static const std::string AUDIO_MEDIAPLAYER_POOL_SIZE_KEY ("audioMediaPlayerPoolSize")
 Key for the Audio MediaPlayer pool size. More...
 
static const std::string TAG ("SampleApplication")
 String to identify log entries originating from this file. More...
 
static alexaClientSDK::avsCommon::utils::logger::Level getLogLevelFromUserInput (std::string userInputLogLevel)
 
static bool ignoreSigpipeSignals ()
 
static const std::string TAG ("SDKDiagnostics")
 String to identify log entries originating from this file. More...
 
static const std::unordered_map< char, std::string > TZ_VALUES ({{ '1', "America/Vancouver"}, { '2', "America/Edmonton"}, { '3', "America/Winnipeg"}, { '4', "America/Toronto"}, { '5', "America/Halifax"}, { '6', "America/St_Johns"}})
 
static const std::unordered_map< char, ChannelVolumeInterface::TypeSPEAKER_TYPES ({{ '1', ChannelVolumeInterface::Type::AVS_SPEAKER_VOLUME}, { '2', ChannelVolumeInterface::Type::AVS_ALERTS_VOLUME}})
 
static const std::string TAG ("UserInputManager")
 String to identify log entries originating from this file. More...
 
void boolSettingMenu (std::function< void(bool)> setFunction)
 

Variables

static const std::chrono::milliseconds READ_REQUEST_PENDING_TIMEOUT {100}
 Time to wait for if there's a pending read request from the user. More...
 
static const std::string RENDER_TEMPLATE_HEADER
 Begin a RenderTemplate UI block. More...
 
static const std::string RENDER_TEMPLATE_CLEARED
 RenderTemplate UI has been cleared by AVS. More...
 
static const std::string RENDER_FOOTER
 Generic Separator. More...
 
static const std::string RENDER_PLAYER_INFO_HEADER
 Begin a PlayerInfo UI block. More...
 
static const std::string RENDER_PLAYER_CONTROLS_HEADER
 Begin a PlayerInfo UI GUI controls block. More...
 
static const std::string RENDER_PLAYER_INFO_CLEARED
 PlayerInfo UI has been cleared by AVS. More...
 
static const std::string ENDPOINT_DESCRIPTION = "dynamic light endpoint"
 Dynamic endpoint description. More...
 
static const std::string ENDPOINT_MANUFACTURER_NAME = "Amazon"
 Dynamic endpoint manufacturer name. More...
 
static const std::vector< std::string > ENDPOINT_DISPLAY_CATEGORIES = {"OTHER"}
 Dynamic endpoint display categories. More...
 
static const std::string SETTING_CONFIGURATION_ROOT_KEY = "deviceSettings"
 The key in our config file to find the root of settings for this database. More...
 
static const std::string LOCALES_CONFIGURATION_KEY = "locales"
 The key to find the locales configuration. More...
 
static const std::string DEFAULT_LOCALE_CONFIGURATION_KEY = "defaultLocale"
 The key to find the locales configuration. More...
 
static const std::string LOCALE_COMBINATION_CONFIGURATION_KEY = "localeCombinations"
 The key to find the locales combinations configuration. More...
 
static const std::string DEFAULT_LOCALE_VALUE = "en-US"
 The default locale value used if the locale configuration is not present. More...
 
static const std::string DEFAULT_SUPPORTED_WAKEWORD = "ALEXA"
 The default supported wake word. More...
 
static const int NUM_INPUT_CHANNELS = 1
 
static const int NUM_OUTPUT_CHANNELS = 0
 
static const double SAMPLE_RATE = 16000
 
static const unsigned long PREFERRED_SAMPLES_PER_CALLBACK = paFramesPerBufferUnspecified
 
static const size_t WORD_SIZE = 2
 The size of each word within the stream. More...
 
static const size_t MAX_READERS = 10
 The maximum number of readers of the stream. More...
 
static const unsigned int AUDIO_MEDIAPLAYER_POOL_SIZE_DEFAULT = 2
 
static const std::chrono::seconds AMOUNT_OF_AUDIO_DATA_IN_BUFFER = std::chrono::seconds(15)
 The amount of audio data to keep in the ring buffer. More...
 
static const std::set< alexaClientSDK::avsCommon::utils::logger::LevelallLevels
 A set of all log levels. More...
 
static const std::string VERSION = avsCommon::utils::sdkVersion::getCurrentVersion()
 
static const std::string ALEXA_WELCOME_MESSAGE
 
static const std::string HELP_MESSAGE
 
static const std::string LIMITED_HELP_HEADER
 
static const std::string AUDIO_INJECTION_HEADER
 
static const std::string AUTH_FAILED_STR
 
static const std::string REAUTH_REQUIRED_STR
 
static const std::string CAPABILITIES_API_FAILED_STR
 
static const std::string LIMITED_HELP_MESSAGE
 
static const std::string SETTINGS_MESSAGE
 
static const std::string LOCALE_MESSAGE_HEADER
 
static const std::string LOCALE_MESSAGE_FOOTER
 
static const std::string SPEAKER_CONTROL_MESSAGE
 
static const std::string FIRMWARE_CONTROL_MESSAGE
 
static const std::string VOLUME_CONTROL_MESSAGE
 
static const std::string RESET_CONFIRMATION
 
static const std::string REAUTHORIZE_CONFIRMATION
 
static const std::string ALARM_VOLUME_RAMP_HEADER
 
static const std::string SPEECH_CONFIRMATION_HEADER
 
static const std::string WAKEWORD_CONFIRMATION_HEADER
 
static const std::string DONOTDISTURB_CONFIRMATION_HEADER
 
static const std::string ENABLE_SETTING_MENU
 
static const std::string TIMEZONE_SETTING_MENU
 
static const std::string NETWORK_INFO_SETTING_MENU
 
static const std::initializer_list< std::string > NETWORK_INFO_CONNECTION_TYPE_PROMPT
 
static const std::initializer_list< std::string > NETWORK_INFO_ESSID_PROMPT
 
static const std::initializer_list< std::string > NETWORK_INFO_BSSID_PROMPT
 
static const std::initializer_list< std::string > NETWORK_INFO_IP_PROMPT
 
static const std::initializer_list< std::string > NETWORK_INFO_SUBNET_MASK_PROMPT
 
static const std::initializer_list< std::string > NETWORK_INFO_MAC_ADDRESS_PROMPT
 
static const std::initializer_list< std::string > NETWORK_INFO_DHCP_ADDRESS_PROMPT
 
static const std::initializer_list< std::string > NETWORK_INFO_STATIC_IP_PROMPT
 
static const std::string DIAGNOSTICS_SCREEN
 
static const std::string AUDIO_INJECTION_SCREEN
 
static const std::string DEVICE_PROTOCOL_TRACE_SCREEN
 
static const std::string DEVICE_PROPERTIES_SCREEN
 
static const std::string RESET_WARNING
 
static const std::string ENTER_LIMITED = "Entering limited interaction mode."
 
static const std::string ALARM_VOLUME_RAMP_NAME = "AlarmVolumeRamp"
 The name of the alarm volume ramp setting. More...
 
static const std::string SPEECH_CONFIRMATION_NAME = "SpeechConfirmation"
 The name of the speech confirmation setting. More...
 
static const std::string WAKEWORD_CONFIRMATION_NAME = "WakeWordConfirmation"
 The name of the wake word confirmation setting. More...
 
static const std::string TIMEZONE_NAME = "TimeZone"
 The name of the time zone setting. More...
 
static const std::string LOCALE_NAME = "Locale"
 The name of the locale setting. More...
 
static const std::string WAKE_WORDS_NAME = "WakeWords"
 The name of the wake words setting. More...
 
static const std::string DO_NOT_DISTURB_NAME = "DoNotDisturb"
 The name of the do not disturb confirmation setting. More...
 
static const std::string NETWORK_INFO_NAME = "NetworkInfo"
 The name of the network info setting. More...
 
static const unsigned int OPTION_ENUM_START = 1
 The index of the first option in displaying a list of options. More...
 
static const std::string COMMS_MESSAGE
 
static const std::string DTMF_MESSAGE
 
static const char HOLD = 'h'
 
static const char TAP = 't'
 
static const char QUIT = 'q'
 
static const char INFO = 'i'
 
static const char MIC_TOGGLE = 'm'
 
static const char STOP = 's'
 
static const char PLAY = '1'
 
static const char PAUSE = '2'
 
static const char NEXT = '3'
 
static const char PREVIOUS = '4'
 
static const char SKIP_FORWARD = '5'
 
static const char SKIP_BACKWARD = '6'
 
static const char SHUFFLE = '7'
 
static const char LOOP = '8'
 
static const char REPEAT = '9'
 
static const char THUMBS_UP = '+'
 
static const char THUMBS_DOWN = '-'
 
static const char SETTINGS = 'c'
 
static const char SPEAKER_CONTROL = 'p'
 
static const char FIRMWARE_VERSION = 'f'
 
static const char RESET = 'k'
 
static const char REAUTHORIZE = 'z'
 
static const char DEVICE_SETUP_COMPLETE = 'v'
 
static constexpr char ENABLE = 'E'
 
static constexpr char DISABLE = 'D'
 
static const unsigned OPTION_ENUM_START = 1
 The index of the first option in displaying a list of options. More...
 
static const unsigned OPTION_ENUM_QUIT = 0
 The number used to quit a numeric options menu. More...
 
static const int8_t INCREASE_VOLUME = 10
 
static const int8_t DECREASE_VOLUME = -10
 
static const auto READ_CONSOLE_TIMEOUT = std::chrono::milliseconds(100)
 Time to wait for console input. More...
 

Typedef Documentation

◆ ApplicationMediaInterfaces

◆ MediaPlayerInterface

Enumeration Type Documentation

◆ SampleAppReturnCode

Enumerator
OK 

The SampleApp exits in success.

ERROR 

The SampleApp exits in failure.

RESTART 

The SampleApp exits and needs a restart.

◆ SettingsValues

Enumerator
LOCALE 
DO_NOT_DISTURB 
WAKEWORD_CONFIRMATION 
SPEECH_CONFIRMATION 
TIME_ZONE 
NETWORK_INFO 
ALARM_VOLUME_RAMP 
QUIT 

Function Documentation

◆ AUDIO_ITEM_ID_TAG()

static const std::string alexaClientSDK::sampleApp::AUDIO_ITEM_ID_TAG ( "audioItemId"  )
static

Tag for find the AudioItemId in the payload of the RenderPlayerInfo directive.

◆ AUDIO_MEDIAPLAYER_POOL_SIZE_KEY()

static const std::string alexaClientSDK::sampleApp::AUDIO_MEDIAPLAYER_POOL_SIZE_KEY ( "audioMediaPlayerPoolSize"  )
static

Key for the Audio MediaPlayer pool size.

◆ boolSettingMenu()

void alexaClientSDK::sampleApp::boolSettingMenu ( std::function< void(bool)>  setFunction)

◆ boolToSelectedString()

static std::string alexaClientSDK::sampleApp::boolToSelectedString ( bool  selected)
static

utility for bool to state string

◆ BUTTON_NAME_SKIPBACKWARD()

static const std::string alexaClientSDK::sampleApp::BUTTON_NAME_SKIPBACKWARD ( "SKIP_BACKWARD"  )
static

◆ BUTTON_NAME_SKIPFORWARD()

static const std::string alexaClientSDK::sampleApp::BUTTON_NAME_SKIPFORWARD ( "SKIP_FORWARD"  )
static

◆ computeStartOfSpeechTimestamp()

static void alexaClientSDK::sampleApp::computeStartOfSpeechTimestamp ( const avsCommon::avs::AudioInputStream::Index  wakewordBeginIndex,
const avsCommon::avs::AudioInputStream::Index  wakewordEndIndex,
const int  sampleRateHz,
const std::shared_ptr< avsCommon::avs::AudioInputStream > &  stream,
std::chrono::steady_clock::time_point &  startOfSpeechTimestamp 
)
static

Compute the start of speech timestamp used in UPL calculations. This is calculated by taking the time detected on wakeword to the time and subtracting the duration of the wakeword uttered to determine time at the start of the wakeword. startOfSpeechTimestamp must be set to the time on wakeword detected for this calculation to work. If wakeword duration can not be calculated start of speech timestamp is left as the time on wakeword detected.

Parameters
wakewordBeingIndexThe begin index of the first part of the keyword found within the stream.
wakewordEndIndexThe end index of the last part of the keyword within the stream.
sampleRateHzThe SampleRate in Hz of the stream.
streamThe stream in which the keyword was detected.
startOfSpeechTimestampMoment in time to calculate when user started talking to Alexa.

◆ CONTROLS_NAME_KEY()

static const std::string alexaClientSDK::sampleApp::CONTROLS_NAME_KEY ( "name"  )
static

Tag for find the controls name key in the payload of the RenderTemplate directive.

◆ CONTROLS_NODE()

static const std::string alexaClientSDK::sampleApp::CONTROLS_NODE ( "controls"  )
static

Tag for find the controls node in the payload of the RenderTemplate directive.

◆ CONTROLS_SELECTED_KEY()

static const std::string alexaClientSDK::sampleApp::CONTROLS_SELECTED_KEY ( "selected"  )
static

Tag for find the controls selected key in the payload of the RenderTemplate directive.

◆ DISPLAY_CARD_KEY()

static const std::string alexaClientSDK::sampleApp::DISPLAY_CARD_KEY ( "displayCardsSupported"  )
static

Key for setting if display cards are supported or not under the SAMPLE_APP_CONFIG_KEY configuration node.

◆ ENDPOINT_KEY()

static const std::string alexaClientSDK::sampleApp::ENDPOINT_KEY ( "endpoint"  )
static

Key for the endpoint value under the SAMPLE_APP_CONFIG_KEY configuration node.

◆ EQUALIZER_CONFIG_KEY()

static const std::string alexaClientSDK::sampleApp::EQUALIZER_CONFIG_KEY ( "equalizer"  )
static

Key for the root node value containing configuration values for Equalizer.

◆ FIRMWARE_VERSION_KEY()

static const std::string alexaClientSDK::sampleApp::FIRMWARE_VERSION_KEY ( "firmwareVersion"  )
static

Key for the firmwareVersion value under the SAMPLE_APP_CONFIG_KEY configuration node.

◆ getLogLevelFromUserInput()

static alexaClientSDK::avsCommon::utils::logger::Level alexaClientSDK::sampleApp::getLogLevelFromUserInput ( std::string  userInputLogLevel)
static

Gets a log level consumable by the SDK based on the user input string for log level.

Parameters
userInputLogLevelThe string to be parsed into a log level.
Returns
The log level. This will default to NONE if the input string is not properly parsable.

◆ ignoreSigpipeSignals()

static bool alexaClientSDK::sampleApp::ignoreSigpipeSignals ( )
static

Allows the process to ignore the SIGPIPE signal. The SIGPIPE signal may be received when the application performs a write to a closed socket. This is a case that arises in the use of certain networking libraries.

Returns
true if the action for handling SIGPIPEs was correctly set to ignore, else false.

◆ MAIN_TITLE_TAG()

static const std::string alexaClientSDK::sampleApp::MAIN_TITLE_TAG ( "mainTitle"  )
static

Tag for find the maintitle in the title node of the RenderTemplate directive.

◆ notifyObservers() [1/7]

static void alexaClientSDK::sampleApp::notifyObservers ( const avsCommon::sdkInterfaces::powerController::PowerControllerInterface::PowerState powerState,
avsCommon::sdkInterfaces::AlexaStateChangeCauseType  cause,
const std::list< std::shared_ptr< avsCommon::sdkInterfaces::powerController::PowerControllerObserverInterface >> &  observers 
)
static

Helper function to notify power state change to the observers of PowerControllerObserverInterface.

Parameters
powerStateThe changed power state to be notified to the observer.
causeThe change cause represented using AlexaStateChangeCauseType.
observersThe list of observer to be notified.

◆ notifyObservers() [2/7]

static void alexaClientSDK::sampleApp::notifyObservers ( const avsCommon::sdkInterfaces::toggleController::ToggleControllerInterface::ToggleState toggleState,
avsCommon::sdkInterfaces::AlexaStateChangeCauseType  cause,
const std::list< std::shared_ptr< avsCommon::sdkInterfaces::toggleController::ToggleControllerObserverInterface >> &  observers 
)
static

Helper function to notify toggle state change to the observers of ToggleControllerObserverInterface.

Parameters
toggleStateThe changed toggle state to be notified to the observer.
causeThe change cause represented using AlexaStateChangeCauseType.
observersThe list of observer to be notified.

◆ notifyObservers() [3/7]

static void alexaClientSDK::sampleApp::notifyObservers ( const avsCommon::sdkInterfaces::toggleController::ToggleControllerInterface::ToggleState toggleState,
avsCommon::sdkInterfaces::AlexaStateChangeCauseType  cause,
const std::list< std::shared_ptr< avsCommon::sdkInterfaces::toggleController::ToggleControllerObserverInterface >> &  observers 
)
static

Helper function to notify toggle state change to the observers of ToggleControllerObserverInterface.

Parameters
toggleStateThe changed toggle state to be notified to the observer.
causeThe change cause represented using AlexaStateChangeCauseType.
observersThe list of observer to be notified.

◆ notifyObservers() [4/7]

static void alexaClientSDK::sampleApp::notifyObservers ( const ModeControllerInterface::ModeState modeState,
avsCommon::sdkInterfaces::AlexaStateChangeCauseType  cause,
const std::list< std::shared_ptr< ModeControllerObserverInterface >> &  observers 
)
static

Helper function to notify mode value change to the observers of ModeControllerObserverInterface.

Parameters
modeStateThe changed mode to be notified to the observer.
causeThe change cause represented using AlexaStateChangeCauseType.
observersThe list of observers to be notified.

◆ notifyObservers() [5/7]

static void alexaClientSDK::sampleApp::notifyObservers ( const avsCommon::sdkInterfaces::rangeController::RangeControllerInterface::RangeState rangeState,
avsCommon::sdkInterfaces::AlexaStateChangeCauseType  cause,
const std::list< std::shared_ptr< avsCommon::sdkInterfaces::rangeController::RangeControllerObserverInterface >> &  observers 
)
static

Helper function to notify range value change to the observers of RangeControllerObserverInterface.

Parameters
rangeValueThe changed range value to be notified to the observer.
causeThe change cause represented using AlexaStateChangeCauseType.
observersThe list of observer to be notified.

◆ notifyObservers() [6/7]

static void alexaClientSDK::sampleApp::notifyObservers ( const avsCommon::sdkInterfaces::rangeController::RangeControllerInterface::RangeState rangeState,
avsCommon::sdkInterfaces::AlexaStateChangeCauseType  cause,
const std::list< std::shared_ptr< avsCommon::sdkInterfaces::rangeController::RangeControllerObserverInterface >> &  observers 
)
static

Helper function to notify range value change to the observers of RangeControllerObserverInterface.

Parameters
rangeValueThe changed range value to be notified to the observer.
causeThe change cause represented using AlexaStateChangeCauseType.
observersThe list of observer to be notified.

◆ notifyObservers() [7/7]

static void alexaClientSDK::sampleApp::notifyObservers ( const ModeControllerInterface::ModeState modeState,
avsCommon::sdkInterfaces::AlexaStateChangeCauseType  cause,
const std::list< std::shared_ptr< ModeControllerObserverInterface >> &  observers 
)
static

Helper function to notify mode value change to the observers of ModeControllerObserverInterface.

Parameters
modeStateThe changed mode to be notified to the observer.
causeThe change cause represented using AlexaStateChangeCauseType.
observersThe list of observers to be notified.

◆ PORTAUDIO_CONFIG_ROOT_KEY()

static const std::string alexaClientSDK::sampleApp::PORTAUDIO_CONFIG_ROOT_KEY ( "portAudio"  )
static

◆ PORTAUDIO_CONFIG_SUGGESTED_LATENCY_KEY()

static const std::string alexaClientSDK::sampleApp::PORTAUDIO_CONFIG_SUGGESTED_LATENCY_KEY ( "suggestedLatency"  )
static

◆ SAMPLE_APP_CONFIG_KEY()

static const std::string alexaClientSDK::sampleApp::SAMPLE_APP_CONFIG_KEY ( "sampleApp"  )
static

Key for the root node value containing configuration values for SampleApp.

◆ SAMPLE_APP_CONFIG_ROOT_KEY()

static const std::string alexaClientSDK::sampleApp::SAMPLE_APP_CONFIG_ROOT_KEY ( "sampleApp"  )
static

◆ SPEAKER_TYPES()

static const std::unordered_map<char, ChannelVolumeInterface::Type> alexaClientSDK::sampleApp::SPEAKER_TYPES ( {{ '1', ChannelVolumeInterface::Type::AVS_SPEAKER_VOLUME}, { '2', ChannelVolumeInterface::Type::AVS_ALERTS_VOLUME}}  )
static

◆ TAG() [1/7]

static const std::string alexaClientSDK::sampleApp::TAG ( "KeywordObserver"  )
static

String to identify log entries originating from this file.

◆ TAG() [2/7]

static const std::string alexaClientSDK::sampleApp::TAG ( "SDKDiagnostics"  )
static

String to identify log entries originating from this file.

◆ TAG() [3/7]

static const std::string alexaClientSDK::sampleApp::TAG ( "InteractionManager"  )
static

String to identify log entries originating from this file.

◆ TAG() [4/7]

static const std::string alexaClientSDK::sampleApp::TAG ( "PortAudioMicrophoneWrapper"  )
static

String to identify log entries originating from this file.

◆ TAG() [5/7]

static const std::string alexaClientSDK::sampleApp::TAG ( "ExternalCapabilitiesBuilder"  )
static

String to identify log entries originating from this file.

◆ TAG() [6/7]

static const std::string alexaClientSDK::sampleApp::TAG ( "UserInputManager"  )
static

String to identify log entries originating from this file.

◆ TAG() [7/7]

static const std::string alexaClientSDK::sampleApp::TAG ( "SampleApplication"  )
static

String to identify log entries originating from this file.

◆ TEMPLATE_TYPE_TAG()

static const std::string alexaClientSDK::sampleApp::TEMPLATE_TYPE_TAG ( "type"  )
static

Tag for find the template type in the payload of the RenderTemplate directive.

◆ TITLE_NODE()

static const std::string alexaClientSDK::sampleApp::TITLE_NODE ( "title"  )
static

Tag for find the title node in the payload of the RenderTemplate directive.

◆ TZ_VALUES()

static const std::unordered_map<char, std::string> alexaClientSDK::sampleApp::TZ_VALUES ( {{ '1', "America/Vancouver"}, { '2', "America/Edmonton"}, { '3', "America/Winnipeg"}, { '4', "America/Toronto"}, { '5', "America/Halifax"}, { '6', "America/St_Johns"}}  )
static

Variable Documentation

◆ ALARM_VOLUME_RAMP_HEADER

const std::string alexaClientSDK::sampleApp::ALARM_VOLUME_RAMP_HEADER
static
Initial value:
=
"+----------------------------------------------------------------------------+\n"
"| Alarm Volume Ramp Configuration: |"

◆ ALARM_VOLUME_RAMP_NAME

const std::string alexaClientSDK::sampleApp::ALARM_VOLUME_RAMP_NAME = "AlarmVolumeRamp"
static

The name of the alarm volume ramp setting.

◆ ALEXA_WELCOME_MESSAGE

const std::string alexaClientSDK::sampleApp::ALEXA_WELCOME_MESSAGE
static
Initial value:
=
" # # # ##### ##### ###### # # \n"
" # # # # # # # # # # # # \n"
" # # # # # # # # # # \n"
" # # # # ##### ##### # # ### \n"
" ####### # # # # # # # # \n"
" # # # # # # # # # # # # \n"
" # # # ##### ##### ###### # # \n"
" \n"
" ##### # \n"
" # # ## # # ##### # ###### # # ##### ##### \n"
" # # # ## ## # # # # # # # # # # \n"
" ##### # # # ## # # # # ##### # # # # # # \n"
" # ###### # # ##### # # ####### ##### ##### \n"
" # # # # # # # # # # # # # \n"
" ##### # # # # # ###### ###### # # # # \n\n"
" SDK Version " + VERSION + "\n\n"
static const std::string VERSION
Definition: UIManager.cpp:48

◆ allLevels

const std::set<alexaClientSDK::avsCommon::utils::logger::Level> alexaClientSDK::sampleApp::allLevels
static
Initial value:
= {
Most verbose debug log level. Compiled out when ACSDK_DEBUG_LOG_ENABLED is not defined.
Log of a event that indicates an unrecoverable error.
Logs of normal operations, to be used in release builds.
Log of an event that indicates an error.
Intermediate debug log level. Compiled out when ACSDK_DEBUG_LOG_ENABLED is not defined.
Intermediate debug log level. Compiled out when ACSDK_DEBUG_LOG_ENABLED is not defined.
Least verbose debug log level. Compiled out when ACSDK_DEBUG_LOG_ENABLED is not defined.
Intermediate debug log level. Compiled out when ACSDK_DEBUG_LOG_ENABLED is not defined.
Intermediate debug log level. Compiled out when ACSDK_DEBUG_LOG_ENABLED is not defined.
Intermediate debug log level. Compiled out when ACSDK_DEBUG_LOG_ENABLED is not defined.
Log of an event that may indicate a problem.
Intermediate debug log level. Compiled out when ACSDK_DEBUG_LOG_ENABLED is not defined.
Intermediate debug log level. Compiled out when ACSDK_DEBUG_LOG_ENABLED is not defined.
Intermediate debug log level. Compiled out when ACSDK_DEBUG_LOG_ENABLED is not defined.

A set of all log levels.

◆ AMOUNT_OF_AUDIO_DATA_IN_BUFFER

const std::chrono::seconds alexaClientSDK::sampleApp::AMOUNT_OF_AUDIO_DATA_IN_BUFFER = std::chrono::seconds(15)
static

The amount of audio data to keep in the ring buffer.

◆ AUDIO_INJECTION_HEADER

const std::string alexaClientSDK::sampleApp::AUDIO_INJECTION_HEADER
static
Initial value:
=
"+----------------------------------------------------------------------------+\n"
"|Diagnostic audio injection has been ENABLED. Audio recording is UNAVAILABLE.|\n"
"+----------------------------------------------------------------------------+\n"

◆ AUDIO_INJECTION_SCREEN

const std::string alexaClientSDK::sampleApp::AUDIO_INJECTION_SCREEN
static
Initial value:
=
"+------------------------------------------------------------------------------+\n"
"| Audio Injection Screen: |\n"
"| |\n"
"| This diagnostic allows for injecting audio from wav files directly into the |\n"
"| microphone. Note input wav files should conform to the following: |\n"
"| |\n"
"| Sample Size : 16 bytes |\n"
"| Sample Rate : 16Khz |\n"
"| Number of channels : 1 |\n"
"| Endianness : Little |\n"
"| Encoding Format : LPCM |\n"
"| |\n"
"| Press '1' followed by Enter to go into input mode. Once inside input mode, |\n"
"| enter the absolute path of the wav file to inject audio from wav file. |\n"
"| |\n"
"| Press 'i' followed by Enter for help. |\n"
"| Press 'q' followed by Enter to go to the previous screen. |\n"
"+------------------------------------------------------------------------------+\n"

◆ AUDIO_MEDIAPLAYER_POOL_SIZE_DEFAULT

const unsigned int alexaClientSDK::sampleApp::AUDIO_MEDIAPLAYER_POOL_SIZE_DEFAULT = 2
static

The default number of MediaPlayers used by AudioPlayer CA/ Can be overridden in the Configuration using AUDIO_MEDIAPLAYER_POOL_SIZE_KEY

◆ AUTH_FAILED_STR

const std::string alexaClientSDK::sampleApp::AUTH_FAILED_STR
static
Initial value:
=
"| Status : Unrecoverable authorization failure. |\n"

◆ CAPABILITIES_API_FAILED_STR

const std::string alexaClientSDK::sampleApp::CAPABILITIES_API_FAILED_STR
static
Initial value:
=
"| Status : Unrecoverable Capabilities API call failure. |\n"

◆ COMMS_MESSAGE

const std::string alexaClientSDK::sampleApp::COMMS_MESSAGE
static
Initial value:
=
"+----------------------------------------------------------------------------+\n"
"| Comms Options: |\n"
"| |\n"
"| Press 'a' followed by Enter to accept an incoming call. |\n"
"| Press 's' followed by Enter to stop an ongoing call. |\n"
"| Press 'd' followed by Enter to input dtmf tones. |\n"
"| Press 'm' followed by Enter to mute/unmte self during an active call. |\n"
"| Press 'q' to exit Comms Control Mode. |\n"
"+----------------------------------------------------------------------------+\n"

◆ DECREASE_VOLUME

const int8_t alexaClientSDK::sampleApp::DECREASE_VOLUME = -10
static

◆ DEFAULT_LOCALE_CONFIGURATION_KEY

const std::string alexaClientSDK::sampleApp::DEFAULT_LOCALE_CONFIGURATION_KEY = "defaultLocale"
static

The key to find the locales configuration.

◆ DEFAULT_LOCALE_VALUE

const std::string alexaClientSDK::sampleApp::DEFAULT_LOCALE_VALUE = "en-US"
static

The default locale value used if the locale configuration is not present.

◆ DEFAULT_SUPPORTED_WAKEWORD

const std::string alexaClientSDK::sampleApp::DEFAULT_SUPPORTED_WAKEWORD = "ALEXA"
static

The default supported wake word.

◆ DEVICE_PROPERTIES_SCREEN

const std::string alexaClientSDK::sampleApp::DEVICE_PROPERTIES_SCREEN
static
Initial value:
=
"+----------------------------------------------------------------------------+\n"
"| Device Properties Screen: |\n"
"| |\n"
"| Press 'p' followed by Enter to show the current device properties |\n"
"| |\n"
"| Press 'i' followed by Enter for help. |\n"
"| Press 'q' followed by Enter to go to the previous screen. |\n"
"+----------------------------------------------------------------------------+\n"

◆ DEVICE_PROTOCOL_TRACE_SCREEN

const std::string alexaClientSDK::sampleApp::DEVICE_PROTOCOL_TRACE_SCREEN
static
Initial value:
=
"+----------------------------------------------------------------------------+\n"
"| Device Protocol Trace Screen: |\n"
"| |\n"
"| Press 'e' followed by Enter to enable device protocol trace. |\n"
"| Press 'd' followed by Enter to disable device protocol trace. |\n"
"| Press 'c' followed by Enter to clear the protocol trace. |\n"
"| Press 't' followed by Enter to show the protocol trace. |\n"
"| |\n"
"| Press 'i' followed by Enter for help. |\n"
"| Press 'q' followed by Enter to go to the previous screen. |\n"
"| |\n"
"| Note: After the limit is reached, protocol tracing halts. |\n"
"| The default is 100, and it is a configurable value in the JSON config. |\n"
"+----------------------------------------------------------------------------+\n"

◆ DEVICE_SETUP_COMPLETE

const char alexaClientSDK::sampleApp::DEVICE_SETUP_COMPLETE = 'v'
static

◆ DIAGNOSTICS_SCREEN

const std::string alexaClientSDK::sampleApp::DIAGNOSTICS_SCREEN
static
Initial value:
=
"+----------------------------------------------------------------------------+\n"
"| Diagnostics Options: |\n"
"| |\n"
"| |\n"
"| Press 'i' followed by Enter for help. |\n"
"| Press 'q' followed by Enter to go to the previous screen. |\n"
"+----------------------------------------------------------------------------+\n"

◆ DISABLE

constexpr char alexaClientSDK::sampleApp::DISABLE = 'D'
static

◆ DO_NOT_DISTURB_NAME

const std::string alexaClientSDK::sampleApp::DO_NOT_DISTURB_NAME = "DoNotDisturb"
static

The name of the do not disturb confirmation setting.

◆ DONOTDISTURB_CONFIRMATION_HEADER

const std::string alexaClientSDK::sampleApp::DONOTDISTURB_CONFIRMATION_HEADER
static
Initial value:
=
"+----------------------------------------------------------------------------+\n"
"| Do Not Disturb Mode Configuration: |"

◆ DTMF_MESSAGE

const std::string alexaClientSDK::sampleApp::DTMF_MESSAGE
static
Initial value:
=
"+----------------------------------------------------------------------------+\n"
"| Dtmf Tones: |\n"
"| |\n"
"| Enter dtmf tones followed by Enter. |\n"
"| |\n"
"+----------------------------------------------------------------------------+\n"

◆ ENABLE

constexpr char alexaClientSDK::sampleApp::ENABLE = 'E'
static

◆ ENABLE_SETTING_MENU

const std::string alexaClientSDK::sampleApp::ENABLE_SETTING_MENU
static
Initial value:
=
"| |\n"
"| Press 'E' followed by Enter to enable this configuration. |\n"
"| Press 'D' followed by Enter to disable this configuration. |\n"
"| Press 'q' followed by Enter to quit this configuration menu. |\n"
"+----------------------------------------------------------------------------+\n"

◆ ENDPOINT_DESCRIPTION

const std::string alexaClientSDK::sampleApp::ENDPOINT_DESCRIPTION = "dynamic light endpoint"
static

Dynamic endpoint description.

◆ ENDPOINT_DISPLAY_CATEGORIES

const std::vector<std::string> alexaClientSDK::sampleApp::ENDPOINT_DISPLAY_CATEGORIES = {"OTHER"}
static

Dynamic endpoint display categories.

◆ ENDPOINT_MANUFACTURER_NAME

const std::string alexaClientSDK::sampleApp::ENDPOINT_MANUFACTURER_NAME = "Amazon"
static

Dynamic endpoint manufacturer name.

◆ ENTER_LIMITED

const std::string alexaClientSDK::sampleApp::ENTER_LIMITED = "Entering limited interaction mode."
static

◆ FIRMWARE_CONTROL_MESSAGE

const std::string alexaClientSDK::sampleApp::FIRMWARE_CONTROL_MESSAGE
static
Initial value:
=
"+----------------------------------------------------------------------------+\n"
"| Firmware Version: |\n"
"| |\n"
"| Enter a decimal integer value between 1 and 2147483647. |\n"
"+----------------------------------------------------------------------------+\n"

◆ FIRMWARE_VERSION

const char alexaClientSDK::sampleApp::FIRMWARE_VERSION = 'f'
static

◆ HELP_MESSAGE

const std::string alexaClientSDK::sampleApp::HELP_MESSAGE
static

◆ HOLD

const char alexaClientSDK::sampleApp::HOLD = 'h'
static

◆ INCREASE_VOLUME

const int8_t alexaClientSDK::sampleApp::INCREASE_VOLUME = 10
static

◆ INFO

const char alexaClientSDK::sampleApp::INFO = 'i'
static

◆ LIMITED_HELP_HEADER

const std::string alexaClientSDK::sampleApp::LIMITED_HELP_HEADER
static
Initial value:
=
"+----------------------------------------------------------------------------+\n"
"| In Limited Mode: |\n"
"+----------------------------------------------------------------------------+\n"

◆ LIMITED_HELP_MESSAGE

const std::string alexaClientSDK::sampleApp::LIMITED_HELP_MESSAGE
static
Initial value:
=
"+----------------------------------------------------------------------------+\n"
"| Info: |\n"
"| Press 'i' followed by Enter at any time to see the help screen. |\n"
"| Stop an interaction: |\n"
"| Press 's' and Enter to stop an ongoing interaction. |\n"
"| Speaker Control: |\n"
"| Press 'p' followed by Enter at any time to adjust speaker settings. |\n"
"| Reset device: |\n"
"| Press 'k' followed by Enter at any time to reset your device. This |\n"
"| will erase any data stored in the device and you will have to |\n"
"| re-register your device. |\n"
"| This option will also exit the application. |\n"
"| Reauthorize device: |\n"
"| Press 'z' followed by Enter at any time to re-authorize your device. |\n"
"| This will erase any data stored in the device and initiate |\n"
"| re-authorization. |\n"
"| Quit: |\n"
"| Press 'q' followed by Enter at any time to quit the application. |\n"
"+----------------------------------------------------------------------------+\n"

◆ LOCALE_COMBINATION_CONFIGURATION_KEY

const std::string alexaClientSDK::sampleApp::LOCALE_COMBINATION_CONFIGURATION_KEY = "localeCombinations"
static

The key to find the locales combinations configuration.

◆ LOCALE_MESSAGE_FOOTER

const std::string alexaClientSDK::sampleApp::LOCALE_MESSAGE_FOOTER
static
Initial value:
=
"+----------------------------------------------------------------------------+\n"

◆ LOCALE_MESSAGE_HEADER

const std::string alexaClientSDK::sampleApp::LOCALE_MESSAGE_HEADER
static
Initial value:
=
"+----------------------------------------------------------------------------+\n"
"| Language Options: \n"
"|\n"

◆ LOCALE_NAME

const std::string alexaClientSDK::sampleApp::LOCALE_NAME = "Locale"
static

The name of the locale setting.

◆ LOCALES_CONFIGURATION_KEY

const std::string alexaClientSDK::sampleApp::LOCALES_CONFIGURATION_KEY = "locales"
static

The key to find the locales configuration.

◆ LOOP

const char alexaClientSDK::sampleApp::LOOP = '8'
static

◆ MAX_READERS

const size_t alexaClientSDK::sampleApp::MAX_READERS = 10
static

The maximum number of readers of the stream.

◆ MIC_TOGGLE

const char alexaClientSDK::sampleApp::MIC_TOGGLE = 'm'
static

◆ NETWORK_INFO_BSSID_PROMPT

const std::initializer_list<std::string> alexaClientSDK::sampleApp::NETWORK_INFO_BSSID_PROMPT
static
Initial value:
= {
"Type in the name of the physical access point (BSSID)",
"and press Enter. Leave empty to reset the BSSID."}

◆ NETWORK_INFO_CONNECTION_TYPE_PROMPT

const std::initializer_list<std::string> alexaClientSDK::sampleApp::NETWORK_INFO_CONNECTION_TYPE_PROMPT
static
Initial value:
= {
"Press '1' followed by Enter to set connection type to Ethernet",
"Press '2' followed by Enter to set connection type to Wifi",
"Press '3' followed by Enter to reset the connection type."}

◆ NETWORK_INFO_DHCP_ADDRESS_PROMPT

const std::initializer_list<std::string> alexaClientSDK::sampleApp::NETWORK_INFO_DHCP_ADDRESS_PROMPT
static
Initial value:
= {
"Type in the dhcp server address and press Enter.",
"Leave empty to reset the dhcp server address."}

◆ NETWORK_INFO_ESSID_PROMPT

const std::initializer_list<std::string> alexaClientSDK::sampleApp::NETWORK_INFO_ESSID_PROMPT
static
Initial value:
= {
"Type in the name of the network (ESSID) and press enter.",
"Leave empty to reset the ESSID."}

◆ NETWORK_INFO_IP_PROMPT

const std::initializer_list<std::string> alexaClientSDK::sampleApp::NETWORK_INFO_IP_PROMPT
static
Initial value:
= {
"Type in the ip address (eg. 192.168.0.1) and press Enter.",
"Leave empty to reset the ip address."}

◆ NETWORK_INFO_MAC_ADDRESS_PROMPT

const std::initializer_list<std::string> alexaClientSDK::sampleApp::NETWORK_INFO_MAC_ADDRESS_PROMPT
static
Initial value:
= {
"Type in the device mac address and press Enter.",
"Leave empty to reset the mac address."}

◆ NETWORK_INFO_NAME

const std::string alexaClientSDK::sampleApp::NETWORK_INFO_NAME = "NetworkInfo"
static

The name of the network info setting.

◆ NETWORK_INFO_SETTING_MENU

const std::string alexaClientSDK::sampleApp::NETWORK_INFO_SETTING_MENU
static
Initial value:
=
"+----------------------------------------------------------------------------+\n"
"| Network Info Configuration: |\n"
"| |\n"
"| Press '1' followed by Enter to see the current network info |\n"
"| Press '2' followed by Enter to set the connection type |\n"
"| Press '3' followed by Enter to set the network name (ESSID) |\n"
"| Press '4' followed by Enter to set the physical access point name (BSSID) |\n"
"| Press '5' followed by Enter to set the ip address |\n"
"| Press '6' followed by Enter to set the subnet mask |\n"
"| Press '7' followed by Enter to set the mac address |\n"
"| Press '8' followed by Enter to set the dhcp server address |\n"
"| Press '9' followed by Enter to set the static ip settings |\n"
"| Press 'q' followed by Enter to quit this configuration menu. |\n"
"+----------------------------------------------------------------------------+\n"

◆ NETWORK_INFO_STATIC_IP_PROMPT

const std::initializer_list<std::string> alexaClientSDK::sampleApp::NETWORK_INFO_STATIC_IP_PROMPT
static
Initial value:
= {
"Press '1' followed by Enter to set the ip type to static",
"Press '2' followed by Enter to set the ip type to dynamic",
"Press '3' followed by Enter to reset the ip type."}

◆ NETWORK_INFO_SUBNET_MASK_PROMPT

const std::initializer_list<std::string> alexaClientSDK::sampleApp::NETWORK_INFO_SUBNET_MASK_PROMPT
static
Initial value:
= {
"Type in the subnet mask and press Enter.",
"Leave empty to reset the subnet mask."}

◆ NEXT

const char alexaClientSDK::sampleApp::NEXT = '3'
static

◆ NUM_INPUT_CHANNELS

const int alexaClientSDK::sampleApp::NUM_INPUT_CHANNELS = 1
static

◆ NUM_OUTPUT_CHANNELS

const int alexaClientSDK::sampleApp::NUM_OUTPUT_CHANNELS = 0
static

◆ OPTION_ENUM_QUIT

const unsigned alexaClientSDK::sampleApp::OPTION_ENUM_QUIT = 0
static

The number used to quit a numeric options menu.

◆ OPTION_ENUM_START [1/2]

const unsigned alexaClientSDK::sampleApp::OPTION_ENUM_START = 1
static

The index of the first option in displaying a list of options.

◆ OPTION_ENUM_START [2/2]

const unsigned int alexaClientSDK::sampleApp::OPTION_ENUM_START = 1
static

The index of the first option in displaying a list of options.

◆ PAUSE

const char alexaClientSDK::sampleApp::PAUSE = '2'
static

◆ PLAY

const char alexaClientSDK::sampleApp::PLAY = '1'
static

◆ PREFERRED_SAMPLES_PER_CALLBACK

const unsigned long alexaClientSDK::sampleApp::PREFERRED_SAMPLES_PER_CALLBACK = paFramesPerBufferUnspecified
static

◆ PREVIOUS

const char alexaClientSDK::sampleApp::PREVIOUS = '4'
static

◆ QUIT

const char alexaClientSDK::sampleApp::QUIT = 'q'
static

◆ READ_CONSOLE_TIMEOUT

const auto alexaClientSDK::sampleApp::READ_CONSOLE_TIMEOUT = std::chrono::milliseconds(100)
static

Time to wait for console input.

◆ READ_REQUEST_PENDING_TIMEOUT

const std::chrono::milliseconds alexaClientSDK::sampleApp::READ_REQUEST_PENDING_TIMEOUT {100}
static

Time to wait for if there's a pending read request from the user.

◆ REAUTH_REQUIRED_STR

const std::string alexaClientSDK::sampleApp::REAUTH_REQUIRED_STR
static
Initial value:
=
"| Status : Re-authorization required. |\n"

◆ REAUTHORIZE

const char alexaClientSDK::sampleApp::REAUTHORIZE = 'z'
static

◆ REAUTHORIZE_CONFIRMATION

const std::string alexaClientSDK::sampleApp::REAUTHORIZE_CONFIRMATION
static
Initial value:
=
"+----------------------------------------------------------------------------+\n"
"| Device Re-authorization Confirmation: |\n"
"| |\n"
"| This operation will remove all your personal information, device settings, |\n"
"| and downloaded content. Are you sure you want to reauthorize your device? |\n"
"| |\n"
"| Press 'Y' followed by Enter to reset the device. |\n"
"| Press 'N' followed by Enter to cancel re-authorization. |\n"
"+----------------------------------------------------------------------------+\n"

◆ RENDER_FOOTER

const std::string alexaClientSDK::sampleApp::RENDER_FOOTER
static
Initial value:
=
"##############################################################################\n"

Generic Separator.

◆ RENDER_PLAYER_CONTROLS_HEADER

const std::string alexaClientSDK::sampleApp::RENDER_PLAYER_CONTROLS_HEADER
static
Initial value:
=
"##############################################################################\n"
"# GUI Playback Controls \n"
"#-----------------------------------------------------------------------------\n"

Begin a PlayerInfo UI GUI controls block.

◆ RENDER_PLAYER_INFO_CLEARED

const std::string alexaClientSDK::sampleApp::RENDER_PLAYER_INFO_CLEARED
static
Initial value:
=
"##############################################################################\n"
"# RenderPlayerInfoCard - Cleared \n"
"##############################################################################\n"

PlayerInfo UI has been cleared by AVS.

◆ RENDER_PLAYER_INFO_HEADER

const std::string alexaClientSDK::sampleApp::RENDER_PLAYER_INFO_HEADER
static
Initial value:
=
"##############################################################################\n"
"# RenderPlayerInfoCard \n"
"#-----------------------------------------------------------------------------\n"

Begin a PlayerInfo UI block.

◆ RENDER_TEMPLATE_CLEARED

const std::string alexaClientSDK::sampleApp::RENDER_TEMPLATE_CLEARED
static
Initial value:
=
"##############################################################################\n"
"# RenderTemplateCard - Cleared \n"
"##############################################################################\n"

RenderTemplate UI has been cleared by AVS.

◆ RENDER_TEMPLATE_HEADER

const std::string alexaClientSDK::sampleApp::RENDER_TEMPLATE_HEADER
static
Initial value:
=
"##############################################################################\n"
"# RenderTemplateCard \n"
"#-----------------------------------------------------------------------------\n"

Begin a RenderTemplate UI block.

◆ REPEAT

const char alexaClientSDK::sampleApp::REPEAT = '9'
static

◆ RESET

const char alexaClientSDK::sampleApp::RESET = 'k'
static

◆ RESET_CONFIRMATION

const std::string alexaClientSDK::sampleApp::RESET_CONFIRMATION
static
Initial value:
=
"+----------------------------------------------------------------------------+\n"
"| Device Reset Confirmation: |\n"
"| |\n"
"| This operation will remove all your personal information, device settings, |\n"
"| and downloaded content. Are you sure you want to reset your device? |\n"
"| |\n"
"| Press 'Y' followed by Enter to reset the device. |\n"
"| Press 'N' followed by Enter to cancel the device reset operation. |\n"
"+----------------------------------------------------------------------------+\n"

◆ RESET_WARNING

const std::string alexaClientSDK::sampleApp::RESET_WARNING
static
Initial value:
=
"Device was reset! Please don't forget to deregister it. For more details "
"visit https://www.amazon.com/gp/help/customer/display.html?nodeId=201357520"

◆ SAMPLE_RATE

const double alexaClientSDK::sampleApp::SAMPLE_RATE = 16000
static

◆ SETTING_CONFIGURATION_ROOT_KEY

const std::string alexaClientSDK::sampleApp::SETTING_CONFIGURATION_ROOT_KEY = "deviceSettings"
static

The key in our config file to find the root of settings for this database.

◆ SETTINGS

const char alexaClientSDK::sampleApp::SETTINGS = 'c'
static

◆ SETTINGS_MESSAGE

const std::string alexaClientSDK::sampleApp::SETTINGS_MESSAGE
static
Initial value:
=
"+----------------------------------------------------------------------------+\n"
"| Setting Options: |\n"
"| Press '1' followed by Enter to see language options. |\n"
"| Press '2' followed by Enter to see Do Not Disturb options. |\n"
"| Press '3' followed by Enter to see wake word confirmation options. |\n"
"| Press '4' followed by Enter to see speech confirmation options. |\n"
"| Press '5' followed by Enter to see time zone options. |\n"
"| Press '6' followed by Enter to see the network options. |\n"
"| Press '7' followed by Enter to see the Alarm Volume Ramp options. |\n"
"| Press 'q' followed by Enter to exit Settings Options. |\n"
"+----------------------------------------------------------------------------+\n"

◆ SHUFFLE

const char alexaClientSDK::sampleApp::SHUFFLE = '7'
static

◆ SKIP_BACKWARD

const char alexaClientSDK::sampleApp::SKIP_BACKWARD = '6'
static

◆ SKIP_FORWARD

const char alexaClientSDK::sampleApp::SKIP_FORWARD = '5'
static

◆ SPEAKER_CONTROL

const char alexaClientSDK::sampleApp::SPEAKER_CONTROL = 'p'
static

◆ SPEAKER_CONTROL_MESSAGE

const std::string alexaClientSDK::sampleApp::SPEAKER_CONTROL_MESSAGE
static
Initial value:
=
"+----------------------------------------------------------------------------+\n"
"| Speaker Options: |\n"
"| |\n"
"| Press '1' followed by Enter to modify AVS_SPEAKER_VOLUME typed speakers. |\n"
"| AVS_SPEAKER_VOLUME Speakers Control Volume For: |\n"
"| Speech, Content, Notification, Bluetooth. |\n"
"| Press '2' followed by Enter to modify AVS_ALERTS_VOLUME typed speakers. |\n"
"| AVS_ALERTS_VOLUME Speakers Control Volume For: |\n"
"| Alerts. |\n"
"+----------------------------------------------------------------------------+\n"

◆ SPEECH_CONFIRMATION_HEADER

const std::string alexaClientSDK::sampleApp::SPEECH_CONFIRMATION_HEADER
static
Initial value:
=
"+----------------------------------------------------------------------------+\n"
"| Speech Confirmation Configuration: |"

◆ SPEECH_CONFIRMATION_NAME

const std::string alexaClientSDK::sampleApp::SPEECH_CONFIRMATION_NAME = "SpeechConfirmation"
static

The name of the speech confirmation setting.

◆ STOP

const char alexaClientSDK::sampleApp::STOP = 's'
static

◆ TAP

const char alexaClientSDK::sampleApp::TAP = 't'
static

◆ THUMBS_DOWN

const char alexaClientSDK::sampleApp::THUMBS_DOWN = '-'
static

◆ THUMBS_UP

const char alexaClientSDK::sampleApp::THUMBS_UP = '+'
static

◆ TIMEZONE_NAME

const std::string alexaClientSDK::sampleApp::TIMEZONE_NAME = "TimeZone"
static

The name of the time zone setting.

◆ TIMEZONE_SETTING_MENU

const std::string alexaClientSDK::sampleApp::TIMEZONE_SETTING_MENU
static
Initial value:
=
"+----------------------------------------------------------------------------+\n"
"| TimeZone Configuration: |\n"
"| |\n"
"| Press '1' followed by Enter to set the time zone to America/Vancouver. |\n"
"| Press '2' followed by Enter to set the time zone to America/Edmonton. |\n"
"| Press '3' followed by Enter to set the time zone to America/Winnipeg. |\n"
"| Press '4' followed by Enter to set the time zone to America/Toronto. |\n"
"| Press '5' followed by Enter to set the time zone to America/Halifax. |\n"
"| Press '6' followed by Enter to set the time zone to America/St_Johns. |\n"
"| Press 'q' followed by Enter to quit this configuration menu. |\n"
"+----------------------------------------------------------------------------+\n"

◆ VERSION

const std::string alexaClientSDK::sampleApp::VERSION = avsCommon::utils::sdkVersion::getCurrentVersion()
static

◆ VOLUME_CONTROL_MESSAGE

const std::string alexaClientSDK::sampleApp::VOLUME_CONTROL_MESSAGE
static
Initial value:
=
"+----------------------------------------------------------------------------+\n"
"| Volume Options: |\n"
"| |\n"
"| Press '1' followed by Enter to increase the volume. |\n"
"| Press '2' followed by Enter to decrease the volume. |\n"
"| Press '3' followed by Enter to mute the volume. |\n"
"| Press '4' followed by Enter to unmute the volume. |\n"
"| Press 'i' to display this help screen. |\n"
"| Press 'q' to exit Volume Control Mode. |\n"
"+----------------------------------------------------------------------------+\n"

◆ WAKE_WORDS_NAME

const std::string alexaClientSDK::sampleApp::WAKE_WORDS_NAME = "WakeWords"
static

The name of the wake words setting.

◆ WAKEWORD_CONFIRMATION_HEADER

const std::string alexaClientSDK::sampleApp::WAKEWORD_CONFIRMATION_HEADER
static
Initial value:
=
"+----------------------------------------------------------------------------+\n"
"| Wake Word Confirmation Configuration: |"

◆ WAKEWORD_CONFIRMATION_NAME

const std::string alexaClientSDK::sampleApp::WAKEWORD_CONFIRMATION_NAME = "WakeWordConfirmation"
static

The name of the wake word confirmation setting.

◆ WORD_SIZE

const size_t alexaClientSDK::sampleApp::WORD_SIZE = 2
static

The size of each word within the stream.

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