mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-01-11 09:55:36 +00:00
Code Issues 1 Projects Releases Wiki Activity

gstpromise: add since 1.14 markers

Browse source
This commit is contained in:
Matthew Waters 2018-02-02 00:24:20 +11:00
parent d9ed750fbd
commit 442aca430a
2 changed files with 24 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
gst/gstpromise.c
View file

@ -104,6 +104,8 @@ typedef struct
* immediately with the current result. * immediately with the current result.
* *
* Returns: the result of the promise * Returns: the result of the promise
*
* Since: 1.14
*/ */
GstPromiseResult GstPromiseResult
gst_promise_wait (GstPromise * promise) gst_promise_wait (GstPromise * promise)
@ -134,6 +136,8 @@ gst_promise_wait (GstPromise * promise)
* *
* Set a reply on @promise. This will wake up any waiters with * Set a reply on @promise. This will wake up any waiters with
* %GST_PROMISE_RESULT_REPLIED. * %GST_PROMISE_RESULT_REPLIED.
*
* Since: 1.14
*/ */
void void
gst_promise_reply (GstPromise * promise, GstStructure * s) gst_promise_reply (GstPromise * promise, GstStructure * s)
@ -196,6 +200,8 @@ gst_promise_reply (GstPromise * promise, GstStructure * s)
* %GST_PROMISE_RESULT_REPLIED and is owned by @promise * %GST_PROMISE_RESULT_REPLIED and is owned by @promise
* *
* Returns: (transfer none): The reply set on @promise * Returns: (transfer none): The reply set on @promise
*
* Since: 1.14
*/ */
const GstStructure * const GstStructure *
gst_promise_get_reply (GstPromise * promise) gst_promise_get_reply (GstPromise * promise)
@ -220,6 +226,8 @@ gst_promise_get_reply (GstPromise * promise)
* *
* Interrupt waiting for a @promise. This will wake up any waiters with * Interrupt waiting for a @promise. This will wake up any waiters with
* %GST_PROMISE_RESULT_INTERRUPTED * %GST_PROMISE_RESULT_INTERRUPTED
*
* Since: 1.14
*/ */
void void
gst_promise_interrupt (GstPromise * promise) gst_promise_interrupt (GstPromise * promise)
@ -258,6 +266,8 @@ gst_promise_interrupt (GstPromise * promise)
* *
* Expire a @promise. This will wake up any waiters with * Expire a @promise. This will wake up any waiters with
* %GST_PROMISE_RESULT_EXPIRED * %GST_PROMISE_RESULT_EXPIRED
*
* Since: 1.14
*/ */
void void
gst_promise_expire (GstPromise * promise) gst_promise_expire (GstPromise * promise)
@ -329,6 +339,8 @@ gst_promise_init (GstPromise * promise)
* gst_promise_new: * gst_promise_new:
* *
* Returns: a new #GstPromise * Returns: a new #GstPromise
*
* Since: 1.14
*/ */
GstPromise * GstPromise *
gst_promise_new (void) gst_promise_new (void)
@ -352,6 +364,8 @@ gst_promise_new (void)
* states. * states.
* *
* Returns: a new #GstPromise * Returns: a new #GstPromise
*
* Since: 1.14
*/ */
GstPromise * GstPromise *
gst_promise_new_with_change_func (GstPromiseChangeFunc func, gpointer user_data, gst_promise_new_with_change_func (GstPromiseChangeFunc func, gpointer user_data,

10
gst/gstpromise.h
View file

@ -42,6 +42,8 @@ typedef struct _GstPromise GstPromise;
* lost all refs) and the promise will never be fulfilled. * lost all refs) and the promise will never be fulfilled.
* *
* The result of a #GstPromise * The result of a #GstPromise
*
* Since: 1.14
*/ */
typedef enum typedef enum
{ {
@ -55,12 +57,16 @@ typedef enum
* GstPromiseChangeFunc: * GstPromiseChangeFunc:
* @promise: a #GstPromise * @promise: a #GstPromise
* @user_data: (closure): user data * @user_data: (closure): user data
*
* Since: 1.14
*/ */
typedef void (*GstPromiseChangeFunc) (GstPromise * promise, gpointer user_data); typedef void (*GstPromiseChangeFunc) (GstPromise * promise, gpointer user_data);
/** /**
* GstPromise: * GstPromise:
* @parent: parent #GstMiniObject * @parent: parent #GstMiniObject
*
* Since: 1.14
*/ */
struct _GstPromise struct _GstPromise
{ {
@ -94,6 +100,8 @@ const GstStructure * gst_promise_get_reply (GstPromise * promis
* Increases the refcount of the given @promise by one. * Increases the refcount of the given @promise by one.
* *
* Returns: (transfer full): @promise * Returns: (transfer full): @promise
*
* Since: 1.14
*/ */
static inline GstPromise * static inline GstPromise *
gst_promise_ref (GstPromise * promise) gst_promise_ref (GstPromise * promise)
@ -107,6 +115,8 @@ gst_promise_ref (GstPromise * promise)
* *
* Decreases the refcount of the promise. If the refcount reaches 0, the * Decreases the refcount of the promise. If the refcount reaches 0, the
* promise will be freed. * promise will be freed.
*
* Since: 1.14
*/ */
static inline void static inline void
gst_promise_unref (GstPromise * promise) gst_promise_unref (GstPromise * promise)