AlexaClientSDK
1.22.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
|
#include <CustomApplicationAudioPipelineFactory.h>
Public Member Functions | |
ApplicationAudioPipelineFactoryInterface | |
std::shared_ptr< avsCommon::sdkInterfaces::ApplicationMediaInterfaces > | createApplicationMediaInterfaces (const std::string &name, bool equalizerAvailable, bool enableLiveMode, bool isCaptionable, avsCommon::sdkInterfaces::ChannelVolumeInterface::Type channelVolumeType, std::function< int8_t(int8_t)> volumeCurve) override |
std::shared_ptr< acsdkApplicationAudioPipelineFactoryInterfaces::PooledApplicationMediaInterfaces > | createPooledApplicationMediaInterfaces (const std::string &name, int numMediaPlayers, bool equalizerAvailable, bool enableLiveMode, bool isCaptionable, avsCommon::sdkInterfaces::ChannelVolumeInterface::Type channelVolumeType, std::function< int8_t(int8_t)> volumeCurve) override |
Public Member Functions inherited from alexaClientSDK::acsdkApplicationAudioPipelineFactoryInterfaces::ApplicationAudioPipelineFactoryInterface | |
virtual | ~ApplicationAudioPipelineFactoryInterface ()=default |
Static Public Member Functions | |
static std::shared_ptr< acsdkApplicationAudioPipelineFactoryInterfaces::ApplicationAudioPipelineFactoryInterface > | create (const std::shared_ptr< avsCommon::sdkInterfaces::ChannelVolumeFactoryInterface > &channelVolumeFactory, const std::shared_ptr< avsCommon::sdkInterfaces::SpeakerManagerInterface > &speakerManager, const std::shared_ptr< acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface > &equalizerRuntimeSetup, const std::shared_ptr< avsCommon::sdkInterfaces::HTTPContentFetcherInterfaceFactoryInterface > &httpContentFetcherFactory, const std::shared_ptr< acsdkShutdownManagerInterfaces::ShutdownNotifierInterface > &shutdownNotifier, const std::shared_ptr< captions::CaptionManagerInterface > &captionManager) |
Factory to create media players and related interfaces for custom media players.
Custom media players must implement createCustomMediaPlayer(), defined below in the alexaClientSDK namespace.
|
static |
Creates a new instance of ApplicationAudioPipelineFactoryInterface
.
channelVolumeFactory | The ChannelVolumeFactoryInterface to use for creating channel volume interfaces. |
speakerManagerInterface | The SpeakerManagerInterface with which to register speakers. |
equalizerRuntimeSetup | The EqualizerRuntimeSetupInterface with which to register equalizers. |
httpContentFetcherFactory | The HTTPContentFetcherInterfaceFactoryInterface to fetch remote http content. |
shutdownNotifier | The ShutdownNotifierInterface to notify created media players of shutdown. |
captionManager | The CaptionManagerInterface to add captionable media sources. |
ApplicationAudioPipelineFactoryInterface
for custom media players.
|
overridevirtual |
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. Implements alexaClientSDK::acsdkApplicationAudioPipelineFactoryInterfaces::ApplicationAudioPipelineFactoryInterface.
|
overridevirtual |
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. Implements alexaClientSDK::acsdkApplicationAudioPipelineFactoryInterfaces::ApplicationAudioPipelineFactoryInterface.
AlexaClientSDK 1.22.0 - Copyright 2016-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0