#include <ApplicationAudioPipelineFactoryInterface.h>

Inheritance diagram for alexaClientSDK::acsdkApplicationAudioPipelineFactoryInterfaces::ApplicationAudioPipelineFactoryInterface:

[legend]

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

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

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.

Returns: A new ApplicationMediaInterfaces struct, including media player and other interfaces.

Implemented in alexaClientSDK::defaultClient::StubApplicationAudioPipelineFactory, alexaClientSDK::acsdkApplicationAudioPipelineFactory::AndroidApplicationAudioPipelineFactory, alexaClientSDK::acsdkApplicationAudioPipelineFactory::CustomApplicationAudioPipelineFactory, and alexaClientSDK::acsdkApplicationAudioPipelineFactory::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`
	)