AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Namespaces | Macros | Functions | Variables
TemplateRuntime.cpp File Reference
#include <ostream>
#include <rapidjson/error/en.h>
#include <AVSCommon/AVS/CapabilityConfiguration.h>
#include <AVSCommon/Utils/JSON/JSONUtils.h>
#include <AVSCommon/Utils/Logger/Logger.h>
#include "TemplateRuntime/TemplateRuntime.h"
Include dependency graph for TemplateRuntime.cpp:

Namespaces

 alexaClientSDK
 Whether or not curl logs should be emitted.
 
 alexaClientSDK::capabilityAgents
 
 alexaClientSDK::capabilityAgents::templateRuntime
 

Macros

#define LX(event)   alexaClientSDK::avsCommon::utils::logger::LogEntry(TAG, event)
 

Functions

static std::shared_ptr< avsCommon::avs::CapabilityConfiguration > alexaClientSDK::capabilityAgents::templateRuntime::getTemplateRuntimeCapabilityConfiguration ()
 

Variables

static const std::string alexaClientSDK::capabilityAgents::templateRuntime::TEMPLATERUNTIME_CAPABILITY_INTERFACE_TYPE = "AlexaInterface"
 
static const std::string alexaClientSDK::capabilityAgents::templateRuntime::TEMPLATERUNTIME_CAPABILITY_INTERFACE_NAME = "TemplateRuntime"
 TemplateRuntime interface name. More...
 
static const std::string alexaClientSDK::capabilityAgents::templateRuntime::TEMPLATERUNTIME_CAPABILITY_INTERFACE_VERSION = "1.1"
 TemplateRuntime interface version. More...
 
static const std::string alexaClientSDK::capabilityAgents::templateRuntime::TAG {"TemplateRuntime"}
 String to identify log entries originating from this file. More...
 
static const std::string alexaClientSDK::capabilityAgents::templateRuntime::TEMPLATERUNTIME_CONFIGURATION_ROOT_KEY = "templateRuntimeCapabilityAgent"
 The key in our config file to find the root of template runtime configuration. More...
 
static const std::string alexaClientSDK::capabilityAgents::templateRuntime::TEMPLATERUNTIME_TTS_FINISHED_KEY = "displayCardTTSFinishedTimeout"
 The key in our config file to set the display card timeout value when TTS is in FINISHED state. More...
 
static const std::string alexaClientSDK::capabilityAgents::templateRuntime::TEMPLATERUNTIME_AUDIOPLAYBACK_FINISHED_KEY = "displayCardAudioPlaybackFinishedTimeout"
 The key in our config file to set the display card timeout value when AudioPlayer is in FINISHED state. More...
 
static const std::string alexaClientSDK::capabilityAgents::templateRuntime::TEMPLATERUNTIME_AUDIOPLAYBACK_STOPPED_PAUSED_KEY
 The key in our config file to set the display card timeout value when AudioPlayer is in STOPPED or PAUSE state. More...
 
static const std::string alexaClientSDK::capabilityAgents::templateRuntime::CHANNEL_NAME = avsCommon::sdkInterfaces::FocusManagerInterface::VISUAL_CHANNEL_NAME
 The name of the FocusManager channel used by TemplateRuntime. More...
 
static const std::string alexaClientSDK::capabilityAgents::templateRuntime::NAMESPACE {"TemplateRuntime"}
 The namespace for this capability agent. More...
 
static const std::string alexaClientSDK::capabilityAgents::templateRuntime::RENDER_TEMPLATE {"RenderTemplate"}
 The name for RenderTemplate directive. More...
 
static const std::string alexaClientSDK::capabilityAgents::templateRuntime::RENDER_PLAYER_INFO {"RenderPlayerInfo"}
 The name for RenderPlayerInfo directive. More...
 
static const NamespaceAndName alexaClientSDK::capabilityAgents::templateRuntime::TEMPLATE {NAMESPACE, RENDER_TEMPLATE}
 The RenderTemplate directive signature. More...
 
static const NamespaceAndName alexaClientSDK::capabilityAgents::templateRuntime::PLAYER_INFO {NAMESPACE, RENDER_PLAYER_INFO}
 The RenderPlayerInfo directive signature. More...
 
static const std::string alexaClientSDK::capabilityAgents::templateRuntime::AUDIO_ITEM_ID_TAG {"audioItemId"}
 Tag for find the AudioItemId in the payload of the RenderPlayerInfo directive. More...
 
static const size_t alexaClientSDK::capabilityAgents::templateRuntime::MAXIMUM_QUEUE_SIZE {100}
 Maximum queue size allowed for m_audioItems. More...
 
static const std::chrono::milliseconds alexaClientSDK::capabilityAgents::templateRuntime::DEFAULT_TTS_FINISHED_TIMEOUT_MS {2000}
 Default timeout for clearing the RenderTemplate display card when SpeechSynthesizer is in FINISHED state. More...
 
static const std::chrono::milliseconds alexaClientSDK::capabilityAgents::templateRuntime::DEFAULT_AUDIO_FINISHED_TIMEOUT_MS {2000}
 Default timeout for clearing the RenderPlayerInfo display card when AudioPlayer is in FINISHED state. More...
 
static const std::chrono::milliseconds alexaClientSDK::capabilityAgents::templateRuntime::DEFAULT_AUDIO_STOPPED_PAUSED_TIMEOUT_MS {60000}
 Default timeout for clearing the RenderPlayerInfo display card when AudioPlayer is in STOPPED/PAUSED state. More...
 

Macro Definition Documentation

◆ LX

#define LX (   event)    alexaClientSDK::avsCommon::utils::logger::LogEntry(TAG, event)

Create a LogEntry using this file's TAG and the specified event string.

Parameters
Theevent string for this LogEntry.

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