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::acsdkAlexaPlaybackController::AlexaPlaybackControllerFactory Class Reference

#include <AlexaPlaybackControllerFactory.h>

Classes

struct  AlexaPlaybackControllerCapabilityAgentData
 

Static Public Member Functions

static avsCommon::utils::Optional< AlexaPlaybackControllerCapabilityAgentData > create (const avsCommon::sdkInterfaces::endpoints::EndpointIdentifier &endpointId, std::shared_ptr< acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerInterface > playbackController, const std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > &contextManager, const std::shared_ptr< avsCommon::sdkInterfaces::AlexaInterfaceMessageSenderInterface > &responseSender, const std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > &exceptionSender, bool isProactivelyReported, bool isRetrievable)
 

Detailed Description

This factory can be used to create a new AlexaPlaybackControllerCapabilityAgent and return a generic object that contains certain interfaces which can be used for registering this capability agent to an endpoint.

Member Function Documentation

◆ create()

static avsCommon::utils::Optional<AlexaPlaybackControllerCapabilityAgentData> alexaClientSDK::acsdkAlexaPlaybackController::AlexaPlaybackControllerFactory::create ( const avsCommon::sdkInterfaces::endpoints::EndpointIdentifier &  endpointId,
std::shared_ptr< acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerInterface >  playbackController,
const std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > &  contextManager,
const std::shared_ptr< avsCommon::sdkInterfaces::AlexaInterfaceMessageSenderInterface > &  responseSender,
const std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > &  exceptionSender,
bool  isProactivelyReported,
bool  isRetrievable 
)
static

Creates a new AlexaPlaybackController capability agent instance and exposes the AlexaPlaybackController related interfaces to the caller, including the handler for performing playback operations directiveHandler, the capability configurations associated to the capability agent instance capbilityConfigurationInterface, and the object for cleaning up the capability agent instance during shutdown requiresShutdown.

Parameters
endpointIdA endpoint to which this capability is associated.
playbackControllerAn interface that this object will use to perform the playback controller operations.
contextManagerAn interface to which this object will send property state updates.
responseSenderAn interface that this object will use to send the reponse to AVS.
exceptionSenderAn interface to report exceptions to AVS.
isProactivelyReportedWhether the playback state properties change is proactively reported to Alexa in a change report.
isRetrievableWhether the playback state properties can be retrieved when Alexa sends a state report request to the endpoint.
Returns
An Optional object with no valid value if the inputs are invalid, else a new AlexaPlaybackControllerCapabilityAgentData object.
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