org.freedesktop.gstreamer

Class GstObject

java.lang.Object

org.freedesktop.gstreamer.glib.NativeObject

org.freedesktop.gstreamer.glib.RefCountedObject

org.freedesktop.gstreamer.glib.GObject

org.freedesktop.gstreamer.GstObject

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

BufferPool, Bus, Clock, ControlBinding, ControlSource, Device, DeviceMonitor, DeviceProvider, DeviceProviderFactory, Element, Pad, PadTemplate, Plugin, PluginFeature, Registry

public class GstObject
extends GObject

Base class for the GStreamer object hierarchy

See upstream documentation at https://gstreamer.freedesktop.org/data/doc/gstreamer/stable/gstreamer/html/GstObject.html

GstObject provides a root for the object hierarchy tree filed in by the GStreamer library. It is currently a thin wrapper on top of GObject. It is an abstract class that is not very usable on its own.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	GstObject.Handle

Nested classes/interfaces inherited from class org.freedesktop.gstreamer.glib.GObject

GObject.GCallback, GObject.GInterface

Nested classes/interfaces inherited from class org.freedesktop.gstreamer.glib.NativeObject

NativeObject.Initializer, NativeObject.TypeProvider, NativeObject.TypeRegistration<T extends NativeObject>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GstObject(GstObject.Handle handle, boolean needRef)
protected	GstObject(NativeObject.Initializer init) Wraps an underlying C GstObject with a Java proxy

Method Summary

Modifier and Type	Method and Description
void	addControlBinding(ControlBinding binding) Attach a ControlBinding to this object.
String	getAsString(String property) Get the value of a GstObject property as a serialized String representation of its value.
ControlBinding	getControlBinding(String propertyName) Gets the corresponding ControlBinding for the property.
String	getName() Returns a copy of the name of this object.
GstObject	getParent() Returns this object's parent, if there is one.
boolean	hasActiveControlBindings() Check if this object has active controlled properties.
boolean	removeControlBinding(ControlBinding binding) Removes the corresponding ControlBinding.
void	setAsString(String property, String data) Set the value of a GstObject property from a String representation.
void	setControlBindingDisabled(String propertyName, boolean disabled) This function is used to disable the control bindings on a property for some time, i.e.
void	setControlBindingsDisabled(boolean disabled) This function is used to disable all controlled properties of the object for some time, i.e.
boolean	setName(String name) Sets the name of this object, or gives this object a guaranteed unique name (if name is null).
long	suggestNextSync() Returns a suggestion for timestamps where buffers should be split to get best controller results.
boolean	syncValues(long timestamp) Sets the properties of the object, according to the ControlSource that (maybe) handle them and for the given timestamp.
String	toString()

Methods inherited from class org.freedesktop.gstreamer.glib.GObject

addCallback, connect, connect, disconnect, dispose, emit, emit, get, getPropertyDefaultValue, getPropertyMaximumValue, getPropertyMinimumValue, getRefCount, getTypeName, invalidate, listPropertyNames, removeCallback, set

Methods inherited from class org.freedesktop.gstreamer.glib.NativeObject

close, disown, equals, getPointer, getRawPointer, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GstObject

protected GstObject(NativeObject.Initializer init)

Wraps an underlying C GstObject with a Java proxy

Parameters:

init - Initialization data

GstObject

protected GstObject(GstObject.Handle handle,
                    boolean needRef)

Method Detail

setAsString

public void setAsString(String property,
                        String data)

Set the value of a GstObject property from a String representation.

The data value is deserialized using gst_value_deserialize.

Parameters:

property - the property to set

data - the value as a valid String representation

Throws:

IllegalArgumentException - if the data cannot be deserialized to the required type.

getAsString

public String getAsString(String property)

Get the value of a GstObject property as a serialized String representation of its value.

The data value is serialized using gst_value_serialize.

Parameters:

property - the property to get

Returns:

serialized String value of property

setName

public boolean setName(String name)

Sets the name of this object, or gives this object a guaranteed unique name (if name is null). Returns: TRUE if the name could be set. Since Objects that have a parent cannot be renamed, this function returns FALSE in those cases. MT safe.

Parameters:

name - new name of object

Returns:

true if the name was set. Since Objects that have a parent cannot be renamed, this function returns false in those cases.

getName

public String getName()

Returns a copy of the name of this object. For a nameless object, this returns null.

Returns:

the name of this object.

getParent

public GstObject getParent()

Returns this object's parent, if there is one.

Returns:

parent or null

suggestNextSync

public long suggestNextSync()

Returns a suggestion for timestamps where buffers should be split to get best controller results.

Returns:

the suggested timestamp or ClockTime.NONE if no control-rate was set.

syncValues

public boolean syncValues(long timestamp)

Sets the properties of the object, according to the ControlSource that (maybe) handle them and for the given timestamp.

If this function fails, it is most likely the application developers fault. Most probably the control sources are not setup correctly.

Parameters:

timestamp - the time that should be processed

Returns:

true if the controller values have been applied to the object properties

hasActiveControlBindings

public boolean hasActiveControlBindings()

Check if this object has active controlled properties.

Returns:

TRUE if the object has active controlled properties

setControlBindingsDisabled

public void setControlBindingsDisabled(boolean disabled)

This function is used to disable all controlled properties of the object for some time, i.e. syncValues(long) will do nothing.

Parameters:

disabled - whether to disable the controllers or not

setControlBindingDisabled

public void setControlBindingDisabled(String propertyName,
                                      boolean disabled)

This function is used to disable the control bindings on a property for some time, i.e. syncValues(long) will do nothing for the property.

Parameters:

propertyName - property to disable

disabled - whether to disable the controller or not

addControlBinding

public void addControlBinding(ControlBinding binding)

Attach a ControlBinding to this object. If there was already a binding for this property it will be replaced.

Parameters:

binding - the ControlBinding that should be used

Throws:

IllegalStateException - if the binding has not been setup for this object

getControlBinding

public ControlBinding getControlBinding(String propertyName)

Gets the corresponding ControlBinding for the property.

Parameters:

propertyName - name of the property

Returns:

control binding for the property or NULL if the property is not controlled

removeControlBinding

public boolean removeControlBinding(ControlBinding binding)

Removes the corresponding ControlBinding.

Parameters:

binding - the binding to remove

Returns:

true if the binding could be removed

toString

public String toString()

Overrides:

toString in class NativeObject