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

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

GstStreams

Packit a6ee4b

GstStreams — Base class for stream objects

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Functions

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

Types and Values

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
struct
Packit a6ee4b
GstStream
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
struct
Packit a6ee4b
GstStreamClass
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
enum
Packit a6ee4b
GstStreamType
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Includes

Packit a6ee4b
#include <gst/gst.h>
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Description

Packit a6ee4b

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

Packit a6ee4b
can be, present in a GstPipeline.

Packit a6ee4b

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

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

Packit a6ee4b

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

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

Packit a6ee4b

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

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

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Functions

Packit a6ee4b
Packit a6ee4b

gst_stream_new ()

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

Create a new GstStream for the given stream_id

Packit a6ee4b
, caps
Packit a6ee4b
, type
Packit a6ee4b
Packit a6ee4b
and flags
Packit a6ee4b

Packit a6ee4b
Packit a6ee4b

Parameters

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

stream_id

Packit a6ee4b

the id for the new stream. If NULL,

Packit a6ee4b
a new one will be automatically generated. 

Packit a6ee4b
[allow-none]
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

caps

Packit a6ee4b

the GstCaps of the stream.

Packit a6ee4b
[allow-none][transfer none]
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

type

Packit a6ee4b

the GstStreamType of the stream

Packit a6ee4b
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

flags

Packit a6ee4b

the GstStreamFlags of the stream

Packit a6ee4b
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Returns

Packit a6ee4b

The new GstStream.

Packit a6ee4b

[transfer full]

Packit a6ee4b
Packit a6ee4b

Since: 1.10

Packit a6ee4b
Packit a6ee4b

Packit a6ee4b
Packit a6ee4b

gst_stream_get_caps ()

Packit a6ee4b
GstCaps *
Packit a6ee4b
gst_stream_get_caps (GstStream *stream);
Packit a6ee4b

Retrieve the caps for stream

Packit a6ee4b
, if any

Packit a6ee4b
Packit a6ee4b

Parameters

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

stream

Packit a6ee4b

a GstStream

Packit a6ee4b
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Returns

Packit a6ee4b

The GstCaps for stream

Packit a6ee4b
. 

Packit a6ee4b

[transfer full][nullable]

Packit a6ee4b
Packit a6ee4b

Since: 1.10

Packit a6ee4b
Packit a6ee4b

Packit a6ee4b
Packit a6ee4b

gst_stream_get_stream_flags ()

Packit a6ee4b
GstStreamFlags
Packit a6ee4b
gst_stream_get_stream_flags (GstStream *stream);
Packit a6ee4b

Retrieve the current stream flags for stream

Packit a6ee4b

Packit a6ee4b
Packit a6ee4b

Parameters

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

stream

Packit a6ee4b

a GstStream

Packit a6ee4b
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Returns

Packit a6ee4b

The GstStreamFlags for stream

Packit a6ee4b

Packit a6ee4b
Packit a6ee4b

Since: 1.10

Packit a6ee4b
Packit a6ee4b

Packit a6ee4b
Packit a6ee4b

gst_stream_get_stream_id ()

Packit a6ee4b
const gchar *
Packit a6ee4b
gst_stream_get_stream_id (GstStream *stream);
Packit a6ee4b

Returns the stream ID of stream

Packit a6ee4b
.

Packit a6ee4b
Packit a6ee4b

Parameters

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

stream

Packit a6ee4b

a GstStream

Packit a6ee4b
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Returns

Packit a6ee4b

the stream ID of stream

Packit a6ee4b
. Only valid
Packit a6ee4b
during the lifetime of stream
Packit a6ee4b
. 

Packit a6ee4b

[transfer none][nullable]

Packit a6ee4b
Packit a6ee4b

Since: 1.10

Packit a6ee4b
Packit a6ee4b

Packit a6ee4b
Packit a6ee4b

gst_stream_get_stream_type ()

Packit a6ee4b
GstStreamType
Packit a6ee4b
gst_stream_get_stream_type (GstStream *stream);
Packit a6ee4b

Retrieve the stream type for stream

Packit a6ee4b

Packit a6ee4b
Packit a6ee4b

Parameters

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

stream

Packit a6ee4b

a GstStream

Packit a6ee4b
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Returns

Packit a6ee4b

The GstStreamType for stream

Packit a6ee4b

Packit a6ee4b
Packit a6ee4b

Since: 1.10

Packit a6ee4b
Packit a6ee4b

Packit a6ee4b
Packit a6ee4b

gst_stream_get_tags ()

Packit a6ee4b
GstTagList *
Packit a6ee4b
gst_stream_get_tags (GstStream *stream);
Packit a6ee4b

Retrieve the tags for stream

Packit a6ee4b
, if any

Packit a6ee4b
Packit a6ee4b

Parameters

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

stream

Packit a6ee4b

a GstStream

Packit a6ee4b
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Returns

Packit a6ee4b

The GstTagList for stream

Packit a6ee4b
. 

Packit a6ee4b

[transfer full][nullable]

