docs: bus: mention main loop requirement in gst_bus_add_watch() docs
authorTim-Philipp Müller <tim@centricular.com>
Mon, 13 Jul 2015 13:24:34 +0000 (14:24 +0100)
committerTim-Philipp Müller <tim@centricular.com>
Mon, 13 Jul 2015 13:25:42 +0000 (14:25 +0100)
gst/gstbus.c

index fbe2464..9936290 100644 (file)
@@ -911,6 +911,8 @@ gst_bus_add_watch_full_unlocked (GstBus * bus, gint priority,
  * There can only be a single bus watch per bus, you must remove it before you
  * can set a new one.
  *
+ * The bus watch will only work if a GLib main loop is being run.
+ *
  * When @func is called, the message belongs to the caller; if you want to
  * keep a copy of it, call gst_message_ref() before leaving @func.
  *
@@ -953,6 +955,8 @@ gst_bus_add_watch_full (GstBus * bus, gint priority,
  * There can only be a single bus watch per bus, you must remove it before you
  * can set a new one.
  *
+ * The bus watch will only work if a GLib main loop is being run.
+ *
  * The watch can be removed using gst_bus_remove_watch() or by returning %FALSE
  * from @func. If the watch was added to the default main context it is also
  * possible to remove the watch using g_source_remove().