AlexaClientSDK  1.22.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::acsdkApplicationAudioPipelineFactoryInterfaces::ApplicationAudioPipelineFactoryInterface Class Referenceabstract

#include <ApplicationAudioPipelineFactoryInterface.h>

Inheritance diagram for alexaClientSDK::acsdkApplicationAudioPipelineFactoryInterfaces::ApplicationAudioPipelineFactoryInterface:
Inheritance graph
[legend]

Public Member Functions

virtual ~ApplicationAudioPipelineFactoryInterface ()=default
 
virtual std::shared_ptr< avsCommon::sdkInterfaces::ApplicationMediaInterfacescreateApplicationMediaInterfaces (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< PooledApplicationMediaInterfacescreatePooledApplicationMediaInterfaces (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
 

Detailed Description

ApplicationAudioPipelineFactoryInterface is a factory interface to create ApplicationMediaInterfaces (media player, equalizer, speaker).

Constructor & Destructor Documentation

◆ ~ApplicationAudioPipelineFactoryInterface()

virtual alexaClientSDK::acsdkApplicationAudioPipelineFactoryInterfaces::ApplicationAudioPipelineFactoryInterface::~ApplicationAudioPipelineFactoryInterface ( )
virtualdefault

Destructor.

Member Function Documentation

◆ createApplicationMediaInterfaces()

virtual std::shared_ptr<avsCommon::sdkInterfaces::ApplicationMediaInterfaces> alexaClientSDK::acsdkApplicationAudioPipelineFactoryInterfaces::ApplicationAudioPipelineFactoryInterface::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 
)
pure virtual

Creates a new ApplicationMediaInterfaces struct of related application media interfaces.

Parameters
nameThe name of this media player.
equalizerAvailableWhether an equalizer is available for this media player. If equalizers are enabled in SDK configuration, the equalizer will be added to the EqualizerRuntimeSetup.
enableLiveModeWhether live mode is enabled for this media player.
isCaptionableWhether this media player is a source for captions.
channelVolumeTypeOptional ChannelVolumeType of the speaker. Default is AVS_SPEAKER_VOLUME.
volumeCurveOptional channel volume curve to be used for channel volume attenuation.
Returns
A new ApplicationMediaInterfaces struct, including media player and other interfaces.

Implemented in alexaClientSDK::defaultClient::StubApplicationAudioPipelineFactory, alexaClientSDK::acsdkAndroidApplicationAudioPipelineFactory::AndroidApplicationAudioPipelineFactory, alexaClientSDK::acsdkCustomApplicationAudioPipelineFactory::CustomApplicationAudioPipelineFactory, and alexaClientSDK::acsdkGstreamerApplicationAudioPipelineFactory::GstreamerApplicationAudioPipelineFactory.

◆ createPooledApplicationMediaInterfaces()

virtual std::shared_ptr<PooledApplicationMediaInterfaces> alexaClientSDK::acsdkApplicationAudioPipelineFactoryInterfaces::ApplicationAudioPipelineFactoryInterface::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 
)
pure virtual

Creates a new PooledApplicationMediaInterfaces struct of multiple media players and related interfaces.

Parameters
nameThe name of these media players for logging purposes.
numMediaPlayersThe number of media players to create.
equalizerAvailableWhether an equalizer is available. If equalizers are enabled in SDK configuration, the equalizers will be added to the EqualizerRuntimeSetup.
enableLiveModeWhether live mode is enabled for these players.
isCaptionableWhether these players are a source for captions.
channelVolumeTypeOptional ChannelVolumeType of the speakers. Default is AVS_SPEAKER_VOLUME.
volumeCurveOptional channel volume curve to be used for channel volume attenuation.
Returns
A new PooledApplicationMediaInterfaces struct, including media players and other interfaces.

Implemented in alexaClientSDK::defaultClient::StubApplicationAudioPipelineFactory, alexaClientSDK::acsdkAndroidApplicationAudioPipelineFactory::AndroidApplicationAudioPipelineFactory, alexaClientSDK::acsdkCustomApplicationAudioPipelineFactory::CustomApplicationAudioPipelineFactory, and alexaClientSDK::acsdkGstreamerApplicationAudioPipelineFactory::GstreamerApplicationAudioPipelineFactory.


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

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