Commit 24cac0af authored by Tim-Philipp Müller's avatar Tim-Philipp Müller 🐠

docs: more since markers and other docs fixes

parent ce770321
......@@ -49,6 +49,8 @@
* later an element is posting a GST_MESSAGE_NEED_CONTEXT message for a specific
* context that was created by an element before the application should pass it
* to the complete pipeline.
*
* Since: 1.2
*/
#include "gst_private.h"
......@@ -138,7 +140,7 @@ gst_context_init (GstContext * context)
*
* Returns: (transfer full): The new context.
*
* MT safe.
* Since: 1.2
*/
GstContext *
gst_context_new (void)
......@@ -169,7 +171,7 @@ gst_context_new (void)
* still owned by the context, which means that you should not modify it,
* free it and that the pointer becomes invalid when you free the context.
*
* MT safe.
* Since: 1.2
*/
const GstStructure *
gst_context_get_structure (GstContext * context)
......
......@@ -1639,12 +1639,14 @@ gst_event_parse_segment_done (GstEvent * event, GstFormat * format,
/**
* gst_event_new_context:
* @msg: (transfer full): the #GstContext
* @context: (transfer full): the #GstContext
*
* Create a new context event. The purpose of the context event is
* to pass a pipeline-local context to downstream elements.
*
* Returns: (transfer full): a new #GstEvent
*
* Since: 1.2
*/
GstEvent *
gst_event_new_context (GstContext * context)
......@@ -1670,6 +1672,8 @@ gst_event_new_context (GstContext * context)
* @context: (out) (transfer full): a pointer to store the #GstContext in.
*
* Parse the context event. Unref @context after usage.
*
* Since: 1.2
*/
void
gst_event_parse_context (GstEvent * event, GstContext ** context)
......
......@@ -99,6 +99,8 @@ typedef enum {
* @GST_EVENT_GAP: Marks a gap in the datastream.
* @GST_EVENT_TOC: An event which indicates that a new table of contents (TOC)
* was found or updated.
* @GST_EVENT_CONTEXT: An event to communicate a #GstContext to other
* elements (Since 1.2)
* @GST_EVENT_QOS: A quality message. Used to indicate to upstream elements
* that the downstream elements should adjust their processing
* rate.
......
......@@ -7,6 +7,7 @@ gstbuffer
gstbufferlist
gstbus
gstcaps
gstcapsfeatures
gstchildproxy
gstclock
gstcontroller
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment