summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMatthew Waters <matthew@centricular.com>2017-04-03 22:20:51 +1000
committerMatthew Waters <matthew@centricular.com>2017-11-23 00:48:30 +1100
commit86abf49c23c88bda209fec6fd964e482b36377d1 (patch)
treea4e4bf745006d492dc2f8f69f8358e5efdb21236 /docs
parent40c5396c244c4ffa39f209fd39c5723297235523 (diff)
gst: add a promise object
An object that can be waited on and asked for asynchronous values. In much the same way as promise/futures in js/java/etc A callback can be installed for when the promise changes state. Original idea by Jan Schmidt <jan@centricular.com> With contributions from Nirbheek Chauhan <nirbheek@centricular.com> Mathieu Duponchelle <mathieu@centricular.com> https://bugzilla.gnome.org/show_bug.cgi?id=789843
Diffstat (limited to 'docs')
-rw-r--r--docs/gst/gstreamer-docs.sgml1
-rw-r--r--docs/gst/gstreamer-sections.txt23
-rw-r--r--docs/gst/gstreamer.types.in2
3 files changed, 25 insertions, 1 deletions
diff --git a/docs/gst/gstreamer-docs.sgml b/docs/gst/gstreamer-docs.sgml
index 98dcd92e0..bf22b2a1a 100644
--- a/docs/gst/gstreamer-docs.sgml
+++ b/docs/gst/gstreamer-docs.sgml
@@ -96,6 +96,7 @@ Windows. It is released under the GNU Library General Public License
<xi:include href="xml/gstpluginfeature.xml" />
<xi:include href="xml/gstpoll.xml" />
<xi:include href="xml/gstpreset.xml" />
+ <xi:include href="xml/gstpromise.xml" />
<xi:include href="xml/gstprotection.xml" />
<xi:include href="xml/gstquery.xml" />
<xi:include href="xml/gstregistry.xml" />
diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt
index e86c0f3c0..e10544493 100644
--- a/docs/gst/gstreamer-sections.txt
+++ b/docs/gst/gstreamer-sections.txt
@@ -2678,6 +2678,29 @@ GstRegistryPrivate
<SECTION>
+<FILE>gstpromise</FILE>
+<TITLE>GstPromise</TITLE>
+GstPromiseResult
+GstPromiseChangeFunc
+GstPromise
+gst_promise_new
+gst_promise_new_with_change_func
+gst_promise_ref
+gst_promise_unref
+gst_promise_wait
+gst_promise_reply
+gst_promise_interrupt
+gst_promise_expire
+<SUBSECTION Standard>
+GST_PROMISE
+GST_TYPE_PROMISE
+gst_promise_get_type
+GST_TYPE_PROMISE_RESULT
+gst_promise_result_get_type
+</SECTION>
+
+
+<SECTION>
<FILE>gstsegment</FILE>
<TITLE>GstSegment</TITLE>
GstSegment
diff --git a/docs/gst/gstreamer.types.in b/docs/gst/gstreamer.types.in
index 8522c1e44..02895b6f0 100644
--- a/docs/gst/gstreamer.types.in
+++ b/docs/gst/gstreamer.types.in
@@ -26,6 +26,7 @@ gst_pad_template_get_type
gst_pipeline_get_type
gst_plugin_feature_get_type
gst_preset_get_type
+gst_promise_get_type
gst_registry_get_type
gst_system_clock_get_type
gst_tag_setter_get_type
@@ -48,4 +49,3 @@ gst_sample_get_type
gst_tag_list_get_type
gst_toc_get_type
gst_toc_entry_get_type
-