AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Classes | Static Public Member Functions | List of all members
alexaClientSDK::templateRuntime::TemplateRuntimeFactory Class Reference

#include <TemplateRuntimeFactory.h>

Static Public Member Functions

static avsCommon::utils::Optional< TemplateRuntimeAgentData > create (const std::shared_ptr< avsCommon::sdkInterfaces::RenderPlayerInfoCardsProviderRegistrarInterface > &renderPlayerInfoCardsProviderRegistrar, const std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > &exceptionSender, const std::shared_ptr< avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesRegistrarInterface > &endpointCapabilitiesRegistrar)
 Creates template runtime capability agent. More...
 

Detailed Description

This factory can be used to create a TemplateRuntimeFactory object which could be a parameter for Capability Agent construction.

Member Function Documentation

◆ create()

static avsCommon::utils::Optional<TemplateRuntimeAgentData> alexaClientSDK::templateRuntime::TemplateRuntimeFactory::create ( const std::shared_ptr< avsCommon::sdkInterfaces::RenderPlayerInfoCardsProviderRegistrarInterface > &  renderPlayerInfoCardsProviderRegistrar,
const std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > &  exceptionSender,
const std::shared_ptr< avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesRegistrarInterface > &  endpointCapabilitiesRegistrar 
)
static

Creates template runtime capability agent.

Method creates a component that advertises template runtime capability. The component is responsible for handling directives to render a template card and a music player.

See also
: https://developer.amazon.com/en-US/docs/alexa/alexa-voice-service/templateruntime.html
Parameters
renderPlayerInfoCardsProviderRegistrarThe object with which to register this provider for playerInfo cards.
endpointCapabilitiesRegistrarThe EndpointCapabilitiesRegistrarInterface for the default endpoint.
exceptionSenderObject used to send exceptions.
Returns
An Optional object containing an instance of TemplateRuntimeAgentData object if successful.

The documentation for this class was generated from the following file:

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