ges: clip: doc: Add a reference for more information about effect index

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/6009>
This commit is contained in:
Thibault Saunier 2024-01-29 13:52:46 -03:00 committed by GStreamer Marge Bot
parent 726dd5f09f
commit e7803d1582
2 changed files with 4 additions and 2 deletions

View file

@ -1664,7 +1664,8 @@ would not be able to adapt itself once the effect is added.</doc>
<type name="BaseEffect" c:type="GESBaseEffect*"/>
</parameter>
<parameter name="index" transfer-ownership="none">
<doc xml:space="preserve" filename="../subprojects/gst-editing-services/ges/ges-clip.c">The index to add @effect at, or -1 to add at the highest</doc>
<doc xml:space="preserve" filename="../subprojects/gst-editing-services/ges/ges-clip.c">The index to add @effect at, or -1 to add at the highest,
see #ges_clip_get_top_effect_index for more information</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>

View file

@ -3034,7 +3034,8 @@ _cmp_children_by_priority (gconstpointer a_p, gconstpointer b_p)
* ges_clip_add_top_effect:
* @clip: A #GESClip
* @effect: A top effect to add
* @index: The index to add @effect at, or -1 to add at the highest
* @index: The index to add @effect at, or -1 to add at the highest,
* see #ges_clip_get_top_effect_index for more information
* @error: (nullable): Return location for an error
*
* Add a top effect to a clip at the given index.