Class: MediaPipeline

core.MediaPipeline()

A pipeline is a container for a collection of MediaElements. It offers the methods needed to control the creation and connection of elements inside a certain pipeline.

Constructor

new MediaPipeline()

Create a MediaPipeline
Source:

Extends

Members

(static) constructorParams

Source:

(static) events

Source:

Methods

(static) dumpGstreamerDot(detailsopt, callbackopt) → {external:Promise}

If GST_DEBUG_DUMP_DOT_DIR environment variable is defined dumps in that directoy a file with the GStreamer dot of the pipeline
Parameters:
Name Type Attributes Description
details module:core/complexTypes.GstreamerDotDetails <optional>
 Details of graph
callback module:core.MediaPipeline~dumpGstreamerDotCallback <optional>
Source:
Returns:
Type
external:Promise

(static) getGstreamerDot(detailsopt, callbackopt) → {external:Promise}

Returns a string in dot (graphviz) format that represents the gstreamer elements inside the pipeline
Parameters:
Name Type Attributes Description
details module:core/complexTypes.GstreamerDotDetails <optional>
 Details of graph
callback module:core.MediaPipeline~getGstreamerDotCallback <optional>
Source:
Returns:
Type
external:Promise

getChildren(callbackopt) → {external:Promise}

Children of this MediaObject.
Parameters:
Name Type Attributes Description
callback module:core/abstracts.MediaObject~getChildrenCallback <optional>
Inherited From:
Source:
Returns:
Type
external:Promise

getCreationTime(callbackopt) → {external:Promise}

MediaObject creation time in seconds since Epoch.
Parameters:
Name Type Attributes Description
callback module:core/abstracts.MediaObject~getCreationTimeCallback <optional>
Inherited From:
Source:
Returns:
Type
external:Promise

getLatencyStats(callbackopt) → {external:Promise}

If statistics about pipeline latency are enabled for all mediaElements
Parameters:
Name Type Attributes Description
callback module:core.MediaPipeline~getLatencyStatsCallback <optional>
Source:
Returns:
Type
external:Promise

getMediaPipeline(callbackopt) → {external:Promise}

MediaPipeline to which this MediaObject belongs. It returns itself when invoked for a pipeline object.
Parameters:
Name Type Attributes Description
callback module:core/abstracts.MediaObject~getMediaPipelineCallback <optional>
Inherited From:
Source:
Returns:
Type
external:Promise

getName(callbackopt) → {external:Promise}

This MediaObject's name.

This is just sugar to simplify developers' life debugging, it is not used internally for indexing nor identifying the objects. By default, it's the object's ID.

Parameters:
Name Type Attributes Description
callback module:core/abstracts.MediaObject~getNameCallback <optional>
Inherited From:
Source:
Returns:
Type
external:Promise

getParent(callbackopt) → {external:Promise}

Parent of this MediaObject.

The parent of a Hub or a MediaElement is its MediaPipeline. A MediaPipeline has no parent, so this property will be null.

Parameters:
Name Type Attributes Description
callback module:core/abstracts.MediaObject~getParentCallback <optional>
Inherited From:
Source:
Returns:
Type
external:Promise

getSendTagsInEvents(callbackopt) → {external:Promise}

Flag activating or deactivating sending the element's tags in fired events.
Parameters:
Name Type Attributes Description
callback module:core/abstracts.MediaObject~getSendTagsInEventsCallback <optional>
Inherited From:
Source:
Returns:
Type
external:Promise

setLatencyStats(latencyStats, callbackopt) → {external:Promise}

If statistics about pipeline latency are enabled for all mediaElements
Parameters:
Name Type Attributes Description
latencyStats external:Boolean
callback module:core.MediaPipeline~setLatencyStatsCallback <optional>
Source:
Returns:
Type
external:Promise

setName(name, callbackopt) → {external:Promise}

This MediaObject's name.

This is just sugar to simplify developers' life debugging, it is not used internally for indexing nor identifying the objects. By default, it's the object's ID.

Parameters:
Name Type Attributes Description
name external:String
callback module:core/abstracts.MediaObject~setNameCallback <optional>
Inherited From:
Source:
Returns:
Type
external:Promise

setSendTagsInEvents(sendTagsInEvents, callbackopt) → {external:Promise}

Flag activating or deactivating sending the element's tags in fired events.
Parameters:
Name Type Attributes Description
sendTagsInEvents external:Boolean
callback module:core/abstracts.MediaObject~setSendTagsInEventsCallback <optional>
Inherited From:
Source:
Returns:
Type
external:Promise

Type Definitions

dumpGstreamerDotCallback(error)

Parameters:
Name Type Description
error external:Error
Source:

getGstreamerDotCallback(error, result)

Parameters:
Name Type Description
error external:Error
result external:String The dot graph.
Source:

getLatencyStatsCallback(error, result)

Parameters:
Name Type Description
error external:Error
result external:Boolean
Source:

setLatencyStatsCallback(error)

Parameters:
Name Type Description
error external:Error
Source: