alexaClientSDK::mediaPlayer::PipelineInterface Class Reference

#include <PipelineInterface.h>

Inheritance diagram for alexaClientSDK::mediaPlayer::PipelineInterface:

Public Member Functions
virtual void	setAppSrc (GstAppSrc *appSrc)=0
virtual GstAppSrc *	getAppSrc () const =0
virtual void	setDecoder (GstElement *decoder)=0
virtual GstElement *	getDecoder () const =0
virtual GstElement *	getPipeline () const =0
virtual guint	queueCallback (const std::function< gboolean()> *callback)=0
virtual guint	attachSource (GSource *source)=0
virtual gboolean	removeSource (guint tag)=0

Protected Member Functions
virtual	~PipelineInterface ()=default

Detailed Description

An interface that allows accessing some members of an AudioPipeline instantiated by the MediaPlayer. The interface also allows queuing callbacks on the worker thread of the MediaPlayer.

Constructor & Destructor Documentation

~PipelineInterface()

virtual alexaClientSDK::mediaPlayer::PipelineInterface::~PipelineInterface ( )

protectedvirtualdefault

Destructor.

Member Function Documentation

attachSource()

virtual guint alexaClientSDK::mediaPlayer::PipelineInterface::attachSource ( GSource *  source )

pure virtual

Attach the source to the worker thread.

Parameters

source

The source to be executed on the worker thread.

Returns

The ID (greater than 0) of the source. 0 if there is an error.

Implemented in alexaClientSDK::mediaPlayer::MediaPlayer.

getAppSrc()

virtual GstAppSrc* alexaClientSDK::mediaPlayer::PipelineInterface::getAppSrc ( ) const

pure virtual

Gets the appSrc element of the AudioPipeline.

Returns

The appSrc element.

Implemented in alexaClientSDK::mediaPlayer::MediaPlayer.

getDecoder()

virtual GstElement* alexaClientSDK::mediaPlayer::PipelineInterface::getDecoder ( ) const

pure virtual

Gets the decoder element of the AudioPipeline.

Returns

The decoder element.

Implemented in alexaClientSDK::mediaPlayer::MediaPlayer.

getPipeline()

virtual GstElement* alexaClientSDK::mediaPlayer::PipelineInterface::getPipeline ( ) const

pure virtual

Gets the pipeline of the AudioPipeline.

Returns

The pipeline.

Implemented in alexaClientSDK::mediaPlayer::MediaPlayer.

queueCallback()

virtual guint alexaClientSDK::mediaPlayer::PipelineInterface::queueCallback ( const std::function< gboolean()> *  callback )

pure virtual

Queue the specified callback for execution on the worker thread.

Parameters

callback

The callback to queue.

Returns

The ID of the queued callback (for calling g_source_remove).

Implemented in alexaClientSDK::mediaPlayer::MediaPlayer.

removeSource()

virtual gboolean alexaClientSDK::mediaPlayer::PipelineInterface::removeSource ( guint  tag )

pure virtual

Remove the callback from the worker thread.

Parameters

The	ID of the queued callback.

Returns

Whether the removal is successful.

Implemented in alexaClientSDK::mediaPlayer::MediaPlayer.

setAppSrc()

virtual void alexaClientSDK::mediaPlayer::PipelineInterface::setAppSrc ( GstAppSrc *  appSrc )

pure virtual

Sets the appSrc element in the AudioPipeline.

Parameters

appSrc

The element the appSrc of AudioPipeline should be set to.

Implemented in alexaClientSDK::mediaPlayer::MediaPlayer.

setDecoder()

virtual void alexaClientSDK::mediaPlayer::PipelineInterface::setDecoder ( GstElement *  decoder )

pure virtual

Sets the decoder element in the AudioPipeline

Parameters

decoder

The element the decoder of AudioPipeline should be set to.

Implemented in alexaClientSDK::mediaPlayer::MediaPlayer.

---

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

• /workplace/avs-device-sdk/MediaPlayer/GStreamerMediaPlayer/include/MediaPlayer/PipelineInterface.h