AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Namespaces | Classes | Functions
alexaClientSDK::speakerManager Namespace Reference

Speaker API Capability Agent Interface and Implementation. More...

Namespaces

 test
 Unit Tests and Mocks for Speaker API Capability Agent.
 

Classes

struct  SpeakerManagerConfigInterface
 Speaker manager configuration interface. More...
 
struct  SpeakerManagerStorageInterface
 Speaker manager storage interface. More...
 
struct  SpeakerManagerStorageState
 Storage state for SpeakerManager. More...
 

Functions

std::shared_ptr< avsCommon::sdkInterfaces::SpeakerManagerInterfacecreateSpeakerManagerCapabilityAgent (std::shared_ptr< SpeakerManagerConfigInterface > config, std::shared_ptr< SpeakerManagerStorageInterface > storage, std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > contextManager, std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > messageSender, std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > exceptionEncounteredSender, std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > metricRecorder, const std::shared_ptr< acsdkShutdownManagerInterfaces::ShutdownNotifierInterface > &shutdownNotifier, const std::shared_ptr< avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesRegistrarInterface > &endpointCapabilitiesRegistrar, const std::vector< std::shared_ptr< avsCommon::sdkInterfaces::ChannelVolumeInterface >> &volumeInterfaces={}) noexcept
 Creates speaker manager CA. More...
 
std::shared_ptr< avsCommon::sdkInterfaces::ChannelVolumeFactoryInterfacecreateChannelVolumeFactory () noexcept
 Create default implementation of ChannelVolumeFactoryInterface. More...
 
std::shared_ptr< SpeakerManagerStorageInterfacecreateSpeakerManagerStorage (std::shared_ptr< avsCommon::sdkInterfaces::storage::MiscStorageInterface > storage) noexcept
 Adapt generic MiscStorageInterface into SpeakerManagerStorageInterface. More...
 
std::shared_ptr< SpeakerManagerConfigInterfacecreateSpeakerManagerConfig () noexcept
 Creates configuration interface for speaker manager. More...
 

Detailed Description

Speaker API Capability Agent Interface and Implementation.

This namespace contains public API and implementation for Speaker API capability agent.

See also
Capability Agent for AVS Speaker 1.0 Interface

Function Documentation

◆ createChannelVolumeFactory()

std::shared_ptr<avsCommon::sdkInterfaces::ChannelVolumeFactoryInterface> alexaClientSDK::speakerManager::createChannelVolumeFactory ( )
noexcept

Create default implementation of ChannelVolumeFactoryInterface.

Returns
Channel volume factory interface or nullptr on error.

AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0