Blame docs/gst/html/gstreamer-GstStream.html

Packit Service 963350
Packit Service 963350
<html>
Packit Service 963350
<head>
Packit Service 963350
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit Service 963350
<title>GstStreams: GStreamer 1.0 Core Reference Manual</title>
Packit Service 963350
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
Packit Service 963350
<link rel="home" href="index.html" title="GStreamer 1.0 Core Reference Manual">
Packit Service 963350
<link rel="up" href="libgstreamer.html" title="GStreamer Core Library">
Packit Service 963350
<link rel="prev" href="GstSegment.html" title="GstSegment">
Packit Service 963350
<link rel="next" href="gstreamer-GstStreamCollection.html" title="GstStreamCollection">
Packit Service 963350
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
Packit Service 963350
<link rel="stylesheet" href="style.css" type="text/css">
Packit Service 963350
</head>
Packit Service 963350
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit Service 963350
Packit Service 963350
Packit Service 963350
Top  | 
Packit Service 963350
                  Description
Packit Service 963350
Packit Service 963350
Home
Packit Service 963350
Up
Packit Service 963350
Prev
Packit Service 963350
Next
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

GstStreams

Packit Service 963350

GstStreams — Base class for stream objects

Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

Functions

Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
GstStream *
Packit Service 963350
Packit Service 963350
Packit Service 963350
gst_stream_new ()
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
GstCaps *
Packit Service 963350
Packit Service 963350
Packit Service 963350
gst_stream_get_caps ()
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
GstStreamFlags
Packit Service 963350
Packit Service 963350
Packit Service 963350
gst_stream_get_stream_flags ()
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
const gchar *
Packit Service 963350
Packit Service 963350
Packit Service 963350
gst_stream_get_stream_id ()
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
GstStreamType
Packit Service 963350
Packit Service 963350
Packit Service 963350
gst_stream_get_stream_type ()
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
GstTagList *
Packit Service 963350
Packit Service 963350
Packit Service 963350
gst_stream_get_tags ()
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
void
Packit Service 963350
Packit Service 963350
Packit Service 963350
gst_stream_set_caps ()
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
void
Packit Service 963350
Packit Service 963350
Packit Service 963350
gst_stream_set_stream_flags ()
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
void
Packit Service 963350
Packit Service 963350
Packit Service 963350
gst_stream_set_stream_type ()
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
void
Packit Service 963350
Packit Service 963350
Packit Service 963350
gst_stream_set_tags ()
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
const gchar *
Packit Service 963350
Packit Service 963350
Packit Service 963350
gst_stream_type_get_name ()
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

Types and Values

Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
struct
Packit Service 963350
GstStream
Packit Service 963350
Packit Service 963350
Packit Service 963350
struct
Packit Service 963350
GstStreamClass
Packit Service 963350
Packit Service 963350
Packit Service 963350
enum
Packit Service 963350
GstStreamType
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

Includes

Packit Service 963350
#include <gst/gstprotection.h>
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

Description

Packit Service 963350

A GstStream is a high-level object defining a stream of data which is, or

Packit Service 963350
can be, present in a GstPipeline.

Packit Service 963350

It is defined by a unique identifier, a "Stream ID". A GstStream does not

Packit Service 963350
automatically imply the stream is present within a pipeline or element.

Packit Service 963350

Any element that can introduce new streams in a pipeline should create the

Packit Service 963350
appropriate GstStream object, and can convey that object via the
Packit Service 963350
GST_EVENT_STREAM_START event and/or the GstStreamCollection.

Packit Service 963350

Elements that do not modify the nature of the stream can add extra information

Packit Service 963350
on it (such as enrich the GstCaps, or GstTagList). This is typically done
Packit Service 963350
by parsing elements.

Packit Service 963350
Packit Service 963350
Packit Service 963350

Functions

Packit Service 963350
Packit Service 963350

gst_stream_new ()

Packit Service 963350
GstStream *
Packit Service 963350
gst_stream_new (const gchar *stream_id,
Packit Service 963350
                GstCaps *caps,
Packit Service 963350
                GstStreamType type,
Packit Service 963350
                GstStreamFlags flags);
Packit Service 963350

Create a new GstStream for the given stream_id

Packit Service 963350
, caps
Packit Service 963350
, type
Packit Service 963350
Packit Service 963350
and flags
Packit Service 963350

Packit Service 963350
Packit Service 963350

Parameters

Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

stream_id

Packit Service 963350

the id for the new stream. If NULL,

Packit Service 963350
a new one will be automatically generated. 

Packit Service 963350
[allow-none]
Packit Service 963350
Packit Service 963350
Packit Service 963350

caps

Packit Service 963350

the GstCaps of the stream.

Packit Service 963350
[allow-none][transfer none]
Packit Service 963350
Packit Service 963350
Packit Service 963350

type

Packit Service 963350

the GstStreamType of the stream

Packit Service 963350
 
Packit Service 963350
Packit Service 963350
Packit Service 963350

flags

Packit Service 963350

the GstStreamFlags of the stream

