Static Public Member Functions
static avsCommon::utils::Optional< ChannelControllerCapabilityAgentData >	create (const avsCommon::sdkInterfaces::endpoints::EndpointIdentifier &endpointId, const std::shared_ptr< alexaChannelControllerInterfaces::ChannelControllerInterface > &channelController, 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 AlexaChannelControllerFactory object which could be a parameter for Capability Agent construction.

Member Function Documentation

static avsCommon::utils::Optional<ChannelControllerCapabilityAgentData> alexaClientSDK::alexaChannelController::AlexaChannelControllerFactory::create	(	const avsCommon::sdkInterfaces::endpoints::EndpointIdentifier &	endpointId,
		const std::shared_ptr< alexaChannelControllerInterfaces::ChannelControllerInterface > &	channelController,
		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 ChannelController capability agent configuration.

Parameters

endpointId	A endpoint to which this capability is associated.
channelController	An interface that this object will use to perform the channel controller operations.
contextManager	An interface to which this object will send property state updates.
responseSender	An interface that this object will use to send the response to AVS.
exceptionSender	An interface to report exceptions to AVS.
isProactivelyReported	Whether the channel properties change is proactively reported to AVS in a change report.
isRetrievable	Whether the channel properties can be retrieved when AVS sends a state report request to the endpoint.

Returns: An Optional object containing an instance of ChannelControllerCapabilityAgentData object if successful, otherwise an Optional object with no valid value.

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

/workplace/avs-device-sdk/capabilities/AlexaChannelController/AlexaChannelController/include/acsdk/AlexaChannelController/AlexaChannelControllerFactory.h