Blame docs/gst/html/gstreamer-GstParse.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>GstParse: 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="gstreamer-GstParamSpec.html" title="GstParamSpec">
Packit f546b1
<link rel="next" href="GstPipeline.html" title="GstPipeline">
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
                  Object Hierarchy
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

GstParse

Packit f546b1

GstParse — Get a pipeline from a text pipeline description

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
GQuark
Packit f546b1
Packit f546b1
Packit f546b1
gst_parse_error_quark ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
GstElement *
Packit f546b1
Packit f546b1
Packit f546b1
gst_parse_launch ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
GstElement *
Packit f546b1
Packit f546b1
Packit f546b1
gst_parse_launch_full ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
GstElement *
Packit f546b1
Packit f546b1
Packit f546b1
gst_parse_launchv ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
GstElement *
Packit f546b1
Packit f546b1
Packit f546b1
gst_parse_launchv_full ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
GstElement *
Packit f546b1
Packit f546b1
Packit f546b1
gst_parse_bin_from_description ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
GstElement *
Packit f546b1
Packit f546b1
Packit f546b1
gst_parse_bin_from_description_full ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
GstParseContext *
Packit f546b1
Packit f546b1
Packit f546b1
gst_parse_context_new ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
GstParseContext *
Packit f546b1
Packit f546b1
Packit f546b1
gst_parse_context_copy ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
void
Packit f546b1
Packit f546b1
Packit f546b1
gst_parse_context_free ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
gchar **
Packit f546b1
Packit f546b1
Packit f546b1
gst_parse_context_get_missing_elements ()
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
#define
Packit f546b1
GST_PARSE_ERROR
Packit f546b1
Packit f546b1
Packit f546b1
enum
Packit f546b1
GstParseError
Packit f546b1
Packit f546b1
Packit f546b1
 
Packit f546b1
GstParseContext
Packit f546b1
Packit f546b1
Packit f546b1
enum
Packit f546b1
GstParseFlags
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Object Hierarchy

Packit f546b1
    GBoxed
Packit f546b1
    ╰── GstParseContext
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Includes

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

Description

Packit f546b1

These function allow to create a pipeline based on the syntax used in the

Packit f546b1
gst-launch-1.0 utility (see man-page for syntax documentation).

Packit f546b1

Please note that these functions take several measures to create

Packit f546b1
somewhat dynamic pipelines. Due to that such pipelines are not always
Packit f546b1
reusable (set the state to NULL and back to PLAYING).

Packit f546b1
Packit f546b1
Packit f546b1

Functions

Packit f546b1
Packit f546b1

gst_parse_error_quark ()

Packit f546b1
GQuark
Packit f546b1
gst_parse_error_quark (void);
Packit f546b1

Get the error quark used by the parsing subsystem.

Packit f546b1
Packit f546b1

Returns

Packit f546b1

the quark of the parse errors.

Packit f546b1
Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_parse_launch ()

Packit f546b1
GstElement *
Packit f546b1
gst_parse_launch (const gchar *pipeline_description,
Packit f546b1
                  GError **error);
Packit f546b1

Create a new pipeline based on command line syntax.

Packit f546b1
Please note that you might get a return value that is not NULL even though
Packit f546b1
the error
Packit f546b1
 is set. In this case there was a recoverable parsing error and you
Packit f546b1
can try to play the pipeline.

Packit f546b1
Packit f546b1

Parameters

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

pipeline_description

Packit f546b1

the command line describing the pipeline

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

error

Packit f546b1

the error message in case of an erroneous pipeline.

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

Returns

Packit f546b1

a new element on success, NULL on

Packit f546b1
failure. If more than one toplevel element is specified by the
Packit f546b1
pipeline_description
Packit f546b1
, all elements are put into a GstPipeline, which
Packit f546b1
than is returned. 

Packit f546b1

[transfer floating][nullable]

Packit f546b1
Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_parse_launch_full ()

