summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThibault Saunier <thibault.saunier@collabora.com>2012-02-01 20:25:35 -0300
committerThibault Saunier <thibault.saunier@collabora.com>2012-04-07 22:24:55 -0400
commit83dc13c63d202352a86c3946f684b9eae843b6d0 (patch)
treec4daa5b647aee45078dae40043eb6f9df073b358
parenta1aa78cd28c4caa1a17c705c5665fa69264ec5ea (diff)
docs: Tell users that adding an object to a timeline layer creates media related objects
-rw-r--r--ges/ges-timeline-layer.c5
1 files changed, 5 insertions, 0 deletions
diff --git a/ges/ges-timeline-layer.c b/ges/ges-timeline-layer.c
index e7398954..a06f1502 100644
--- a/ges/ges-timeline-layer.c
+++ b/ges/ges-timeline-layer.c
@@ -306,6 +306,11 @@ track_get_by_layer (GESTimelineLayer * layer, GESTrack * track)
*
* An object can only be added to one layer.
*
+ * Calling this method will construct and properly set all the media related
+ * elements on @object. If you need to know when those objects (actually #GESTrackObject)
+ * are constructed, you should connect to the object::track-object-added signal which
+ * is emited right after those elements are ready to be used.
+ *
* Returns: TRUE if the object was properly added to the layer, or FALSE
* if the @layer refuses to add the object.
*/