summaryrefslogtreecommitdiff
path: root/ext/gio/gstgiosink.c
diff options
context:
space:
mode:
authorSebastian Dröge <sebastian.droege@collabora.co.uk>2009-07-10 11:24:05 +0200
committerSebastian Dröge <sebastian.droege@collabora.co.uk>2009-07-10 11:24:05 +0200
commitd5154874cb1f884b9da4556640c2f951b0dc5fd6 (patch)
tree245dd257a78aa4a4791cbffbfef7906d09a39cd7 /ext/gio/gstgiosink.c
parentb9c79380aa07e3cf2c00a190bbbcb0b0c252df96 (diff)
downloadgstreamer-plugins-base-d5154874cb1f884b9da4556640c2f951b0dc5fd6.tar.gz
gio: Add documentation for the new "not-mounted" and "file-exists" messages
Diffstat (limited to 'ext/gio/gstgiosink.c')
-rw-r--r--ext/gio/gstgiosink.c12
1 files changed, 12 insertions, 0 deletions
diff --git a/ext/gio/gstgiosink.c b/ext/gio/gstgiosink.c
index 57d102494..a76b4b104 100644
--- a/ext/gio/gstgiosink.c
+++ b/ext/gio/gstgiosink.c
@@ -27,6 +27,18 @@
* by an URI. This location can be specified using any protocol supported by
* the GIO library or it's VFS backends. Common protocols are 'file', 'ftp',
* or 'smb'.
+ *
+ * If the URI or #GFile already exists giosink will post a message of
+ * type %GST_MESSAGE_ELEMENT with name "file-exists" on the bus. The message
+ * also contains the #GFile and the corresponding URI.
+ * Applications can use the "file-exists" message to notify the user about
+ * the problem and to set a different target location or to remove the
+ * existing file. Note that right after the "file-exists" message a normal
+ * error message is posted on the bus which should be ignored if "file-exists"
+ * is handled by the application, for example by calling
+ * gst_bus_set_flushing(bus, TRUE) after the "file-exists" message was
+ * received and gst_bus_set_flushing(bus, FALSE) after the problem is
+ * resolved.
*
* <refsect2>
* <title>Example pipelines</title>