Packit f546b1
GstElement *
Packit f546b1
gst_parse_launch_full (const gchar *pipeline_description,
Packit f546b1
                       GstParseContext *context,
Packit f546b1
                       GstParseFlags flags,
Packit f546b1
                       GError **error);
Packit f546b1

Create a new pipeline based on command line syntax.

Packit f546b1
Please note that you might get a return value that is not NULL even though
Packit f546b1
the error
Packit f546b1
 is set. In this case there was a recoverable parsing error and you
Packit f546b1
can try to play the pipeline.

Packit f546b1
Packit f546b1

Parameters

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

pipeline_description

Packit f546b1

the command line describing the pipeline

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

context

Packit f546b1

a parse context allocated with

Packit f546b1
gst_parse_context_new(), or NULL. 

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

flags

Packit f546b1

parsing options, or GST_PARSE_FLAG_NONE

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

error

Packit f546b1

the error message in case of an erroneous pipeline.

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

Returns

Packit f546b1

a new element on success, NULL on

Packit f546b1
failure. If more than one toplevel element is specified by the
Packit f546b1
pipeline_description
Packit f546b1
, all elements are put into a GstPipeline, which
Packit f546b1
then is returned (unless the GST_PARSE_FLAG_PLACE_IN_BIN flag is set, in
Packit f546b1
which case they are put in a GstBin instead). 

Packit f546b1

[transfer floating][nullable]

Packit f546b1
Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_parse_launchv ()

Packit f546b1
GstElement *
Packit f546b1
gst_parse_launchv (const gchar **argv,
Packit f546b1
                   GError **error);
Packit f546b1

Create a new element based on command line syntax.

Packit f546b1
error
Packit f546b1
 will contain an error message if an erroneous pipeline is specified.
Packit f546b1
An error does not mean that the pipeline could not be constructed.

Packit f546b1
Packit f546b1

Parameters

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

argv

Packit f546b1

null-terminated array of arguments.

Packit f546b1
[in][array zero-terminated=1]
Packit f546b1
Packit f546b1
Packit f546b1

error

Packit f546b1

pointer to a GError

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

Returns

Packit f546b1

a new element on success and NULL

Packit f546b1
on failure. 

Packit f546b1

[transfer floating][nullable]

Packit f546b1
Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_parse_launchv_full ()

Packit f546b1
GstElement *
Packit f546b1
gst_parse_launchv_full (const gchar **argv,
Packit f546b1
                        GstParseContext *context,
Packit f546b1
                        GstParseFlags flags,
Packit f546b1
                        GError **error);
Packit f546b1

Create a new element based on command line syntax.

Packit f546b1
error
Packit f546b1
 will contain an error message if an erroneous pipeline is specified.
Packit f546b1
An error does not mean that the pipeline could not be constructed.

Packit f546b1
Packit f546b1

Parameters

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

argv

Packit f546b1

null-terminated array of arguments.

Packit f546b1
[in][array zero-terminated=1]
Packit f546b1
Packit f546b1
Packit f546b1

context

Packit f546b1

a parse context allocated with

Packit f546b1
gst_parse_context_new(), or NULL. 

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

flags

Packit f546b1

parsing options, or GST_PARSE_FLAG_NONE

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

error

Packit f546b1

pointer to a GError (which must be initialised to NULL)

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

Returns

Packit f546b1

a new element on success; on

Packit f546b1
failure, either NULL or a partially-constructed bin or element will be
Packit f546b1
returned and error
Packit f546b1
will be set (unless you passed
Packit f546b1
GST_PARSE_FLAG_FATAL_ERRORS in flags
Packit f546b1
, then NULL will always be returned
Packit f546b1
on failure). 

Packit f546b1

[transfer floating][nullable]

Packit f546b1
Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_parse_bin_from_description ()

Packit f546b1
GstElement *
Packit f546b1
gst_parse_bin_from_description (const gchar *bin_description,
Packit f546b1
                                gboolean ghost_unlinked_pads,
Packit f546b1
                                GError **err);
Packit f546b1

This is a convenience wrapper around gst_parse_launch() to create a

