streams: sprinkle some Since: markers for docs

This commit is contained in:
Tim-Philipp Müller 2016-06-30 15:07:28 +01:00
parent 715939cce7
commit 3623f168e9
8 changed files with 68 additions and 12 deletions

View file

@ -592,6 +592,8 @@ gst_event_parse_flush_stop (GstEvent * event, gboolean * reset_time)
* #GST_MESSSAGE_STREAM_COLLECTION. * #GST_MESSSAGE_STREAM_COLLECTION.
* *
* Returns: (transfer full): a new select-streams event. * Returns: (transfer full): a new select-streams event.
*
* Since: 1.10
*/ */
GstEvent * GstEvent *
gst_event_new_select_streams (GList * streams) gst_event_new_select_streams (GList * streams)
@ -624,6 +626,8 @@ gst_event_new_select_streams (GList * streams)
* @streams: (out) (element-type gchar) (transfer full): the streams * @streams: (out) (element-type gchar) (transfer full): the streams
* *
* Parse the SELECT_STREAMS event and retrieve the contained streams. * Parse the SELECT_STREAMS event and retrieve the contained streams.
*
* Since: 1.10
*/ */
void void
gst_event_parse_select_streams (GstEvent * event, GList ** streams) gst_event_parse_select_streams (GstEvent * event, GList ** streams)
@ -1586,7 +1590,9 @@ gst_event_parse_stream_start (GstEvent * event, const gchar ** stream_id)
* @stream: (transfer none): the stream object to set * @stream: (transfer none): the stream object to set
* *
* Set the @stream on the stream-start @event * Set the @stream on the stream-start @event
**/ *
* Since: 1.10
*/
void void
gst_event_set_stream (GstEvent * event, GstStream * stream) gst_event_set_stream (GstEvent * event, GstStream * stream)
{ {
@ -1604,7 +1610,9 @@ gst_event_set_stream (GstEvent * event, GstStream * stream)
* @stream: (out) (transfer full): adress of variable to store the stream * @stream: (out) (transfer full): adress of variable to store the stream
* *
* Parse a stream-start @event and extract the #GstStream from it. * Parse a stream-start @event and extract the #GstStream from it.
**/ *
* Since: 1.10
*/
void void
gst_event_parse_stream (GstEvent * event, GstStream ** stream) gst_event_parse_stream (GstEvent * event, GstStream ** stream)
{ {
@ -1720,6 +1728,8 @@ gst_event_parse_group_id (GstEvent * event, guint * group_id)
* data flow. * data flow.
* *
* Returns: (transfer full): the new STREAM_COLLECTION event. * Returns: (transfer full): the new STREAM_COLLECTION event.
*
* Since: 1.10
*/ */
GstEvent * GstEvent *
gst_event_new_stream_collection (GstStreamCollection * collection) gst_event_new_stream_collection (GstStreamCollection * collection)
@ -1735,6 +1745,15 @@ gst_event_new_stream_collection (GstStreamCollection * collection)
return gst_event_new_custom (GST_EVENT_STREAM_COLLECTION, s); return gst_event_new_custom (GST_EVENT_STREAM_COLLECTION, s);
} }
/**
* gst_event_parse_stream_collection:
* @event: a stream-collection event
* @collection: (out): pointer to store the collection
*
* Retrieve new #GstStreamCollection from STREAM_COLLECTION event @event.
*
* Since: 1.10
*/
void void
gst_event_parse_stream_collection (GstEvent * event, gst_event_parse_stream_collection (GstEvent * event,
GstStreamCollection ** collection) GstStreamCollection ** collection)

View file

@ -79,7 +79,7 @@ typedef enum {
* from the pipeline and unblock all streaming threads. * from the pipeline and unblock all streaming threads.
* @GST_EVENT_FLUSH_STOP: Stop a flush operation. This event resets the * @GST_EVENT_FLUSH_STOP: Stop a flush operation. This event resets the
* running-time of the pipeline. * running-time of the pipeline.
* @GST_EVENT_SELECT_STREAMS: A request to select one or more streams. * @GST_EVENT_SELECT_STREAMS: A request to select one or more streams (Since 1.10)
* @GST_EVENT_STREAM_START: Event to mark the start of a new stream. Sent before any * @GST_EVENT_STREAM_START: Event to mark the start of a new stream. Sent before any
* other serialized event and only sent at the start of a new stream, * other serialized event and only sent at the start of a new stream,
* not after flushing seeks. * not after flushing seeks.
@ -88,7 +88,7 @@ typedef enum {
* segment events contains information for clipping buffers and * segment events contains information for clipping buffers and
* converting buffer timestamps to running-time and * converting buffer timestamps to running-time and
* stream-time. * stream-time.
* @GST_EVENT_STREAM_COLLECTION: A new #GstStreamCollection is available. * @GST_EVENT_STREAM_COLLECTION: A new #GstStreamCollection is available (Since 1.10)
* @GST_EVENT_TAG: A new set of metadata tags has been found in the stream. * @GST_EVENT_TAG: A new set of metadata tags has been found in the stream.
* @GST_EVENT_BUFFERSIZE: Notification of buffering requirements. Currently not * @GST_EVENT_BUFFERSIZE: Notification of buffering requirements. Currently not
* used yet. * used yet.

View file

@ -2536,7 +2536,7 @@ gst_message_parse_property_notify (GstMessage * message, GstObject ** object,
* *
* Returns: a newly allocated #GstMessage * Returns: a newly allocated #GstMessage
* *
* Since: 1.x * Since: 1.10
*/ */
GstMessage * GstMessage *
gst_message_new_stream_collection (GstObject * src, gst_message_new_stream_collection (GstObject * src,
@ -2565,7 +2565,7 @@ gst_message_new_stream_collection (GstObject * src,
* *
* Parses a stream-collection message. * Parses a stream-collection message.
* *
* Since: 1.x * Since: 1.10
*/ */
void void
gst_message_parse_stream_collection (GstMessage * message, gst_message_parse_stream_collection (GstMessage * message,
@ -2598,7 +2598,7 @@ gst_message_parse_stream_collection (GstMessage * message,
* *
* Returns: a newly allocated #GstMessage * Returns: a newly allocated #GstMessage
* *
* Since: 1.x * Since: 1.10
*/ */
GstMessage * GstMessage *
gst_message_new_streams_selected (GstObject * src, gst_message_new_streams_selected (GstObject * src,
@ -2629,6 +2629,8 @@ gst_message_new_streams_selected (GstObject * src,
* Returns the number of streams contained in the @message. * Returns the number of streams contained in the @message.
* *
* Returns: The number of streams contained within. * Returns: The number of streams contained within.
*
* Since: 1.10
*/ */
guint guint
gst_message_streams_selected_get_size (GstMessage * msg) gst_message_streams_selected_get_size (GstMessage * msg)
@ -2651,6 +2653,8 @@ gst_message_streams_selected_get_size (GstMessage * msg)
* @stream: (transfer none): a #GstStream to add to @message * @stream: (transfer none): a #GstStream to add to @message
* *
* Adds the @stream to the @message. * Adds the @stream to the @message.
*
* Since: 1.10
*/ */
void void
gst_message_streams_selected_add (GstMessage * msg, GstStream * stream) gst_message_streams_selected_add (GstMessage * msg, GstStream * stream)
@ -2678,6 +2682,8 @@ gst_message_streams_selected_add (GstMessage * msg, GstStream * stream)
* Retrieves the #GstStream with index @index from the @message. * Retrieves the #GstStream with index @index from the @message.
* *
* Returns: (transfer full): A #GstStream * Returns: (transfer full): A #GstStream
*
* Since: 1.10
*/ */
GstStream * GstStream *
gst_message_streams_selected_get_stream (GstMessage * msg, guint idx) gst_message_streams_selected_get_stream (GstMessage * msg, guint idx)
@ -2707,7 +2713,7 @@ gst_message_streams_selected_get_stream (GstMessage * msg, guint idx)
* *
* Parses a streams-selected message. * Parses a streams-selected message.
* *
* Since: 1.x * Since: 1.10
*/ */
void void
gst_message_parse_streams_selected (GstMessage * message, gst_message_parse_streams_selected (GstMessage * message,

View file

@ -111,9 +111,9 @@ typedef struct _GstMessage GstMessage;
* @GST_MESSAGE_PROPERTY_NOTIFY: Message indicating a #GObject property has * @GST_MESSAGE_PROPERTY_NOTIFY: Message indicating a #GObject property has
* changed (Since 1.10) * changed (Since 1.10)
* @GST_MESSAGE_STREAM_COLLECTION: Message indicating a new #GstStreamCollection * @GST_MESSAGE_STREAM_COLLECTION: Message indicating a new #GstStreamCollection
* is available. * is available (Since 1.10)
* @GST_MESSAGE_STREAMS_SELECTED: Message indicating the active selection of * @GST_MESSAGE_STREAMS_SELECTED: Message indicating the active selection of
* #GstStreams has changed. * #GstStreams has changed (Since 1.10)
* @GST_MESSAGE_ANY: mask for all of the above messages. * @GST_MESSAGE_ANY: mask for all of the above messages.
* *
* The different message types that are available. * The different message types that are available.

View file

@ -28,6 +28,7 @@
* SECTION:gststreamcollection * SECTION:gststreamcollection
* @short_description: Base class for collection of streams * @short_description: Base class for collection of streams
* *
* Since: 1.10
*/ */
#include "gst_private.h" #include "gst_private.h"
@ -171,6 +172,8 @@ gst_stream_collection_dispose (GObject * object)
* Create a new #GstStreamCollection. * Create a new #GstStreamCollection.
* *
* Returns: The new #GstStreamCollection. * Returns: The new #GstStreamCollection.
*
* Since: 1.10
*/ */
GstStreamCollection * GstStreamCollection *
gst_stream_collection_new (const gchar * upstream_id) gst_stream_collection_new (const gchar * upstream_id)
@ -201,6 +204,8 @@ gst_stream_collection_set_upstream_id (GstStreamCollection * collection,
* Returns the upstream id of the @collection. * Returns the upstream id of the @collection.
* *
* Returns: (transfer none): The upstream id * Returns: (transfer none): The upstream id
*
* Since: 1.10
*/ */
const gchar * const gchar *
gst_stream_collection_get_upstream_id (GstStreamCollection * collection) gst_stream_collection_get_upstream_id (GstStreamCollection * collection)
@ -268,6 +273,8 @@ proxy_stream_notify_cb (GstStream * stream, GParamSpec * pspec,
* Add the given @stream to the @collection. * Add the given @stream to the @collection.
* *
* Returns: %TRUE if the @stream was properly added, else %FALSE * Returns: %TRUE if the @stream was properly added, else %FALSE
*
* Since: 1.10
*/ */
gboolean gboolean
gst_stream_collection_add_stream (GstStreamCollection * collection, gst_stream_collection_add_stream (GstStreamCollection * collection,
@ -293,6 +300,8 @@ gst_stream_collection_add_stream (GstStreamCollection * collection,
* Get the number of streams this collection contains * Get the number of streams this collection contains
* *
* Returns: The number of streams that @collection contains * Returns: The number of streams that @collection contains
*
* Since: 1.10
*/ */
guint guint
gst_stream_collection_get_size (GstStreamCollection * collection) gst_stream_collection_get_size (GstStreamCollection * collection)
@ -313,6 +322,8 @@ gst_stream_collection_get_size (GstStreamCollection * collection)
* The caller should not modify the returned #GstStream * The caller should not modify the returned #GstStream
* *
* Returns: (transfer none): A #GstStream * Returns: (transfer none): A #GstStream
*
* Since: 1.10
*/ */
GstStream * GstStream *
gst_stream_collection_get_stream (GstStreamCollection * collection, guint index) gst_stream_collection_get_stream (GstStreamCollection * collection, guint index)

View file

@ -41,6 +41,7 @@ G_BEGIN_DECLS
typedef struct _GstStreamCollection GstStreamCollection; typedef struct _GstStreamCollection GstStreamCollection;
typedef struct _GstStreamCollectionClass GstStreamCollectionClass; typedef struct _GstStreamCollectionClass GstStreamCollectionClass;
typedef struct _GstStreamCollectionPrivate GstStreamCollectionPrivate; typedef struct _GstStreamCollectionPrivate GstStreamCollectionPrivate;
/** /**
* GstStreamCollection: * GstStreamCollection:
* *
@ -61,6 +62,7 @@ typedef struct _GstStreamCollectionPrivate GstStreamCollectionPrivate;
* Applications can activate streams from a collection by using the * Applications can activate streams from a collection by using the
* #GST_EVENT_SELECT_STREAMS event on a pipeline, bin or element. * #GST_EVENT_SELECT_STREAMS event on a pipeline, bin or element.
* *
* Since: 1.10
*/ */
struct _GstStreamCollection { struct _GstStreamCollection {
GstObject object; GstObject object;
@ -99,7 +101,7 @@ guint gst_stream_collection_get_size (GstStreamCollection *collection);
GstStream *gst_stream_collection_get_stream (GstStreamCollection *collection, guint index); GstStream *gst_stream_collection_get_stream (GstStreamCollection *collection, guint index);
gboolean gst_stream_collection_add_stream (GstStreamCollection *collection, gboolean gst_stream_collection_add_stream (GstStreamCollection *collection,
GstStream *stream); GstStream *stream);
G_END_DECLS G_END_DECLS

View file

@ -41,6 +41,8 @@
* Elements that do not modify the nature of the stream can add extra information * Elements that do not modify the nature of the stream can add extra information
* on it (such as enrich the #GstCaps, or #GstTagList). This is typically done * on it (such as enrich the #GstCaps, or #GstTagList). This is typically done
* by parsing elements. * by parsing elements.
*
* Since: 1.10
*/ */
#include "gst_private.h" #include "gst_private.h"
@ -208,6 +210,8 @@ gst_stream_finalize (GObject * object)
* and @flags * and @flags
* *
* Returns: The new #GstStream * Returns: The new #GstStream
*
* Since: 1.10
*/ */
GstStream * GstStream *
gst_stream_new (const gchar * stream_id, GstCaps * caps, GstStreamType type, gst_stream_new (const gchar * stream_id, GstCaps * caps, GstStreamType type,
@ -244,6 +248,8 @@ gst_stream_set_stream_id (GstStream * stream, const gchar * stream_id)
* *
* Returns: (transfer none) (nullable): the stream ID of @stream. Only valid * Returns: (transfer none) (nullable): the stream ID of @stream. Only valid
* during the lifetime of @stream. * during the lifetime of @stream.
*
* Since: 1.10
*/ */
const gchar * const gchar *
gst_stream_get_stream_id (GstStream * stream) gst_stream_get_stream_id (GstStream * stream)
@ -257,6 +263,8 @@ gst_stream_get_stream_id (GstStream * stream)
* @flags: the flags to set on @stream * @flags: the flags to set on @stream
* *
* Set the @flags for the @stream. * Set the @flags for the @stream.
*
* Since: 1.10
*/ */
void void
gst_stream_set_stream_flags (GstStream * stream, GstStreamFlags flags) gst_stream_set_stream_flags (GstStream * stream, GstStreamFlags flags)
@ -277,6 +285,7 @@ gst_stream_set_stream_flags (GstStream * stream, GstStreamFlags flags)
* *
* Returns: The #GstStreamFlags for @stream * Returns: The #GstStreamFlags for @stream
* *
* Since: 1.10
*/ */
GstStreamFlags GstStreamFlags
gst_stream_get_stream_flags (GstStream * stream) gst_stream_get_stream_flags (GstStream * stream)
@ -296,6 +305,8 @@ gst_stream_get_stream_flags (GstStream * stream)
* @stream_type: the type to set on @stream * @stream_type: the type to set on @stream
* *
* Set the stream type of @stream * Set the stream type of @stream
*
* Since: 1.10
*/ */
void void
gst_stream_set_stream_type (GstStream * stream, GstStreamType stream_type) gst_stream_set_stream_type (GstStream * stream, GstStreamType stream_type)
@ -316,6 +327,7 @@ gst_stream_set_stream_type (GstStream * stream, GstStreamType stream_type)
* *
* Returns: The #GstStreamType for @stream * Returns: The #GstStreamType for @stream
* *
* Since: 1.10
*/ */
GstStreamType GstStreamType
gst_stream_get_stream_type (GstStream * stream) gst_stream_get_stream_type (GstStream * stream)
@ -336,6 +348,7 @@ gst_stream_get_stream_type (GstStream * stream)
* *
* Set the tags for the #GstStream * Set the tags for the #GstStream
* *
* Since: 1.10
*/ */
void void
gst_stream_set_tags (GstStream * stream, GstTagList * tags) gst_stream_set_tags (GstStream * stream, GstTagList * tags)
@ -355,6 +368,7 @@ gst_stream_set_tags (GstStream * stream, GstTagList * tags)
* *
* Returns: (transfer full) (nullable): The #GstTagList for @stream * Returns: (transfer full) (nullable): The #GstTagList for @stream
* *
* Since: 1.10
*/ */
GstTagList * GstTagList *
gst_stream_get_tags (GstStream * stream) gst_stream_get_tags (GstStream * stream)
@ -376,6 +390,7 @@ gst_stream_get_tags (GstStream * stream)
* *
* Set the caps for the #GstStream * Set the caps for the #GstStream
* *
* Since: 1.10
*/ */
void void
gst_stream_set_caps (GstStream * stream, GstCaps * caps) gst_stream_set_caps (GstStream * stream, GstCaps * caps)
@ -403,6 +418,7 @@ gst_stream_set_caps (GstStream * stream, GstCaps * caps)
* *
* Returns: (transfer full) (nullable): The #GstCaps for @stream * Returns: (transfer full) (nullable): The #GstCaps for @stream
* *
* Since: 1.10
*/ */
GstCaps * GstCaps *
gst_stream_get_caps (GstStream * stream) gst_stream_get_caps (GstStream * stream)
@ -494,6 +510,8 @@ gst_stream_get_property (GObject * object, guint prop_id,
* Get a descriptive string for a given #GstStreamType * Get a descriptive string for a given #GstStreamType
* *
* Returns: A string describing the stream type * Returns: A string describing the stream type
*
* Since: 1.10
*/ */
const gchar * const gchar *
gst_stream_type_get_name (GstStreamType stype) gst_stream_type_get_name (GstStreamType stype)

View file

@ -4006,7 +4006,7 @@ gst_pad_get_stream_id (GstPad * pad)
* Returns: (nullable) (transfer full): the current #GstStream for @pad, or %NULL. * Returns: (nullable) (transfer full): the current #GstStream for @pad, or %NULL.
* unref the returned stream when no longer needed. * unref the returned stream when no longer needed.
* *
* Since: 1.X * Since: 1.10
*/ */
GstStream * GstStream *
gst_pad_get_stream (GstPad * pad) gst_pad_get_stream (GstPad * pad)