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::PresentationOrchestratorFeatureClientBuilder Class Reference

#include <PresentationOrchestratorFeatureClientBuilder.h>

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

Public Member Functions

std::shared_ptr< PresentationOrchestratorFeatureClientconstruct (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< PresentationOrchestratorFeatureClientBuildercreate ()
 

Additional Inherited Members

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

Detailed Description

The PresentationOrchestratorFeatureClientBuilder builder class is responsible for creating an instance of the PresentationOrchestratorFeatureClient and is intended to be used with the SDKClientBuilder and SDKClientRegistry. It constructs the PresentationOrchestrator, PresentationOrchestratorClient and VisualTimeoutManager components which are intended for use in managing the lifecycle of presentations across windows and tracking their state.

It requires the PresentationOrchestratorStateTrackerInterface component from the SDKClientRegistry which can be provided by VisualStateTrackerFeatureClient

Member Function Documentation

◆ construct()

std::shared_ptr<PresentationOrchestratorFeatureClient> alexaClientSDK::featureClient::PresentationOrchestratorFeatureClientBuilder::construct ( const std::shared_ptr< sdkClient::SDKClientRegistry > &  sdkClientRegistry)

Construct an instance of the PresentationOrchestratorFeatureClient

Parameters
sdkClientRegistryThe SDKClientClientRegistry object
Returns
An instance of the PresentationOrchestratorFeatureClient, or nullptr if construction failed

◆ create()

static std::unique_ptr<PresentationOrchestratorFeatureClientBuilder> alexaClientSDK::featureClient::PresentationOrchestratorFeatureClientBuilder::create ( )
static

Create an instance of the VisualCharacteristicsFeatureClientBuilder, this can be passed to the SDKClientBuilder

Returns
The newly instantiated VisualCharacteristicsFeatureClientBuilder object, or nullptr if creation failed

◆ name()

std::string alexaClientSDK::featureClient::PresentationOrchestratorFeatureClientBuilder::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