Packit a6ee4b
Packit a6ee4b

Since: 1.10

Packit a6ee4b
Packit a6ee4b

Packit a6ee4b
Packit a6ee4b

gst_stream_set_caps ()

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

Set the caps for the GstStream

Packit a6ee4b
Packit a6ee4b

Parameters

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

stream

Packit a6ee4b

a GstStream

Packit a6ee4b
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

caps

Packit a6ee4b

a GstCaps.

Packit a6ee4b
[transfer none][allow-none]
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Since: 1.10

Packit a6ee4b
Packit a6ee4b

Packit a6ee4b
Packit a6ee4b

gst_stream_set_stream_flags ()

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

Set the flags

Packit a6ee4b
 for the stream
Packit a6ee4b
.

Packit a6ee4b
Packit a6ee4b

Parameters

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

stream

Packit a6ee4b

a GstStream

Packit a6ee4b
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

flags

Packit a6ee4b

the flags to set on stream

Packit a6ee4b

Packit a6ee4b
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Since: 1.10

Packit a6ee4b
Packit a6ee4b

Packit a6ee4b
Packit a6ee4b

gst_stream_set_stream_type ()

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

Set the stream type of stream

Packit a6ee4b

Packit a6ee4b
Packit a6ee4b

Parameters

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

stream

Packit a6ee4b

a GstStream

Packit a6ee4b
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

stream_type

Packit a6ee4b

the type to set on stream

Packit a6ee4b

Packit a6ee4b
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Since: 1.10

Packit a6ee4b
Packit a6ee4b

Packit a6ee4b
Packit a6ee4b

gst_stream_set_tags ()

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

Set the tags for the GstStream

Packit a6ee4b
Packit a6ee4b

Parameters

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

stream

Packit a6ee4b

a GstStream

Packit a6ee4b
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

tags

Packit a6ee4b

a GstTagList.

Packit a6ee4b
[transfer none][allow-none]
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Since: 1.10

Packit a6ee4b
Packit a6ee4b

Packit a6ee4b
Packit a6ee4b

gst_stream_type_get_name ()

Packit a6ee4b
const gchar *
Packit a6ee4b
gst_stream_type_get_name (GstStreamType stype);
Packit a6ee4b

Get a descriptive string for a given GstStreamType

Packit a6ee4b
Packit a6ee4b

Parameters

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

stype

Packit a6ee4b

a GstStreamType

Packit a6ee4b
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Returns

Packit a6ee4b

A string describing the stream type.

Packit a6ee4b

[nullable]

Packit a6ee4b
Packit a6ee4b

Since: 1.10

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Types and Values

Packit a6ee4b
Packit a6ee4b

struct GstStream

Packit a6ee4b
struct GstStream {
Packit a6ee4b
  const gchar *stream_id;
Packit a6ee4b
};
Packit a6ee4b
Packit a6ee4b

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

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

Packit a6ee4b

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

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

Packit a6ee4b

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

Packit a6ee4b
stream-id, tags, caps, type, ...

Packit a6ee4b

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

Packit a6ee4b
pertinent to streams of data).

Packit a6ee4b
Packit a6ee4b

Members

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

const gchar *stream_id;

Packit a6ee4b

The Stream Identifier for this GstStream

Packit a6ee4b
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Since: 1.10

Packit a6ee4b
Packit a6ee4b

Packit a6ee4b
Packit a6ee4b

struct GstStreamClass

Packit a6ee4b
struct GstStreamClass {
Packit a6ee4b
  GstObjectClass parent_class;
Packit a6ee4b
};
Packit a6ee4b
Packit a6ee4b

GstStream class structure

Packit a6ee4b
Packit a6ee4b

Members

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Packit a6ee4b
Packit a6ee4b

enum GstStreamType

Packit a6ee4b

GstStreamType describes a high level classification set for

Packit a6ee4b
flows of data in GstStream objects.

Packit a6ee4b

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

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

Packit a6ee4b
Packit a6ee4b

Members

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

GST_STREAM_TYPE_UNKNOWN

Packit a6ee4b
Packit a6ee4b

The stream is of unknown (unclassified) type.

Packit a6ee4b
Packit a6ee4b
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

GST_STREAM_TYPE_AUDIO

Packit a6ee4b
Packit a6ee4b

The stream is of audio data

Packit a6ee4b
Packit a6ee4b
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

GST_STREAM_TYPE_VIDEO

Packit a6ee4b
Packit a6ee4b

The stream carries video data

Packit a6ee4b
Packit a6ee4b
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

GST_STREAM_TYPE_CONTAINER

Packit a6ee4b
Packit a6ee4b

The stream is a muxed container type

Packit a6ee4b
Packit a6ee4b
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

GST_STREAM_TYPE_TEXT

Packit a6ee4b
Packit a6ee4b

The stream contains subtitle / subpicture data.

Packit a6ee4b
Packit a6ee4b
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Since: 1.10

Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b

Generated by GTK-Doc V1.28
Packit a6ee4b
</body>
Packit a6ee4b
</html>