![]() |
AlexaClientSDK
3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
|
#include <ApplicationAudioPipelineFactoryInterface.h>
Public Member Functions | |
virtual | ~ApplicationAudioPipelineFactoryInterface ()=default |
virtual std::shared_ptr< avsCommon::sdkInterfaces::ApplicationMediaInterfaces > | createApplicationMediaInterfaces (const std::string &name, bool equalizerAvailable=false, bool enableLiveMode=false, bool isCaptionable=false, avsCommon::sdkInterfaces::ChannelVolumeInterface::Type channelVolumeType=avsCommon::sdkInterfaces::ChannelVolumeInterface::Type::AVS_SPEAKER_VOLUME, std::function< int8_t(int8_t)> volumeCurve=nullptr)=0 |
virtual std::shared_ptr< PooledApplicationMediaInterfaces > | createPooledApplicationMediaInterfaces (const std::string &name, int numMediaPlayers, bool equalizerAvailable=false, bool enableLiveMode=false, bool isCaptionable=false, avsCommon::sdkInterfaces::ChannelVolumeInterface::Type channelVolumeType=avsCommon::sdkInterfaces::ChannelVolumeInterface::Type::AVS_SPEAKER_VOLUME, std::function< int8_t(int8_t)> volumeCurve=nullptr)=0 |
ApplicationAudioPipelineFactoryInterface is a factory interface to create ApplicationMediaInterfaces
(media player, equalizer, speaker).
|
virtualdefault |
Destructor.
|
pure virtual |
Creates a new ApplicationMediaInterfaces
struct of related application media interfaces.
name | The name of this media player. |
equalizerAvailable | Whether an equalizer is available for this media player. If equalizers are enabled in SDK configuration, the equalizer will be added to the EqualizerRuntimeSetup. |
enableLiveMode | Whether live mode is enabled for this media player. |
isCaptionable | Whether this media player is a source for captions. |
channelVolumeType | Optional ChannelVolumeType of the speaker. Default is AVS_SPEAKER_VOLUME. |
volumeCurve | Optional channel volume curve to be used for channel volume attenuation. |
ApplicationMediaInterfaces
struct, including media player and other interfaces. Implemented in alexaClientSDK::defaultClient::StubApplicationAudioPipelineFactory, alexaClientSDK::acsdkApplicationAudioPipelineFactory::AndroidApplicationAudioPipelineFactory, alexaClientSDK::acsdkApplicationAudioPipelineFactory::CustomApplicationAudioPipelineFactory, and alexaClientSDK::acsdkApplicationAudioPipelineFactory::GstreamerApplicationAudioPipelineFactory.
|
pure virtual |
Creates a new PooledApplicationMediaInterfaces
struct of multiple media players and related interfaces.
name | The name of these media players for logging purposes. |
numMediaPlayers | The number of media players to create. |
equalizerAvailable | Whether an equalizer is available. If equalizers are enabled in SDK configuration, the equalizers will be added to the EqualizerRuntimeSetup. |
enableLiveMode | Whether live mode is enabled for these players. |
isCaptionable | Whether these players are a source for captions. |
channelVolumeType | Optional ChannelVolumeType of the speakers. Default is AVS_SPEAKER_VOLUME. |
volumeCurve | Optional channel volume curve to be used for channel volume attenuation. |
PooledApplicationMediaInterfaces
struct, including media players and other interfaces. Implemented in alexaClientSDK::defaultClient::StubApplicationAudioPipelineFactory, alexaClientSDK::acsdkApplicationAudioPipelineFactory::AndroidApplicationAudioPipelineFactory, alexaClientSDK::acsdkApplicationAudioPipelineFactory::CustomApplicationAudioPipelineFactory, and alexaClientSDK::acsdkApplicationAudioPipelineFactory::GstreamerApplicationAudioPipelineFactory.
AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0