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::alexaLiveViewController::AlexaLiveViewControllerFactory Class Reference

#include <AlexaLiveViewControllerFactory.h>

Static Public Member Functions

static avsCommon::utils::Optional< LiveViewControllerCapabilityAgentData > create (const avsCommon::sdkInterfaces::endpoints::EndpointIdentifier &endpointId, const std::shared_ptr< alexaLiveViewControllerInterfaces::LiveViewControllerInterface > &liveViewController, const std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > &messageSender, const std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > &contextManager, const std::shared_ptr< avsCommon::sdkInterfaces::AlexaInterfaceMessageSenderInterface > &responseSender, const std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > &exceptionSender)
 

Detailed Description

This factory can be used to create a new AlexaLiveViewControllerFactory object which could be a parameter for capability agent construction.

Member Function Documentation

◆ create()

static avsCommon::utils::Optional<LiveViewControllerCapabilityAgentData> alexaClientSDK::alexaLiveViewController::AlexaLiveViewControllerFactory::create ( const avsCommon::sdkInterfaces::endpoints::EndpointIdentifier endpointId,
const std::shared_ptr< alexaLiveViewControllerInterfaces::LiveViewControllerInterface > &  liveViewController,
const std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > &  messageSender,
const std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > &  contextManager,
const std::shared_ptr< avsCommon::sdkInterfaces::AlexaInterfaceMessageSenderInterface > &  responseSender,
const std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > &  exceptionSender 
)
static

Creates a new LiveViewController capability agent

Parameters
endpointIdAn endpoint to which this capability is associated.
liveViewControllerAn interface that this object will use to perform the live view controller operations.
messageSenderAn interface used to send events to AVS.
contextManagerAn interface to which this object will send property state updates.
responseSenderAn interface that this object will use to send the response to AVS.
exceptionSenderAn interface to report exceptions to AVS.
Returns
A LiveViewControllerCapabilityAgentData object if successful, otherwise an Optional object with no value.

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