Package org.kurento.client

Interface GStreamerFilter

All Superinterfaces:

Filter, KurentoObject, MediaElement, MediaObject

public interface GStreamerFilter
extends Filter

A generic filter that allows injecting a single GStreamer element.

The current implementation of GStreamerFilter only allows single elements to be injected; one cannot indicate more than one at the same time; use several GStreamerFilters if you need to inject more than one element into the pipeline.

Note that usage of some popular GStreamer elements requires installation of additional packages. For example, overlay elements such as timeoverlay or textoverlay require installation of the gstreamer1.0-x package, which will also install the Pango rendering library.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	GStreamerFilter.Builder

Method Summary

Modifier and Type	Method	Description
String	getCommand()	Get String used to instantiate the GStreamer element, as in gst-launch (https://gstreamer.freedesktop.org/documentation/tools/gst-launch.html).
void	getCommand(Continuation<String> cont)	Get String used to instantiate the GStreamer element, as in gst-launch (https://gstreamer.freedesktop.org/documentation/tools/gst-launch.html).
TFuture<String>	getCommand(Transaction tx)	Get String used to instantiate the GStreamer element, as in gst-launch (https://gstreamer.freedesktop.org/documentation/tools/gst-launch.html).
void	setElementProperty(String propertyName, String propertyValue)	Provide a value to one of the GStreamer element's properties.
void	setElementProperty(String propertyName, String propertyValue, Continuation<Void> cont)	Asynchronous version of setElementProperty: Continuation.onSuccess(F) is called when the action is done.
void	setElementProperty(Transaction tx, String propertyName, String propertyValue)	Provide a value to one of the GStreamer element's properties.

Methods inherited from interface org.kurento.client.KurentoObject

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

Methods inherited from interface org.kurento.client.MediaElement

addElementConnectedListener, addElementConnectedListener, addElementDisconnectedListener, addElementDisconnectedListener, addMediaFlowInStateChangedListener, addMediaFlowInStateChangedListener, addMediaFlowOutStateChangedListener, addMediaFlowOutStateChangedListener, addMediaTranscodingStateChangedListener, addMediaTranscodingStateChangedListener, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, dumpGstreamerDot, dumpGstreamerDot, dumpGstreamerDot, dumpGstreamerDot, dumpGstreamerDot, dumpGstreamerDot, getEncoderBitrate, getEncoderBitrate, getEncoderBitrate, getGstreamerDot, getGstreamerDot, getGstreamerDot, getGstreamerDot, getGstreamerDot, getGstreamerDot, getMaxEncoderBitrate, getMaxEncoderBitrate, getMaxEncoderBitrate, getMinEncoderBitrate, getMinEncoderBitrate, getMinEncoderBitrate, getSinkConnections, getSinkConnections, getSinkConnections, getSinkConnections, getSinkConnections, getSinkConnections, getSinkConnections, getSinkConnections, getSinkConnections, getSourceConnections, getSourceConnections, getSourceConnections, getSourceConnections, getSourceConnections, getSourceConnections, getSourceConnections, getSourceConnections, getSourceConnections, getStats, getStats, getStats, getStats, getStats, getStats, isMediaFlowingIn, isMediaFlowingIn, isMediaFlowingIn, isMediaFlowingIn, isMediaFlowingIn, isMediaFlowingIn, isMediaFlowingOut, isMediaFlowingOut, isMediaFlowingOut, isMediaFlowingOut, isMediaFlowingOut, isMediaFlowingOut, isMediaTranscoding, isMediaTranscoding, isMediaTranscoding, isMediaTranscoding, isMediaTranscoding, isMediaTranscoding, removeElementConnectedListener, removeElementConnectedListener, removeElementDisconnectedListener, removeElementDisconnectedListener, removeMediaFlowInStateChangedListener, removeMediaFlowInStateChangedListener, removeMediaFlowOutStateChangedListener, removeMediaFlowOutStateChangedListener, removeMediaTranscodingStateChangedListener, removeMediaTranscodingStateChangedListener, setAudioFormat, setAudioFormat, setAudioFormat, setEncoderBitrate, setEncoderBitrate, setEncoderBitrate, setMaxEncoderBitrate, setMaxEncoderBitrate, setMaxEncoderBitrate, setMinEncoderBitrate, setMinEncoderBitrate, setMinEncoderBitrate, setVideoFormat, setVideoFormat, setVideoFormat

Methods inherited from interface org.kurento.client.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

getCommand

String getCommand()

Get String used to instantiate the GStreamer element, as in gst-launch (https://gstreamer.freedesktop.org/documentation/tools/gst-launch.html).

getCommand

void getCommand(Continuation<String> cont)

Get String used to instantiate the GStreamer element, as in gst-launch (https://gstreamer.freedesktop.org/documentation/tools/gst-launch.html).

getCommand

TFuture<String> getCommand(Transaction tx)

Get String used to instantiate the GStreamer element, as in gst-launch (https://gstreamer.freedesktop.org/documentation/tools/gst-launch.html).

setElementProperty

void setElementProperty(String propertyName,
 String propertyValue)

Provide a value to one of the GStreamer element's properties.

Parameters:

propertyName - Name of the property that needs to be modified in the GStreamer element.

propertyValue - Value that must be assigned to the property.

setElementProperty

void setElementProperty(String propertyName,
 String propertyValue,
 Continuation<Void> cont)

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

Parameters:

propertyName - Name of the property that needs to be modified in the GStreamer element.

propertyValue - Value that must be assigned to the property.

See Also:

• setElementProperty(java.lang.String, java.lang.String)

setElementProperty

void setElementProperty(Transaction tx,
 String propertyName,
 String propertyValue)

Provide a value to one of the GStreamer element's properties.

Parameters:

propertyName - Name of the property that needs to be modified in the GStreamer element.

propertyValue - Value that must be assigned to the property.