alexaClientSDK::capabilityAgents::templateRuntime Namespace Reference

Namespaces
	test

Classes
class	RenderPlayerInfoCardsProviderRegistrar
class	TemplateRuntime

Functions
static const std::string	TAG ("RenderPlayerInfoCardsProviderRegistrar")
	String to identify log entries originating from this file. More...
static std::shared_ptr< avsCommon::avs::CapabilityConfiguration >	getTemplateRuntimeCapabilityConfiguration ()

Variables
static const std::string	TEMPLATERUNTIME_CAPABILITY_INTERFACE_TYPE = "AlexaInterface"
static const std::string	TEMPLATERUNTIME_CAPABILITY_INTERFACE_NAME = "TemplateRuntime"
	TemplateRuntime interface name. More...
static const std::string	TEMPLATERUNTIME_CAPABILITY_INTERFACE_VERSION = "1.1"
	TemplateRuntime interface version. More...
static const std::string	TAG {"TemplateRuntime"}
	String to identify log entries originating from this file. More...
static const std::string	TEMPLATERUNTIME_CONFIGURATION_ROOT_KEY = "templateRuntimeCapabilityAgent"
	The key in our config file to find the root of template runtime configuration. More...
static const std::string	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	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	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	CHANNEL_NAME = avsCommon::sdkInterfaces::FocusManagerInterface::VISUAL_CHANNEL_NAME
	The name of the FocusManager channel used by TemplateRuntime. More...
static const std::string	NAMESPACE {"TemplateRuntime"}
	The namespace for this capability agent. More...
static const std::string	RENDER_TEMPLATE {"RenderTemplate"}
	The name for RenderTemplate directive. More...
static const std::string	RENDER_PLAYER_INFO {"RenderPlayerInfo"}
	The name for RenderPlayerInfo directive. More...
static const NamespaceAndName	TEMPLATE {NAMESPACE, RENDER_TEMPLATE}
	The RenderTemplate directive signature. More...
static const NamespaceAndName	PLAYER_INFO {NAMESPACE, RENDER_PLAYER_INFO}
	The RenderPlayerInfo directive signature. 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 size_t	MAXIMUM_QUEUE_SIZE {100}
	Maximum queue size allowed for m_audioItems. More...
static const std::chrono::milliseconds	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	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	DEFAULT_AUDIO_STOPPED_PAUSED_TIMEOUT_MS {60000}
	Default timeout for clearing the RenderPlayerInfo display card when AudioPlayer is in STOPPED/PAUSED state. More...

Function Documentation

getTemplateRuntimeCapabilityConfiguration()

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

static

Creates the TemplateRuntime capability configuration.

Returns

The TemplateRuntime capability configuration.

TAG()

static const std::string alexaClientSDK::capabilityAgents::templateRuntime::TAG ( "RenderPlayerInfoCardsProviderRegistrar"  )

static

String to identify log entries originating from this file.

Variable Documentation

AUDIO_ITEM_ID_TAG

const std::string alexaClientSDK::capabilityAgents::templateRuntime::AUDIO_ITEM_ID_TAG {"audioItemId"}

static

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

CHANNEL_NAME

const std::string alexaClientSDK::capabilityAgents::templateRuntime::CHANNEL_NAME = avsCommon::sdkInterfaces::FocusManagerInterface::VISUAL_CHANNEL_NAME

static

The name of the FocusManager channel used by TemplateRuntime.

DEFAULT_AUDIO_FINISHED_TIMEOUT_MS

const std::chrono::milliseconds alexaClientSDK::capabilityAgents::templateRuntime::DEFAULT_AUDIO_FINISHED_TIMEOUT_MS {2000}

static

Default timeout for clearing the RenderPlayerInfo display card when AudioPlayer is in FINISHED state.

DEFAULT_AUDIO_STOPPED_PAUSED_TIMEOUT_MS

const std::chrono::milliseconds alexaClientSDK::capabilityAgents::templateRuntime::DEFAULT_AUDIO_STOPPED_PAUSED_TIMEOUT_MS {60000}

static

Default timeout for clearing the RenderPlayerInfo display card when AudioPlayer is in STOPPED/PAUSED state.

DEFAULT_TTS_FINISHED_TIMEOUT_MS