Packit f546b1
GstBin from a gst-launch-style pipeline description. See
Packit f546b1
gst_parse_launch() and the gst-launch man page for details about the
Packit f546b1
syntax. Ghost pads on the bin for unlinked source or sink pads
Packit f546b1
within the bin can automatically be created (but only a maximum of
Packit f546b1
one ghost pad for each direction will be created; if you expect
Packit f546b1
multiple unlinked source pads or multiple unlinked sink pads
Packit f546b1
and want them all ghosted, you will have to create the ghost pads
Packit f546b1
yourself).

Packit f546b1
Packit f546b1

Parameters

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

bin_description

Packit f546b1

command line describing the bin

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

ghost_unlinked_pads

Packit f546b1

whether to automatically create ghost pads

Packit f546b1
for unlinked source or sink pads within the bin

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

err

Packit f546b1

where to store the error message in case of an error, or NULL

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

Returns

Packit f546b1

a

Packit f546b1
newly-created bin, or NULL if an error occurred. 

Packit f546b1

[transfer floating][type Gst.Bin][nullable]

Packit f546b1
Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_parse_bin_from_description_full ()

Packit f546b1
GstElement *
Packit f546b1
gst_parse_bin_from_description_full (const gchar *bin_description,
Packit f546b1
                                     gboolean ghost_unlinked_pads,
Packit f546b1
                                     GstParseContext *context,
Packit f546b1
                                     GstParseFlags flags,
Packit f546b1
                                     GError **err);
Packit f546b1

This is a convenience wrapper around gst_parse_launch() to create a

Packit f546b1
GstBin from a gst-launch-style pipeline description. See
Packit f546b1
gst_parse_launch() and the gst-launch man page for details about the
Packit f546b1
syntax. Ghost pads on the bin for unlinked source or sink pads
Packit f546b1
within the bin can automatically be created (but only a maximum of
Packit f546b1
one ghost pad for each direction will be created; if you expect
Packit f546b1
multiple unlinked source pads or multiple unlinked sink pads
Packit f546b1
and want them all ghosted, you will have to create the ghost pads
Packit f546b1
yourself).

Packit f546b1
Packit f546b1

Parameters

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

bin_description

Packit f546b1

command line describing the bin

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

ghost_unlinked_pads

Packit f546b1

whether to automatically create ghost pads

Packit f546b1
for unlinked source or sink pads within the bin

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

context

Packit f546b1

a parse context allocated with

Packit f546b1
gst_parse_context_new(), or NULL. 

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

flags

Packit f546b1

parsing options, or GST_PARSE_FLAG_NONE

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

err

Packit f546b1

where to store the error message in case of an error, or NULL

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

Returns

Packit f546b1

a newly-created

Packit f546b1
element, which is guaranteed to be a bin unless
Packit f546b1
GST_FLAG_NO_SINGLE_ELEMENT_BINS was passed, or NULL if an error
Packit f546b1
occurred. 

Packit f546b1

[transfer floating][type Gst.Element][nullable]

Packit f546b1
Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_parse_context_new ()

Packit f546b1
GstParseContext *
Packit f546b1
gst_parse_context_new (void);
Packit f546b1

Allocates a parse context for use with gst_parse_launch_full() or

Packit f546b1
gst_parse_launchv_full().

Packit f546b1

Free-function: gst_parse_context_free

Packit f546b1
Packit f546b1

Returns

Packit f546b1

a newly-allocated parse context. Free

Packit f546b1
with gst_parse_context_free() when no longer needed. 

Packit f546b1

[transfer full][nullable]

Packit f546b1
Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_parse_context_copy ()

Packit f546b1
GstParseContext *
Packit f546b1
gst_parse_context_copy (const GstParseContext *context);
Packit f546b1

Copies the context

Packit f546b1
.

Packit f546b1
Packit f546b1

Parameters

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

context

Packit f546b1

a GstParseContext

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

Returns

Packit f546b1

A copied GstParseContext.

Packit f546b1

[transfer full][nullable]

