clutter-media: mention the asynchronous behavior of set_playing() in the doc.

Depending on the ClutterMedia implementation, the set_playing()
call can be asynchronous, the playing state's change being not
immediate.

https://bugzilla.gnome.org/show_bug.cgi?id=650675
This commit is contained in:
Samuel Degrande 2011-05-20 15:57:51 +02:00 committed by Emmanuele Bassi
parent 037138d3bf
commit 2544e87869

View File

@ -280,7 +280,13 @@ clutter_media_get_uri (ClutterMedia *media)
* @media: a #ClutterMedia
* @playing: %TRUE to start playing
*
* Starts or stops playing of @media.
* Starts or stops playing of @media.
* The implementation might be asynchronous, so the way to know whether
* the actual playing state of the @media is to use the #GObject::notify
* signal on the #ClutterMedia:playing property and then retrieve the
* current state with clutter_media_get_playing(). ClutterGstVideoTexture
* in clutter-gst is an example of such an asynchronous implementation.
*
* Since: 0.2
*/