Packit Service 963350
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

Returns

Packit Service 963350

The new GstStream.

Packit Service 963350

[transfer full]

Packit Service 963350
Packit Service 963350

Since: 1.10

Packit Service 963350
Packit Service 963350

Packit Service 963350
Packit Service 963350

gst_stream_get_caps ()

Packit Service 963350
GstCaps *
Packit Service 963350
gst_stream_get_caps (GstStream *stream);
Packit Service 963350

Retrieve the caps for stream

Packit Service 963350
, if any

Packit Service 963350
Packit Service 963350

Parameters

Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

stream

Packit Service 963350

a GstStream

Packit Service 963350
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

Returns

Packit Service 963350

The GstCaps for stream

Packit Service 963350
. 

Packit Service 963350

[transfer full][nullable]

Packit Service 963350
Packit Service 963350

Since: 1.10

Packit Service 963350
Packit Service 963350

Packit Service 963350
Packit Service 963350

gst_stream_get_stream_flags ()

Packit Service 963350
GstStreamFlags
Packit Service 963350
gst_stream_get_stream_flags (GstStream *stream);
Packit Service 963350

Retrieve the current stream flags for stream

Packit Service 963350

Packit Service 963350
Packit Service 963350

Parameters

Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

stream

Packit Service 963350

a GstStream

Packit Service 963350
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

Returns

Packit Service 963350

The GstStreamFlags for stream

Packit Service 963350

Packit Service 963350
Packit Service 963350

Since: 1.10

Packit Service 963350
Packit Service 963350

Packit Service 963350
Packit Service 963350

gst_stream_get_stream_id ()

Packit Service 963350
const gchar *
Packit Service 963350
gst_stream_get_stream_id (GstStream *stream);
Packit Service 963350

Returns the stream ID of stream

Packit Service 963350
.

Packit Service 963350
Packit Service 963350

Parameters

Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

stream

Packit Service 963350

a GstStream

Packit Service 963350
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

Returns

Packit Service 963350

the stream ID of stream

Packit Service 963350
. Only valid
Packit Service 963350
during the lifetime of stream
Packit Service 963350
. 

Packit Service 963350

[transfer none][nullable]

Packit Service 963350
Packit Service 963350

Since: 1.10

Packit Service 963350
Packit Service 963350

Packit Service 963350
Packit Service 963350

gst_stream_get_stream_type ()

Packit Service 963350
GstStreamType
Packit Service 963350
gst_stream_get_stream_type (GstStream *stream);
Packit Service 963350

Retrieve the stream type for stream

Packit Service 963350

Packit Service 963350
Packit Service 963350

Parameters

Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

stream

Packit Service 963350

a GstStream

Packit Service 963350
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

Returns

Packit Service 963350

The GstStreamType for stream

Packit Service 963350

Packit Service 963350
Packit Service 963350

Since: 1.10

Packit Service 963350
Packit Service 963350

Packit Service 963350
Packit Service 963350

gst_stream_get_tags ()

Packit Service 963350
GstTagList *
Packit Service 963350
gst_stream_get_tags (GstStream *stream);
Packit Service 963350

Retrieve the tags for stream

Packit Service 963350
, if any

Packit Service 963350
Packit Service 963350

Parameters

Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

stream

Packit Service 963350

a GstStream

Packit Service 963350
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

Returns

Packit Service 963350

The GstTagList for stream

Packit Service 963350
. 

Packit Service 963350

[transfer full][nullable]

Packit Service 963350
Packit Service 963350

Since: 1.10

Packit Service 963350
Packit Service 963350

Packit Service 963350
Packit Service 963350

gst_stream_set_caps ()

Packit Service 963350
void
Packit Service 963350
gst_stream_set_caps (GstStream *stream,
Packit Service 963350
                     GstCaps *caps);
Packit Service 963350

Set the caps for the GstStream

Packit Service 963350
Packit Service 963350

Parameters

Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

stream

Packit Service 963350

a GstStream

Packit Service 963350
 
Packit Service 963350
Packit Service 963350
Packit Service 963350

caps

Packit Service 963350

a GstCaps.

Packit Service 963350
[transfer none][allow-none]
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

Since: 1.10

Packit Service 963350
Packit Service 963350

Packit Service 963350
Packit Service 963350

gst_stream_set_stream_flags ()

Packit Service 963350
void
Packit Service 963350
gst_stream_set_stream_flags (GstStream *stream,
Packit Service 963350
                             GstStreamFlags flags);
Packit Service 963350

Set the flags

Packit Service 963350
 for the stream
Packit Service 963350
.

Packit Service 963350
Packit Service 963350

Parameters

Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

stream

Packit Service 963350

a GstStream

Packit Service 963350
 
Packit Service 963350
Packit Service 963350
Packit Service 963350

flags

Packit Service 963350

the flags to set on stream

Packit Service 963350

Packit Service 963350
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

Since: 1.10

Packit Service 963350
Packit Service 963350

Packit Service 963350
Packit Service 963350

gst_stream_set_stream_type ()

