Interface MediaPipeline

All Superinterfaces:

KurentoObject, MediaObject

public interface MediaPipeline
extends MediaObject

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.

Method Summary

Modifier and Type	Method	Description
Transaction	beginTransaction()
void	dumpGstreamerDot()	If GST_DEBUG_DUMP_DOT_DIR environment variable is defined dumps in that directoy a file with the GStreamer dot of the pipeline
void	dumpGstreamerDot(Continuation<Void> cont)	Asynchronous version of dumpGstreamerDot: Continuation.onSuccess(F) is called when the action is done.
void	dumpGstreamerDot(GstreamerDotDetails details)	If GST_DEBUG_DUMP_DOT_DIR environment variable is defined dumps in that directoy a file with the GStreamer dot of the pipeline
void	dumpGstreamerDot(GstreamerDotDetails details, Continuation<Void> cont)	Asynchronous version of dumpGstreamerDot: Continuation.onSuccess(F) is called when the action is done.
void	dumpGstreamerDot(Transaction tx)	If GST_DEBUG_DUMP_DOT_DIR environment variable is defined dumps in that directoy a file with the GStreamer dot of the pipeline
void	dumpGstreamerDot(Transaction tx, GstreamerDotDetails details)	If GST_DEBUG_DUMP_DOT_DIR environment variable is defined dumps in that directoy a file with the GStreamer dot of the pipeline
String	getGstreamerDot()	Returns a string in dot (graphviz) format that represents the gstreamer elements inside the pipeline
void	getGstreamerDot(Continuation<String> cont)	Asynchronous version of getGstreamerDot: Continuation.onSuccess(F) is called when the action is done.
String	getGstreamerDot(GstreamerDotDetails details)	Returns a string in dot (graphviz) format that represents the gstreamer elements inside the pipeline
void	getGstreamerDot(GstreamerDotDetails details, Continuation<String> cont)	Asynchronous version of getGstreamerDot: Continuation.onSuccess(F) is called when the action is done.
TFuture<String>	getGstreamerDot(Transaction tx)	Returns a string in dot (graphviz) format that represents the gstreamer elements inside the pipeline
TFuture<String>	getGstreamerDot(Transaction tx, GstreamerDotDetails details)	Returns a string in dot (graphviz) format that represents the gstreamer elements inside the pipeline
boolean	getLatencyStats()	Get If statistics about pipeline latency are enabled for all mediaElements
void	getLatencyStats(Continuation<Boolean> cont)	Get If statistics about pipeline latency are enabled for all mediaElements
TFuture<Boolean>	getLatencyStats(Transaction tx)	Get If statistics about pipeline latency are enabled for all mediaElements
void	setLatencyStats(boolean latencyStats)	Set If statistics about pipeline latency are enabled for all mediaElements
void	setLatencyStats(boolean latencyStats, Continuation<Void> cont)	Set If statistics about pipeline latency are enabled for all mediaElements
void	setLatencyStats(boolean latencyStats, Transaction tx)	Set If statistics about pipeline latency are enabled for all mediaElements

Methods inherited from interface KurentoObject

addEventListener, invoke, isCommited, release, release, release, removeEventListener, waitCommited, whenCommited, whenCommited

Methods inherited from interface MediaObject

addErrorListener, addErrorListener, addTag, addTag, addTag, getChildren, getChildren, getChildren, getCreationTime, getCreationTime, getCreationTime, getId, getId, getId, getMediaPipeline, getMediaPipeline, getMediaPipeline, getName, getName, getName, getParent, getParent, getParent, getSendTagsInEvents, getSendTagsInEvents, getSendTagsInEvents, getTag, getTag, getTag, getTags, getTags, getTags, removeErrorListener, removeErrorListener, removeTag, removeTag, removeTag, setName, setName, setName, setSendTagsInEvents, setSendTagsInEvents, setSendTagsInEvents

Method Details

getLatencyStats

boolean getLatencyStats()

Get If statistics about pipeline latency are enabled for all mediaElements

getLatencyStats

