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

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

GstStreams

Packit f546b1

GstStreams — Base class for stream objects

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Functions

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

Types and Values

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
struct
Packit f546b1
GstStream
Packit f546b1
Packit f546b1
Packit f546b1
struct
Packit f546b1
GstStreamClass
Packit f546b1
Packit f546b1
Packit f546b1
enum
Packit f546b1
GstStreamType
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Includes

Packit f546b1
#include <gst/gstprotection.h>
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Description

Packit f546b1

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

Packit f546b1
can be, present in a GstPipeline.

Packit f546b1

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

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

Packit f546b1

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

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

Packit f546b1

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

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

Packit f546b1
Packit f546b1
Packit f546b1

Functions

Packit f546b1
Packit f546b1

gst_stream_new ()

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

Create a new GstStream for the given stream_id

Packit f546b1
, caps
Packit f546b1
, type
Packit f546b1
Packit f546b1
and flags
Packit f546b1

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

stream_id

Packit f546b1

the id for the new stream. If NULL,

Packit f546b1
a new one will be automatically generated. 

Packit f546b1
[allow-none]
Packit f546b1
Packit f546b1
Packit f546b1

caps

Packit f546b1

the GstCaps of the stream.

Packit f546b1
[allow-none][transfer none]
Packit f546b1
Packit f546b1
Packit f546b1

type

Packit f546b1

the GstStreamType of the stream

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

flags

Packit f546b1

the GstStreamFlags of the stream

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

The new GstStream.

Packit f546b1

[transfer full]

Packit f546b1
Packit f546b1

Since: 1.10

Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_stream_get_caps ()

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

Retrieve the caps for stream

Packit f546b1
, if any

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

stream

Packit f546b1

a GstStream

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

The GstCaps for stream

Packit f546b1
. 

Packit f546b1

[transfer full][nullable]

Packit f546b1
Packit f546b1

Since: 1.10

Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_stream_get_stream_flags ()

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

Retrieve the current stream flags for stream

Packit f546b1

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

stream

Packit f546b1

a GstStream

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

The GstStreamFlags for stream

Packit f546b1

Packit f546b1
Packit f546b1

Since: 1.10

Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_stream_get_stream_id ()

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

Returns the stream ID of stream

Packit f546b1
.

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

stream

Packit f546b1

a GstStream

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

the stream ID of stream

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

Packit f546b1

[transfer none][nullable]

Packit f546b1
Packit f546b1

Since: 1.10

Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_stream_get_stream_type ()

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

Retrieve the stream type for stream

Packit f546b1

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

stream

Packit f546b1

a GstStream

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

The GstStreamType for stream

Packit f546b1

Packit f546b1
Packit f546b1

Since: 1.10

Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_stream_get_tags ()

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

Retrieve the tags for stream

Packit f546b1
, if any

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

stream

Packit f546b1

a GstStream

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

The GstTagList for stream

Packit f546b1
. 

Packit f546b1

[transfer full][nullable]

Packit f546b1
Packit f546b1

Since: 1.10

Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_stream_set_caps ()

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

Set the caps for the GstStream

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

stream

Packit f546b1

a GstStream

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

caps

Packit f546b1

a GstCaps.

Packit f546b1
[transfer none][allow-none]
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Since: 1.10

Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_stream_set_stream_flags ()

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

Set the flags

Packit f546b1
 for the stream
Packit f546b1
.

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

stream

Packit f546b1

a GstStream

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

flags

Packit f546b1

the flags to set on stream

Packit f546b1

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Since: 1.10

Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_stream_set_stream_type ()

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

Set the stream type of stream

Packit f546b1

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

stream

Packit f546b1

a GstStream

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

stream_type

Packit f546b1

the type to set on stream

Packit f546b1

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Since: 1.10

Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_stream_set_tags ()

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

Set the tags for the GstStream

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

stream

Packit f546b1

a GstStream

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

tags

Packit f546b1

a GstTagList.

Packit f546b1
[transfer none][allow-none]
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Since: 1.10

Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_stream_type_get_name ()

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

Get a descriptive string for a given GstStreamType

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

stype

Packit f546b1

a GstStreamType

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

A string describing the stream type.

Packit f546b1

[nullable]

Packit f546b1
Packit f546b1

Since: 1.10

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Types and Values

Packit f546b1
Packit f546b1

struct GstStream

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

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

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

Packit f546b1

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

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

Packit f546b1

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

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

Packit f546b1

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

Packit f546b1
pertinent to streams of data).

Packit f546b1
Packit f546b1

Members

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

const gchar *stream_id;

Packit f546b1

The Stream Identifier for this GstStream

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Since: 1.10

Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

struct GstStreamClass

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

GstStream class structure

Packit f546b1
Packit f546b1

Members

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

enum GstStreamType

Packit f546b1

GstStreamType describes a high level classification set for

Packit f546b1
flows of data in GstStream objects.

Packit f546b1

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

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

Packit f546b1
Packit f546b1

Members

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

GST_STREAM_TYPE_UNKNOWN

Packit f546b1
Packit f546b1

The stream is of unknown (unclassified) type.

Packit f546b1
Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

GST_STREAM_TYPE_AUDIO

Packit f546b1
Packit f546b1

The stream is of audio data

Packit f546b1
Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

GST_STREAM_TYPE_VIDEO

Packit f546b1
Packit f546b1

The stream carries video data

Packit f546b1
Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

GST_STREAM_TYPE_CONTAINER

Packit f546b1
Packit f546b1

The stream is a muxed container type

Packit f546b1
Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

GST_STREAM_TYPE_TEXT

Packit f546b1
Packit f546b1

The stream contains subtitle / subpicture data.

Packit f546b1
Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Since: 1.10

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

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