Packit Service 963350
void
Packit Service 963350
gst_stream_set_stream_type (GstStream *stream,
Packit Service 963350
                            GstStreamType stream_type);
Packit Service 963350

Set the stream type of stream

Packit Service 963350

Packit Service 963350
Packit Service 963350

Parameters

Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

stream

Packit Service 963350

a GstStream

Packit Service 963350
 
Packit Service 963350
Packit Service 963350
Packit Service 963350

stream_type

Packit Service 963350

the type to set on stream

Packit Service 963350

Packit Service 963350
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

Since: 1.10

Packit Service 963350
Packit Service 963350

Packit Service 963350
Packit Service 963350

gst_stream_set_tags ()

Packit Service 963350
void
Packit Service 963350
gst_stream_set_tags (GstStream *stream,
Packit Service 963350
                     GstTagList *tags);
Packit Service 963350

Set the tags for the GstStream

Packit Service 963350
Packit Service 963350

Parameters

Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

stream

Packit Service 963350

a GstStream

Packit Service 963350
 
Packit Service 963350
Packit Service 963350
Packit Service 963350

tags

Packit Service 963350

a GstTagList.

Packit Service 963350
[transfer none][allow-none]
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

Since: 1.10

Packit Service 963350
Packit Service 963350

Packit Service 963350
Packit Service 963350

gst_stream_type_get_name ()

Packit Service 963350
const gchar *
Packit Service 963350
gst_stream_type_get_name (GstStreamType stype);
Packit Service 963350

Get a descriptive string for a given GstStreamType

Packit Service 963350
Packit Service 963350

Parameters

Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

stype

Packit Service 963350

a GstStreamType

Packit Service 963350
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

Returns

Packit Service 963350

A string describing the stream type.

Packit Service 963350

[nullable]

Packit Service 963350
Packit Service 963350

Since: 1.10

Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

Types and Values

Packit Service 963350
Packit Service 963350

struct GstStream

Packit Service 963350
struct GstStream {
Packit Service 963350
  const gchar *stream_id;
Packit Service 963350
};
Packit Service 963350
Packit Service 963350

A high-level object representing a single stream. It might be backed, or

Packit Service 963350
not, by an actual flow of data in a pipeline (GstPad).

Packit Service 963350

A GstStream does not care about data changes (such as decoding, encoding,

Packit Service 963350
parsing,...) as long as the underlying data flow corresponds to the same
Packit Service 963350
high-level flow (ex: a certain audio track).

Packit Service 963350

A GstStream contains all the information pertinent to a stream, such as

Packit Service 963350
stream-id, tags, caps, type, ...

Packit Service 963350

Elements can subclass a GstStream for internal usage (to contain information

Packit Service 963350
pertinent to streams of data).

Packit Service 963350
Packit Service 963350

Members

Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

const gchar *stream_id;

Packit Service 963350

The Stream Identifier for this GstStream

Packit Service 963350
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

Since: 1.10

Packit Service 963350
Packit Service 963350

Packit Service 963350
Packit Service 963350

struct GstStreamClass

Packit Service 963350
struct GstStreamClass {
Packit Service 963350
  GstObjectClass parent_class;
Packit Service 963350
};
Packit Service 963350
Packit Service 963350

GstStream class structure

Packit Service 963350
Packit Service 963350

Members

Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

Packit Service 963350
Packit Service 963350

enum GstStreamType

Packit Service 963350

GstStreamType describes a high level classification set for

Packit Service 963350
flows of data in GstStream objects.

Packit Service 963350

Note that this is a flag, and therefore users should not assume it

Packit Service 963350
will be a single value. Do not use the equality operator for checking
Packit Service 963350
whether a stream is of a certain type.

Packit Service 963350
Packit Service 963350

Members

Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

GST_STREAM_TYPE_UNKNOWN

Packit Service 963350
Packit Service 963350

The stream is of unknown (unclassified) type.

Packit Service 963350
Packit Service 963350
 
Packit Service 963350
Packit Service 963350
Packit Service 963350

GST_STREAM_TYPE_AUDIO

Packit Service 963350
Packit Service 963350

The stream is of audio data

Packit Service 963350
Packit Service 963350
 
Packit Service 963350
Packit Service 963350
Packit Service 963350

GST_STREAM_TYPE_VIDEO

Packit Service 963350
Packit Service 963350

The stream carries video data

Packit Service 963350
Packit Service 963350
 
Packit Service 963350
Packit Service 963350
Packit Service 963350

GST_STREAM_TYPE_CONTAINER

Packit Service 963350
Packit Service 963350

The stream is a muxed container type

Packit Service 963350
Packit Service 963350
 
Packit Service 963350
Packit Service 963350
Packit Service 963350

GST_STREAM_TYPE_TEXT

Packit Service 963350
Packit Service 963350

The stream contains subtitle / subpicture data.

Packit Service 963350
Packit Service 963350
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

Since: 1.10

Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

Generated by GTK-Doc V1.27
Packit Service 963350
</body>
Packit Service 963350
</html>