Packit f546b1
Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_parse_context_free ()

Packit f546b1
void
Packit f546b1
gst_parse_context_free (GstParseContext *context);
Packit f546b1

Frees a parse context previously allocated with gst_parse_context_new().

Packit f546b1
Packit f546b1

Parameters

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

context

Packit f546b1

a GstParseContext.

Packit f546b1
[transfer full]
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_parse_context_get_missing_elements ()

Packit f546b1
gchar **
Packit f546b1
gst_parse_context_get_missing_elements
Packit f546b1
                               (GstParseContext *context);
Packit f546b1

Retrieve missing elements from a previous run of gst_parse_launch_full()

Packit f546b1
or gst_parse_launchv_full(). Will only return results if an error code
Packit f546b1
of GST_PARSE_ERROR_NO_SUCH_ELEMENT was returned.

Packit f546b1
Packit f546b1

Parameters

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

context

Packit f546b1

a GstParseContext

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

Returns

Packit f546b1

a

Packit f546b1
NULL-terminated array of element factory name strings of missing
Packit f546b1
elements. Free with g_strfreev() when no longer needed. 

Packit f546b1

[transfer full][array zero-terminated=1][element-type gchar*][nullable]

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Types and Values

Packit f546b1
Packit f546b1

GST_PARSE_ERROR

Packit f546b1
#define GST_PARSE_ERROR gst_parse_error_quark ()
Packit f546b1
Packit f546b1

Get access to the error quark of the parse subsystem.

Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

enum GstParseError

Packit f546b1

The different parsing errors that can occur.

Packit f546b1
Packit f546b1

Members

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

GST_PARSE_ERROR_SYNTAX

Packit f546b1
Packit f546b1

A syntax error occurred.

Packit f546b1
Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

GST_PARSE_ERROR_NO_SUCH_ELEMENT

Packit f546b1
Packit f546b1

The description contained an unknown element

Packit f546b1
Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

GST_PARSE_ERROR_NO_SUCH_PROPERTY

Packit f546b1
Packit f546b1

An element did not have a specified property

Packit f546b1
Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

GST_PARSE_ERROR_LINK

Packit f546b1
Packit f546b1

There was an error linking two pads.

Packit f546b1
Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

GST_PARSE_ERROR_COULD_NOT_SET_PROPERTY

Packit f546b1
Packit f546b1

There was an error setting a property

Packit f546b1
Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

GST_PARSE_ERROR_EMPTY_BIN

Packit f546b1
Packit f546b1

An empty bin was specified.

Packit f546b1
Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

GST_PARSE_ERROR_EMPTY

Packit f546b1
Packit f546b1

An empty description was specified

Packit f546b1
Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

GST_PARSE_ERROR_DELAYED_LINK

Packit f546b1
Packit f546b1

A delayed link did not get resolved.

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

Packit f546b1
Packit f546b1

GstParseContext

Packit f546b1
typedef struct _GstParseContext GstParseContext;
Packit f546b1

Opaque structure.

Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

enum GstParseFlags

Packit f546b1

Parsing options.

Packit f546b1
Packit f546b1

Members

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

GST_PARSE_FLAG_NONE

Packit f546b1
Packit f546b1

Do not use any special parsing options.

Packit f546b1
Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

GST_PARSE_FLAG_FATAL_ERRORS

Packit f546b1
Packit f546b1

Always return NULL when an error occurs

Packit f546b1
    (default behaviour is to return partially constructed bins or elements
Packit f546b1
     in some cases)

Packit f546b1
Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

GST_PARSE_FLAG_NO_SINGLE_ELEMENT_BINS

Packit f546b1
Packit f546b1

If a bin only has a single element,

Packit f546b1
    just return the element.

Packit f546b1
Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

GST_PARSE_FLAG_PLACE_IN_BIN

Packit f546b1
Packit f546b1

If more than one toplevel element is described

Packit f546b1
    by the pipeline description string, put them in a GstBin instead of a
Packit f546b1
    GstPipeline. (Since 1.10)

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

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