const std::chrono::milliseconds alexaClientSDK::capabilityAgents::templateRuntime::DEFAULT_TTS_FINISHED_TIMEOUT_MS {2000}

static

Default timeout for clearing the RenderTemplate display card when SpeechSynthesizer is in FINISHED state.

MAXIMUM_QUEUE_SIZE

const size_t alexaClientSDK::capabilityAgents::templateRuntime::MAXIMUM_QUEUE_SIZE {100}

static

Maximum queue size allowed for m_audioItems.

NAMESPACE

const std::string alexaClientSDK::capabilityAgents::templateRuntime::NAMESPACE {"TemplateRuntime"}

static

The namespace for this capability agent.

PLAYER_INFO

const NamespaceAndName alexaClientSDK::capabilityAgents::templateRuntime::PLAYER_INFO {NAMESPACE, RENDER_PLAYER_INFO}

static

The RenderPlayerInfo directive signature.

RENDER_PLAYER_INFO

const std::string alexaClientSDK::capabilityAgents::templateRuntime::RENDER_PLAYER_INFO {"RenderPlayerInfo"}

static

The name for RenderPlayerInfo directive.

RENDER_TEMPLATE

const std::string alexaClientSDK::capabilityAgents::templateRuntime::RENDER_TEMPLATE {"RenderTemplate"}

static

The name for RenderTemplate directive.

TAG

const std::string alexaClientSDK::capabilityAgents::templateRuntime::TAG {"TemplateRuntime"}

static

String to identify log entries originating from this file.

TEMPLATE

const NamespaceAndName alexaClientSDK::capabilityAgents::templateRuntime::TEMPLATE {NAMESPACE, RENDER_TEMPLATE}

static

The RenderTemplate directive signature.

TEMPLATERUNTIME_AUDIOPLAYBACK_FINISHED_KEY

const std::string alexaClientSDK::capabilityAgents::templateRuntime::TEMPLATERUNTIME_AUDIOPLAYBACK_FINISHED_KEY = "displayCardAudioPlaybackFinishedTimeout"

static

The key in our config file to set the display card timeout value when AudioPlayer is in FINISHED state.

TEMPLATERUNTIME_AUDIOPLAYBACK_STOPPED_PAUSED_KEY

const std::string alexaClientSDK::capabilityAgents::templateRuntime::TEMPLATERUNTIME_AUDIOPLAYBACK_STOPPED_PAUSED_KEY

static

Initial value:

=
    "displayCardAudioPlaybackStoppedPausedTimeout"

The key in our config file to set the display card timeout value when AudioPlayer is in STOPPED or PAUSE state.

TEMPLATERUNTIME_CAPABILITY_INTERFACE_NAME

const std::string alexaClientSDK::capabilityAgents::templateRuntime::TEMPLATERUNTIME_CAPABILITY_INTERFACE_NAME = "TemplateRuntime"

static

TemplateRuntime interface name.

TEMPLATERUNTIME_CAPABILITY_INTERFACE_TYPE

const std::string alexaClientSDK::capabilityAgents::templateRuntime::TEMPLATERUNTIME_CAPABILITY_INTERFACE_TYPE = "AlexaInterface"

static

TemplateRuntime capability constants TemplateRuntime interface type

TEMPLATERUNTIME_CAPABILITY_INTERFACE_VERSION

const std::string alexaClientSDK::capabilityAgents::templateRuntime::TEMPLATERUNTIME_CAPABILITY_INTERFACE_VERSION = "1.1"

static

TemplateRuntime interface version.

TEMPLATERUNTIME_CONFIGURATION_ROOT_KEY

const std::string alexaClientSDK::capabilityAgents::templateRuntime::TEMPLATERUNTIME_CONFIGURATION_ROOT_KEY = "templateRuntimeCapabilityAgent"

static

The key in our config file to find the root of template runtime configuration.

TEMPLATERUNTIME_TTS_FINISHED_KEY

const std::string alexaClientSDK::capabilityAgents::templateRuntime::TEMPLATERUNTIME_TTS_FINISHED_KEY = "displayCardTTSFinishedTimeout"

static

The key in our config file to set the display card timeout value when TTS is in FINISHED state.