AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::avsCommon::sdkInterfaces::ChannelVolumeFactoryInterface Class Referenceabstract

#include <ChannelVolumeFactoryInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::ChannelVolumeFactoryInterface:
Inheritance graph
[legend]

Public Member Functions

virtual std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::ChannelVolumeInterfacecreateChannelVolumeInterface (std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::SpeakerInterface > speaker, alexaClientSDK::avsCommon::sdkInterfaces::ChannelVolumeInterface::Type type=alexaClientSDK::avsCommon::sdkInterfaces::ChannelVolumeInterface::Type::AVS_SPEAKER_VOLUME, std::function< int8_t(int8_t)> volumeCurve=nullptr)=0
 
virtual ~ChannelVolumeFactoryInterface ()=default
 

Detailed Description

The ChannelVolumeFactoryInterface provide a factory interface that returns a ChannelVolumeInterface implementation for an input SpeakerInterface.

Constructor & Destructor Documentation

◆ ~ChannelVolumeFactoryInterface()

virtual alexaClientSDK::avsCommon::sdkInterfaces::ChannelVolumeFactoryInterface::~ChannelVolumeFactoryInterface ( )
virtualdefault

Destructor

Member Function Documentation

◆ createChannelVolumeInterface()

virtual std::shared_ptr<alexaClientSDK::avsCommon::sdkInterfaces::ChannelVolumeInterface> alexaClientSDK::avsCommon::sdkInterfaces::ChannelVolumeFactoryInterface::createChannelVolumeInterface ( std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::SpeakerInterface speaker,
alexaClientSDK::avsCommon::sdkInterfaces::ChannelVolumeInterface::Type  type = alexaClientSDK::avsCommon::sdkInterfaces::ChannelVolumeInterface::Type::AVS_SPEAKER_VOLUME,
std::function< int8_t(int8_t)>  volumeCurve = nullptr 
)
pure virtual

Creates a ChannelVolumeInterface for the input SpeakerInterface.

Parameters
speakerinput SpeakerInterface to be encapsulated.
typeoptional The ChannelVolumeInterface Type to be associated with.
volumeCurveoptional volume curve to be used for channel volume attenuation.
Returns
ChannelVolumeInterface

Implemented in alexaClientSDK::capabilityAgents::speakerManager::DefaultChannelVolumeFactory.


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

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