* #GST_MESSSAGE_STREAM_COLLECTION.
*
* Returns: (transfer full): a new select-streams event.
+ *
+ * Since: 1.10
*/
GstEvent *
gst_event_new_select_streams (GList * streams)
* @streams: (out) (element-type gchar) (transfer full): the streams
*
* Parse the SELECT_STREAMS event and retrieve the contained streams.
+ *
+ * Since: 1.10
*/
void
gst_event_parse_select_streams (GstEvent * event, GList ** streams)
* @stream: (transfer none): the stream object to set
*
* Set the @stream on the stream-start @event
- **/
+ *
+ * Since: 1.10
+ */
void
gst_event_set_stream (GstEvent * event, GstStream * stream)
{
* @stream: (out) (transfer full): adress of variable to store the stream
*
* Parse a stream-start @event and extract the #GstStream from it.
- **/
+ *
+ * Since: 1.10
+ */
void
gst_event_parse_stream (GstEvent * event, GstStream ** stream)
{
* data flow.
*
* Returns: (transfer full): the new STREAM_COLLECTION event.
+ *
+ * Since: 1.10
*/
GstEvent *
gst_event_new_stream_collection (GstStreamCollection * collection)
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
gst_event_parse_stream_collection (GstEvent * event,
GstStreamCollection ** collection)
* from the pipeline and unblock all streaming threads.
* @GST_EVENT_FLUSH_STOP: Stop a flush operation. This event resets the
* 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
* other serialized event and only sent at the start of a new stream,
* not after flushing seeks.
* segment events contains information for clipping buffers and
* converting buffer timestamps to running-time and
* 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_BUFFERSIZE: Notification of buffering requirements. Currently not
* used yet.
*
* Returns: a newly allocated #GstMessage
*
- * Since: 1.x
+ * Since: 1.10
*/
GstMessage *
gst_message_new_stream_collection (GstObject * src,
*
* Parses a stream-collection message.
*
- * Since: 1.x
+ * Since: 1.10
*/
void
gst_message_parse_stream_collection (GstMessage * message,
*
* Returns: a newly allocated #GstMessage
*
- * Since: 1.x
+ * Since: 1.10
*/
GstMessage *
gst_message_new_streams_selected (GstObject * src,
* Returns the number of streams contained in the @message.
*
* Returns: The number of streams contained within.
+ *
+ * Since: 1.10
*/
guint
gst_message_streams_selected_get_size (GstMessage * msg)
* @stream: (transfer none): a #GstStream to add to @message
*
* Adds the @stream to the @message.
+ *
+ * Since: 1.10
*/
void
gst_message_streams_selected_add (GstMessage * msg, GstStream * stream)
* Retrieves the #GstStream with index @index from the @message.
*
* Returns: (transfer full): A #GstStream
+ *
+ * Since: 1.10
*/
GstStream *
gst_message_streams_selected_get_stream (GstMessage * msg, guint idx)
*
* Parses a streams-selected message.
*
- * Since: 1.x
+ * Since: 1.10
*/
void
gst_message_parse_streams_selected (GstMessage * message,
* @GST_MESSAGE_PROPERTY_NOTIFY: Message indicating a #GObject property has
* changed (Since 1.10)
* @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
- * #GstStreams has changed.
+ * #GstStreams has changed (Since 1.10)
* @GST_MESSAGE_ANY: mask for all of the above messages.
*
* The different message types that are available.
* SECTION:gststreamcollection
* @short_description: Base class for collection of streams
*
+ * Since: 1.10
*/
#include "gst_private.h"
* Create a new #GstStreamCollection.
*
* Returns: The new #GstStreamCollection.
+ *
+ * Since: 1.10
*/
GstStreamCollection *
gst_stream_collection_new (const gchar * upstream_id)
* Returns the upstream id of the @collection.
*
* Returns: (transfer none): The upstream id
+ *
+ * Since: 1.10
*/
const gchar *
gst_stream_collection_get_upstream_id (GstStreamCollection * collection)
* Add the given @stream to the @collection.
*
* Returns: %TRUE if the @stream was properly added, else %FALSE
+ *
+ * Since: 1.10
*/
gboolean
gst_stream_collection_add_stream (GstStreamCollection * collection,
* Get the number of streams this collection contains
*
* Returns: The number of streams that @collection contains
+ *
+ * Since: 1.10
*/
guint
gst_stream_collection_get_size (GstStreamCollection * collection)
* The caller should not modify the returned #GstStream
*
* Returns: (transfer none): A #GstStream
+ *
+ * Since: 1.10
*/
GstStream *
gst_stream_collection_get_stream (GstStreamCollection * collection, guint index)
typedef struct _GstStreamCollection GstStreamCollection;
typedef struct _GstStreamCollectionClass GstStreamCollectionClass;
typedef struct _GstStreamCollectionPrivate GstStreamCollectionPrivate;
+
/**
* GstStreamCollection:
*
* Applications can activate streams from a collection by using the
* #GST_EVENT_SELECT_STREAMS event on a pipeline, bin or element.
*
+ * Since: 1.10
*/
struct _GstStreamCollection {
GstObject object;
GstStream *gst_stream_collection_get_stream (GstStreamCollection *collection, guint index);
gboolean gst_stream_collection_add_stream (GstStreamCollection *collection,
- GstStream *stream);
+ GstStream *stream);
G_END_DECLS
* 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
* by parsing elements.
+ *
+ * Since: 1.10
*/
#include "gst_private.h"
* and @flags
*
* Returns: The new #GstStream
+ *
+ * Since: 1.10
*/
GstStream *
gst_stream_new (const gchar * stream_id, GstCaps * caps, GstStreamType type,
*
* Returns: (transfer none) (nullable): the stream ID of @stream. Only valid
* during the lifetime of @stream.
+ *
+ * Since: 1.10
*/
const gchar *
gst_stream_get_stream_id (GstStream * stream)
* @flags: the flags to set on @stream
*
* Set the @flags for the @stream.
+ *
+ * Since: 1.10
*/
void
gst_stream_set_stream_flags (GstStream * stream, GstStreamFlags flags)
*
* Returns: The #GstStreamFlags for @stream
*
+ * Since: 1.10
*/
GstStreamFlags
gst_stream_get_stream_flags (GstStream * stream)
* @stream_type: the type to set on @stream
*
* Set the stream type of @stream
+ *
+ * Since: 1.10
*/
void
gst_stream_set_stream_type (GstStream * stream, GstStreamType stream_type)
*
* Returns: The #GstStreamType for @stream
*
+ * Since: 1.10
*/
GstStreamType
gst_stream_get_stream_type (GstStream * stream)
*
* Set the tags for the #GstStream
*
+ * Since: 1.10
*/
void
gst_stream_set_tags (GstStream * stream, GstTagList * tags)
*
* Returns: (transfer full) (nullable): The #GstTagList for @stream
*
+ * Since: 1.10
*/
GstTagList *
gst_stream_get_tags (GstStream * stream)
*
* Set the caps for the #GstStream
*
+ * Since: 1.10
*/
void
gst_stream_set_caps (GstStream * stream, GstCaps * caps)
*
* Returns: (transfer full) (nullable): The #GstCaps for @stream
*
+ * Since: 1.10
*/
GstCaps *
gst_stream_get_caps (GstStream * stream)
* Get a descriptive string for a given #GstStreamType
*
* Returns: A string describing the stream type
+ *
+ * Since: 1.10
*/
const gchar *
gst_stream_type_get_name (GstStreamType stype)
* Returns: (nullable) (transfer full): the current #GstStream for @pad, or %NULL.
* unref the returned stream when no longer needed.
*
- * Since: 1.X
+ * Since: 1.10
*/
GstStream *
gst_pad_get_stream (GstPad * pad)