mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-07-02 20:55:55 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: improve API reference for gst_caps_get_structure()

Browse source
This commit is contained in:
Tim-Philipp Müller 2009-04-03 11:19:42 +01:00
parent 8995a45593
commit 01166ec0cd
1 changed files with 8 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
gst/gstcaps.c
View file

@ -793,7 +793,14 @@ gst_caps_get_size (const GstCaps * caps)
* WARNING: This function takes a const GstCaps *, but returns a
* non-const GstStructure *. This is for programming convenience --
* the caller should be aware that structures inside a constant
* #GstCaps should not be modified.
* #GstCaps should not be modified. However, if you know the caps
* are writable, either because you have just copied them or made
* them writable with gst_caps_make_writable(), you may modify the
* structure returned in the usual way, e.g. with functions like
* gst_structure_set_simple().
*
* You do not need to free or unref the structure returned, it
* belongs to the #GstCaps.
*
* Returns: a pointer to the #GstStructure corresponding to @index
*/