void getLatencyStats(Continuation<Boolean> cont)

Get If statistics about pipeline latency are enabled for all mediaElements

getLatencyStats

TFuture<Boolean> getLatencyStats(Transaction tx)

Get If statistics about pipeline latency are enabled for all mediaElements

setLatencyStats

void setLatencyStats(boolean latencyStats)

Set If statistics about pipeline latency are enabled for all mediaElements

setLatencyStats

void setLatencyStats(boolean latencyStats,
 Continuation<Void> cont)

Set If statistics about pipeline latency are enabled for all mediaElements

setLatencyStats

void setLatencyStats(boolean latencyStats,
 Transaction tx)

Set If statistics about pipeline latency are enabled for all mediaElements

getGstreamerDot

String getGstreamerDot(GstreamerDotDetails details)

Returns a string in dot (graphviz) format that represents the gstreamer elements inside the pipeline

Parameters:

details - Details of graph

Returns:

The dot graph. *

getGstreamerDot

void getGstreamerDot(GstreamerDotDetails details,
 Continuation<String> cont)

Asynchronous version of getGstreamerDot: Continuation.onSuccess(F) is called when the action is done. If an error occurs, Continuation.onError(Throwable) is called.

Parameters:

details - Details of graph

See Also:

• getGstreamerDot(GstreamerDotDetails)

getGstreamerDot

TFuture<String> getGstreamerDot(Transaction tx,
 GstreamerDotDetails details)

Returns a string in dot (graphviz) format that represents the gstreamer elements inside the pipeline

Parameters:

details - Details of graph

Returns:

The dot graph. *

dumpGstreamerDot

void dumpGstreamerDot(GstreamerDotDetails details)

If GST_DEBUG_DUMP_DOT_DIR environment variable is defined dumps in that directoy a file with the GStreamer dot of the pipeline

Parameters:

details - Details of graph

dumpGstreamerDot

void dumpGstreamerDot(GstreamerDotDetails details,
 Continuation<Void> cont)

Asynchronous version of dumpGstreamerDot: Continuation.onSuccess(F) is called when the action is done. If an error occurs, Continuation.onError(Throwable) is called.

Parameters:

details - Details of graph

See Also:

• dumpGstreamerDot(GstreamerDotDetails)

dumpGstreamerDot

void dumpGstreamerDot(Transaction tx,
 GstreamerDotDetails details)

If GST_DEBUG_DUMP_DOT_DIR environment variable is defined dumps in that directoy a file with the GStreamer dot of the pipeline

Parameters:

details - Details of graph

getGstreamerDot

String getGstreamerDot()

Returns a string in dot (graphviz) format that represents the gstreamer elements inside the pipeline

Returns:

The dot graph. *

getGstreamerDot

void getGstreamerDot(Continuation<String> cont)

Asynchronous version of getGstreamerDot: Continuation.onSuccess(F) is called when the action is done. If an error occurs, Continuation.onError(Throwable) is called.

See Also:

• getGstreamerDot(GstreamerDotDetails)

getGstreamerDot

TFuture<String> getGstreamerDot(Transaction tx)

Returns a string in dot (graphviz) format that represents the gstreamer elements inside the pipeline

Returns:

The dot graph. *

dumpGstreamerDot

void dumpGstreamerDot()

If GST_DEBUG_DUMP_DOT_DIR environment variable is defined dumps in that directoy a file with the GStreamer dot of the pipeline

dumpGstreamerDot

void dumpGstreamerDot(Continuation<Void> cont)

Asynchronous version of dumpGstreamerDot: Continuation.onSuccess(F) is called when the action is done. If an error occurs, Continuation.onError(Throwable) is called.

See Also:

• dumpGstreamerDot(GstreamerDotDetails)

dumpGstreamerDot

void dumpGstreamerDot(Transaction tx)

If GST_DEBUG_DUMP_DOT_DIR environment variable is defined dumps in that directoy a file with the GStreamer dot of the pipeline

beginTransaction

Transaction beginTransaction()