mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-24 09:10:36 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: Flesh out element and object macro accessor docs a bit

Browse source 
https://bugzilla.gnome.org/show_bug.cgi?id=763213
This commit is contained in:
Carlos Rafael Giani 2016-03-10 10:35:40 +01:00 committed by Tim-Philipp Müller
parent b2a111c19d
commit f70dc95c35
2 changed files with 18 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
gst/gstelement.h
View file

@ -346,8 +346,9 @@ typedef enum
* GST_ELEMENT_NAME:
* @elem: A #GstElement to query
*
* Gets the name of this element. Use only in core as this is not
* ABI-compatible. Others use gst_element_get_name()
* Gets the name of this element. This is not thread-safe by default
* (i.e. you will have to make sure the object lock is taken yourself).
* If in doubt use gst_element_get_name() instead.
*/
#define GST_ELEMENT_NAME(elem) (GST_OBJECT_NAME(elem))
@ -355,7 +356,9 @@ typedef enum
* GST_ELEMENT_PARENT:
* @elem: A #GstElement to query
*
* Get the parent object of this element.
* Get the parent object of this element. This is not thread-safe by default
* (i.e. you will have to make sure the object lock is taken yourself).
* If in doubt use gst_object_get_parent() instead.
*/
#define GST_ELEMENT_PARENT(elem) (GST_ELEMENT_CAST(GST_OBJECT_PARENT(elem)))
@ -363,7 +366,9 @@ typedef enum
* GST_ELEMENT_BUS:
* @elem: A #GstElement to query
*
* Get the message bus of this element.
* Get the message bus of this element. This is not thread-safe by default
* (i.e. you will have to make sure the object lock is taken yourself).
* If in doubt use gst_element_get_bus() instead.
*/
#define GST_ELEMENT_BUS(elem) (GST_ELEMENT_CAST(elem)->bus)
@ -371,7 +376,9 @@ typedef enum
* GST_ELEMENT_CLOCK:
* @elem: A #GstElement to query
*
* Get the clock of this element
* Get the clock of this element.This is not thread-safe by default
* (i.e. you will have to make sure it is safe yourself).
* If in doubt use gst_element_get_clock() instead.
*/
#define GST_ELEMENT_CLOCK(elem) (GST_ELEMENT_CAST(elem)->clock)

8
gst/gstobject.h
View file

@ -105,14 +105,18 @@ typedef enum
* GST_OBJECT_NAME:
* @obj: a #GstObject
*
* Get the name of this object
* Get the name of this object. This is not thread-safe by default
* (i.e. you will have to make sure the object lock is taken yourself).
* If in doubt use gst_object_get_name() instead.
*/
#define GST_OBJECT_NAME(obj) (GST_OBJECT_CAST(obj)->name)
/**
* GST_OBJECT_PARENT:
* @obj: a #GstObject
*
* Get the parent of this object
* Get the parent of this object. This is not thread-safe by default
* (i.e. you will have to make sure the object lock is taken yourself).
* If in doubt use gst_object_get_parent() instead.
*/
#define GST_OBJECT_PARENT(obj) (GST_OBJECT_CAST(obj)->parent)