gstreamermm
1.10.0
|
A base class for the GStreamer object hierarchy. More...
#include <gstreamermm/object.h>
Public Member Functions | |
Object (Object&& src) noexcept | |
Object& | operator= (Object&& src) noexcept |
~Object () noexcept override | |
GstObject* | gobj () |
Provides access to the underlying C GObject. More... | |
const GstObject* | gobj () const |
Provides access to the underlying C GObject. More... | |
GstObject* | gobj_copy () |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More... | |
bool | is_element () const |
bool | is_element_factory () const |
bool | is_pad () const |
bool | is_pad_template () const |
bool | is_bin () const |
guint32 | get_flags () const |
Returns the entire set of flags for the object. More... | |
bool | set_name (const Glib::ustring& name) |
Sets the name of object, or gives object a guaranteed unique name (if name is nullptr ). More... | |
Glib::ustring | get_name () const |
Returns a copy of the name of object. More... | |
bool | set_parent (const Glib::RefPtr< Gst::Object >& parent) |
Sets the parent of object to parent. More... | |
Glib::RefPtr< Gst::Object > | get_parent () |
Returns the parent of object. More... | |
Glib::RefPtr< const Gst::Object > | get_parent () const |
Returns the parent of object. More... | |
void | unparent () |
Clear the parent of object, removing the associated reference. More... | |
void | set_control_rate (Gst::ClockTime control_rate) |
Change the control-rate for this object. More... | |
Gst::ClockTime | get_control_rate () const |
Obtain the control-rate for this object. More... | |
Gst::ClockTime | suggest_next_sync () const |
Returns a suggestion for timestamps where buffers should be split to get best controller results. More... | |
bool | sync_values (Gst::ClockTime timestamp) |
Sets the properties of the object, according to the Gst::ControlSources that (maybe) handle them and for the given timestamp. More... | |
void | set_control_bindings_disabled (bool disabled) |
This function is used to disable all controlled properties of the object for some time, i.e. sync_values() will do nothing. More... | |
bool | has_asctive_control_bindings () const |
Check if the object has an active controlled properties. More... | |
bool | has_ancestor (const Glib::RefPtr< const Gst::Object >& ancestor) const |
Check if object has an ancestor ancestor somewhere up in the hierarchy. More... | |
bool | has_as_ancestor (const Glib::RefPtr< Gst::Object >& ancestor) const |
Check if object has an ancestor ancestor somewhere up in the hierarchy. More... | |
bool | has_as_parent (const Glib::RefPtr< Gst::Object >& parent) const |
Check if parent is the parent of object. More... | |
Glib::ustring | get_path_string () |
Generates a string describing the path of object in the object hierarchy. More... | |
Glib::PropertyProxy< Glib::ustring > | property_name () |
The name of the object. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_name () const |
The name of the object. More... | |
Glib::PropertyProxy< Glib::RefPtr< Gst::Object > > | property_parent () |
The parent of the object. More... | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gst::Object > > | property_parent () const |
The parent of the object. More... | |
Glib::SignalProxy< void, const Glib::RefPtr< Gst::Object >&, GParamSpec*> | signal_deep_notify () |
int | get_refcount () const |
Static Public Member Functions | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. More... | |
static bool | check_uniqueness (const Glib::ListHandle< const Gst::Object >& list, const Glib::ustring& name) |
Checks to see if there is any object named name in list. More... | |
Protected Member Functions | |
virtual void | on_deep_notify (const Glib::RefPtr< Gst::Object >& prop_object, GParamSpec* prop) |
This is a default handler for the signal signal_deep_notify(). More... | |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr< Gst::Object > | wrap (GstObject* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
A base class for the GStreamer object hierarchy.
Gst::Object provides a root for the object hierarchy tree filed in by the GStreamer library. It is currently a thin wrapper on top of Glib::Object. It is an abstract class that is not very usable on its own.
Gst::Object gives us basic refcounting, parenting functionality and locking. Most of the function are just extended for special GStreamer needs and can be found under the same name in the base class of Gst::Object which is Glib::Object (e.g. Glib::Object::reference() becomes Gst:Object::reference().
In contrast to Glib::Object instances, Gst::Object adds a name property. The functions set_name() and get_name() are used to set/get the name of the object.
Last reviewed on 2016-06-06 (1.8.0)
|
noexcept |
|
overridenoexcept |
|
static |
Checks to see if there is any object named name in list.
This function does not do any locking of any kind. You might want to protect the provided list with the lock of the owner of the list. This function will lock each Gst::Object in the list to compare the name, so be careful when passing a list with a locked object.
list | A list of Gst::Object to check through. |
name | The name to search for. |
true
if a Gst::Object named name does not appear in list, false
if it does.MT safe. Grabs and releases the LOCK of each object in the list.
Gst::ClockTime Gst::Object::get_control_rate | ( | ) | const |
Obtain the control-rate for this object.
Audio processing Gst::Element objects will use this rate to sub-divide their processing loop and call sync_values() inbetween. The length of the processing segment should be up to control-rate nanoseconds.
If the object is not under property control, this will return Gst::CLOCK_TIME_NONE. This allows the element to avoid the sub-dividing.
The control-rate is not expected to change if the element is in Gst::STATE_PAUSED or Gst::STATE_PLAYING.
guint32 Gst::Object::get_flags | ( | ) | const |
Returns the entire set of flags for the object.
Glib::ustring Gst::Object::get_name | ( | ) | const |
Returns a copy of the name of object.
For a nameless object, this returns nullptr
, which you can safely Glib::free() as well.
Free-function: g_free
MT safe. This function grabs and releases object's LOCK.
Glib::RefPtr<Gst::Object> Gst::Object::get_parent | ( | ) |
Returns the parent of object.
This function increases the refcount of the parent object so you should unref() it after usage.
nullptr
if object has no parent. unref after usage.MT safe. Grabs and releases object's LOCK.
Glib::RefPtr<const Gst::Object> Gst::Object::get_parent | ( | ) | const |
Returns the parent of object.
This function increases the refcount of the parent object so you should unref() it after usage.
nullptr
if object has no parent. unref after usage.MT safe. Grabs and releases object's LOCK.
Glib::ustring Gst::Object::get_path_string | ( | ) |
Generates a string describing the path of object in the object hierarchy.
Only useful (or used) for debugging.
MT safe. Grabs and releases the Gst::Object's LOCK for all objects in the hierarchy.
int Gst::Object::get_refcount | ( | ) | const |
|
static |
Get the GType for this class, for use with the underlying GObject type system.
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
GstObject* Gst::Object::gobj_copy | ( | ) |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
bool Gst::Object::has_ancestor | ( | const Glib::RefPtr< const Gst::Object >& | ancestor | ) | const |
Check if object has an ancestor ancestor somewhere up in the hierarchy.
One can e.g. check if a Gst::Element is inside a Gst::Pipeline.
Deprecated: Use has_as_ancestor() instead.
MT safe. Grabs and releases object's locks.
ancestor | A Gst::Object to check as ancestor. |
true
if ancestor is an ancestor of object. bool Gst::Object::has_as_ancestor | ( | const Glib::RefPtr< Gst::Object >& | ancestor | ) | const |
Check if object has an ancestor ancestor somewhere up in the hierarchy.
One can e.g. check if a Gst::Element is inside a Gst::Pipeline.
ancestor | A Gst::Object to check as ancestor. |
true
if ancestor is an ancestor of object.MT safe. Grabs and releases object's locks.
bool Gst::Object::has_as_parent | ( | const Glib::RefPtr< Gst::Object >& | parent | ) | const |
Check if parent is the parent of object.
E.g. a Gst::Element can check if it owns a given Gst::Pad.
parent | A Gst::Object to check as parent. |
false
if either object or parent is nullptr
. true
if parent is the parent of object. Otherwise false
.MT safe. Grabs and releases object's locks.
bool Gst::Object::has_asctive_control_bindings | ( | ) | const |
Check if the object has an active controlled properties.
true
if the object has active controlled properties. bool Gst::Object::is_bin | ( | ) | const |
bool Gst::Object::is_element | ( | ) | const |
bool Gst::Object::is_element_factory | ( | ) | const |
bool Gst::Object::is_pad | ( | ) | const |
bool Gst::Object::is_pad_template | ( | ) | const |
|
protectedvirtual |
This is a default handler for the signal signal_deep_notify().
Glib::PropertyProxy< Glib::ustring > Gst::Object::property_name | ( | ) |
The name of the object.
Glib::PropertyProxy_ReadOnly< Glib::ustring > Gst::Object::property_name | ( | ) | const |
The name of the object.
Glib::PropertyProxy< Glib::RefPtr<Gst::Object> > Gst::Object::property_parent | ( | ) |
The parent of the object.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gst::Object> > Gst::Object::property_parent | ( | ) | const |
The parent of the object.
void Gst::Object::set_control_bindings_disabled | ( | bool | disabled | ) |
This function is used to disable all controlled properties of the object for some time, i.e. sync_values() will do nothing.
disabled | Boolean that specifies whether to disable the controller or not. |
void Gst::Object::set_control_rate | ( | Gst::ClockTime | control_rate | ) |
Change the control-rate for this object.
Audio processing Gst::Element objects will use this rate to sub-divide their processing loop and call sync_values() inbetween. The length of the processing segment should be up to control-rate nanoseconds.
The control-rate should not change if the element is in Gst::STATE_PAUSED or Gst::STATE_PLAYING.
control_rate | The new control-rate in nanoseconds. |
bool Gst::Object::set_name | ( | const Glib::ustring & | name | ) |
Sets the name of object, or gives object a guaranteed unique name (if name is nullptr
).
This function makes a copy of the provided name, so the caller retains ownership of the name it sent.
name | New name of object. |
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. This function grabs and releases object's LOCK.
bool Gst::Object::set_parent | ( | const Glib::RefPtr< Gst::Object >& | parent | ) |
Sets the parent of object to parent.
The object's reference count will be incremented, and any floating reference will be removed (see ref_sink()).
parent | New parent of object. |
true
if parent could be set or false
when object already had a parent or object and parent are the same.MT safe. Grabs and releases object's LOCK.
Glib::SignalProxy< void,const Glib::RefPtr<Gst::Object>&,GParamSpec* > Gst::Object::signal_deep_notify | ( | ) |
void on_my_deep_notify(const Glib::RefPtr<Gst::Object>& prop_object, GParamSpec* prop)
The deep notify signal is used to be notified of property changes. It is typically attached to the toplevel bin to receive notifications from all the elements contained in that bin.
prop_object | The object that originated the signal. |
prop | The property that changed. |
Gst::ClockTime Gst::Object::suggest_next_sync | ( | ) | const |
Returns a suggestion for timestamps where buffers should be split to get best controller results.
bool Gst::Object::sync_values | ( | Gst::ClockTime | timestamp | ) |
Sets the properties of the object, according to the Gst::ControlSources 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.
timestamp | The time that should be processed. |
true
if the controller values could be applied to the object properties, false
otherwise. void Gst::Object::unparent | ( | ) |
Clear the parent of object, removing the associated reference.
This function decreases the refcount of object.
MT safe. Grabs and releases object's lock.
|
related |
A Glib::wrap() method for this object.
object | The C instance. |
take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref. |