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

#include <LiveViewControllerFeatureClientBuilder.h>

Inheritance diagram for alexaClientSDK::featureClient::LiveViewControllerFeatureClientBuilder:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::featureClient::LiveViewControllerFeatureClientBuilder:
Collaboration graph
[legend]

Public Member Functions

std::shared_ptr< LiveViewControllerFeatureClientconstruct (const std::shared_ptr< sdkClient::SDKClientRegistry > &sdkClientRegistry)
 
std::string name () override
 
- Public Member Functions inherited from alexaClientSDK::sdkClient::FeatureClientBuilderInterface
virtual ~FeatureClientBuilderInterface ()=default
 

Static Public Member Functions

static std::unique_ptr< LiveViewControllerFeatureClientBuildercreate (avsCommon::sdkInterfaces::endpoints::EndpointIdentifier endpointId, const std::shared_ptr< alexaClientSDK::alexaLiveViewControllerInterfaces::LiveViewControllerInterface > &liveViewController)
 

Additional Inherited Members

- Protected Member Functions inherited from alexaClientSDK::sdkClient::FeatureClientBuilderInterface
template<typename ComponentType >
ACSDK_INLINE_VISIBILITY void addRequiredType ()
 

Detailed Description

The LiveViewControllerFeatureClientBuilder builder class is responsible for creating an instance of the LiveViewControllerFeatureClient and is intended to be used with the SDKClientBuilder and SDKClientRegistry. It constructs the LiveViewController capability.

It requires the ExceptionEncounteredSenderInterface, AVSConnectionManagerInterface, EndpointBuilderInterface, AlexaInterfaceMessageSender and ContextManagerInterface components from the SDKClientRegistry which can be provided by DefaultClient.

Member Function Documentation

◆ construct()

std::shared_ptr<LiveViewControllerFeatureClient> alexaClientSDK::featureClient::LiveViewControllerFeatureClientBuilder::construct ( const std::shared_ptr< sdkClient::SDKClientRegistry > &  sdkClientRegistry)

Construct an instance of the LiveViewControllerFeatureClient.

Parameters
sdkClientRegistryThe SDKClientRegistry object.
Returns
An instance of the LiveViewControllerFeatureClient, or nullptr if construction failed.

◆ create()

static std::unique_ptr<LiveViewControllerFeatureClientBuilder> alexaClientSDK::featureClient::LiveViewControllerFeatureClientBuilder::create ( avsCommon::sdkInterfaces::endpoints::EndpointIdentifier  endpointId,
const std::shared_ptr< alexaClientSDK::alexaLiveViewControllerInterfaces::LiveViewControllerInterface > &  liveViewController 
)
static

Create an instance of the LiveViewControllerFeatureClientBuilder

Parameters
endpointIdAn endpoint to which this capability is associated.
liveViewControllerAn instance of LiveViewControllerInterface implementing the LVC CA Interface to communicate with it.
Returns
Pointer to the feature client builder, or nullptr if creation failed.

◆ name()

std::string alexaClientSDK::featureClient::LiveViewControllerFeatureClientBuilder::name ( )
overridevirtual

FeatureClientBuilderInterface functions

Implements alexaClientSDK::sdkClient::FeatureClientBuilderInterface.


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