Object

---

Object Hierarchy:

Description:

Content:

Properties:

• public string name { construct set; owned get; }

Static methods:

• public static bool check_uniqueness (List<Object> list, string name)
  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 Object in the list to compare the name, so be carefull when passing a list with a locked object. FALSE if it does. MT safe. Grabs and releases the LOCK of each object in the list.
• public static void default_deep_notify (Object object, Object orig, ParamSpec pspec, string? excluded_props)
  A default deep_notify signal callback for an object. The user data should contain a pointer to an array of strings that should be excluded from the notify. The default handler will print the new value of the property using g_print. MT safe. This function grabs and releases object's LOCK for getting its path string.
• public static void replace (ref Object? oldobj, Object? newobj)
  Unrefs the Object pointed to by oldobj , refs newobj and puts newobj in *@oldobj. Be carefull when calling this function, it does not take any locks. You might want to lock the object owning oldobj pointer before calling this function. Make sure not to LOCK oldobj because it might be unreffed which could cause a deadlock when it is disposed.

Creation methods:

• protected Object ()

Methods:

• public void default_error (Error error, string? debug)
  A default error function. The default handler will simply print the error string using g_print.
• public bool flag_is_set (ObjectFlags flag)
• public void flag_set (ObjectFlags flag)
• public void flag_unset (ObjectFlags flag)
• public string get_name ()
  Returns a copy of the name of object. Caller should g_free the return value after usage. For a nameless object, this returns NULL, which you can safely g_free as well. MT safe. This function grabs and releases object's LOCK.
• public string get_name_prefix ()
  Returns a copy of the name prefix of object. Caller should g_free the return value after usage. For a prefixless object, this returns NULL, which you can safely g_free as well. MT safe. This function grabs and releases object's LOCK. for anything.
• public Object get_parent ()
  Returns the parent of object. This function increases the refcount of the parent object so you should unref it after usage. has no parent. unref after usage. MT safe. Grabs and releases object's LOCK.
• public string get_path_string ()
  Generates a string describing the path of object in the object hierarchy. Only useful (or used) for debugging. g_free the string after usage. MT safe. Grabs and releases the Object's LOCK for all objects in the hierarchy.
• public bool has_ancestor (Object ancestor)
  Check if object has an ancestor ancestor somewhere up in the hierarchy. One can e.g. check if a Element is inside a Pipeline. MT safe. Grabs and releases object's locks.
• public bool is_disposing ()
• public bool is_floating ()
• public weak Object ref ()
  Increments the reference count on object. This function does not take the lock on object because it relies on atomic refcounting. This object returns the input parameter to ease writing constructs like : result = gst_object_ref (object->parent);
• public void ref_sink ()
  Increase the reference count of object, and possibly remove the floating reference, if object has a floating reference. In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one. MT safe. This function grabs and releases object lock.
• public virtual void restore_thyself (void* self)
  Restores object with the data from the parent XML node.
• public virtual void* save_thyself (void* parent)
  Saves object into the parent XML node.
• public bool set_name (string name)
  Sets the name of object, or gives object a guaranteed unique name (if name is NULL). This function makes a copy of the provided name, so the caller retains ownership of the name it sent. a parent cannot be renamed, this function returns FALSE in those cases. MT safe. This function grabs and releases object 's LOCK.
• public void set_name_prefix (string name_prefix)
  Sets the name prefix of object to name_prefix. This function makes a copy of the provided name prefix, so the caller retains ownership of the name prefix it sent. MT safe. This function grabs and releases object's LOCK. for anything.
• public bool set_parent (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 sink). This function causes the parent-set signal to be emitted when the parent was successfully set. already had a parent or object and parent are the same. MT safe. Grabs and releases object's LOCK.
• public void sink ()
  If object was floating, the FLOATING flag is removed and object is unreffed. When object was not floating, this function does nothing. Any newly created object has a refcount of 1 and is floating. This function should be used when creating a new object to symbolically 'take ownership' of object. This done by first doing a ref to keep a reference to object and then sink to remove and unref any floating references to object. Use set_parent to have this done for you. MT safe. This function grabs and releases object lock.
• public void 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.
• public void unref ()
  Decrements the reference count on object. If reference count hits zero, destroy object. This function does not take the lock on object as it relies on atomic refcounting. The unref method should never be called with the LOCK held since this might deadlock the dispose function.

Signals:

• public virtual void deep_notify (Object orig, ParamSpec pspec)
  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.
• public virtual void object_saved (void* parent)
  Trigered whenever a new object is saved to XML. You can connect to this signal to insert custom XML tags into the core XML.
• public virtual void parent_set (Object parent)
  Emitted when the parent of an object is set.
• public virtual void parent_unset (Object parent)
  Emitted when the parent of an object is unset.

Fields:

• public ObjectFlags flags
• public unowned Mutex lock
• public unowned string name_prefix
• public weak Object parent