#include <AttachmentReaderSource.h>

Inheritance diagram for alexaClientSDK::mediaPlayer::AttachmentReaderSource:

Collaboration diagram for alexaClientSDK::mediaPlayer::AttachmentReaderSource:

Public Member Functions
	~AttachmentReaderSource ()

Overridden SourceInterface methods.
bool	isPlaybackRemote () const override

Public Member Functions inherited from alexaClientSDK::mediaPlayer::BaseStreamSource
	BaseStreamSource (PipelineInterface *pipeline, const std::string &className)

	~BaseStreamSource () override

bool	hasAdditionalData () override

bool	handleEndOfStream () override

void	preprocess () override

void	addObserver (std::shared_ptr< SourceObserverInterface > observer) override

void	removeObserver (std::shared_ptr< SourceObserverInterface > observer) override

Public Member Functions inherited from alexaClientSDK::mediaPlayer::SourceInterface
	SourceInterface (const std::string &className)

virtual	~SourceInterface ()=default

Public Member Functions inherited from alexaClientSDK::avsCommon::utils::RequiresShutdown
	RequiresShutdown (const std::string &name)

virtual	~RequiresShutdown ()
	Destructor. More...

const std::string &	name () const

void	shutdown ()

bool	isShutdown () const

Static Public Member Functions
static std::unique_ptr< AttachmentReaderSource >	create (PipelineInterface pipeline, std::shared_ptr< avsCommon::avs::attachment::AttachmentReader > attachmentReader, const avsCommon::utils::AudioFormat audioFormat, bool repeat)

Additional Inherited Members
Protected Member Functions inherited from alexaClientSDK::mediaPlayer::BaseStreamSource
bool	init (const avsCommon::utils::AudioFormat *audioFormat=nullptr)

GstAppSrc *	getAppSrc () const

void	signalEndOfData ()

void	installOnReadDataHandler ()

void	updateOnReadDataHandler ()

void	uninstallOnReadDataHandler ()

void	clearOnReadDataHandler ()

void	notifyObserversOnReadData ()

Constructor & Destructor Documentation

◆ ~AttachmentReaderSource()

alexaClientSDK::mediaPlayer::AttachmentReaderSource::~AttachmentReaderSource ( )

Member Function Documentation

◆ create()

static std::unique_ptr<AttachmentReaderSource> alexaClientSDK::mediaPlayer::AttachmentReaderSource::create	(	PipelineInterface *	pipeline,
		std::shared_ptr< avsCommon::avs::attachment::AttachmentReader >	attachmentReader,
		const avsCommon::utils::AudioFormat *	audioFormat,
		bool	repeat
	)

static

Creates an instance of the AttachmentReaderSource and installs the source within the GStreamer pipeline.

Parameters

pipeline	The `PipelineInterface` through which the source of the `AudioPipeline` may be set.
attachmentReader	The `AttachmentReader` from which to create the pipeline source from.
audioFormat	The audioFormat to be used when playing raw PCM data.
repeat	A parameter indicating whether to play from the source in a loop.

Returns: An instance of the AttachmentReaderSource if successful else a nullptr.

◆ isPlaybackRemote()

bool alexaClientSDK::mediaPlayer::AttachmentReaderSource::isPlaybackRemote ( ) const

overridevirtual

Indicates whether a source is local or remote from the perspective of the MediaPlayer (e.g. playing out of the SDS is local, playing a URL is remote).

Returns: A boolean indicating whether the source is from a remote or local source

Implements alexaClientSDK::mediaPlayer::SourceInterface.

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

/workplace/avs-device-sdk/MediaPlayer/GStreamerMediaPlayer/include/MediaPlayer/AttachmentReaderSource.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ ~AttachmentReaderSource()

Member Function Documentation

◆ create()

◆ isPlaybackRemote()