Blame docs/plugins/html/gst-plugins-base-plugins-uridecodebin.html

Packit 971217
Packit 971217
<html>
Packit 971217
<head>
Packit 971217
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit 971217
<title>uridecodebin: GStreamer Base Plugins 1.0 Plugins Reference Manual</title>
Packit 971217
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
Packit 971217
<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Plugins Reference Manual">
Packit 971217
<link rel="up" href="ch01.html" title="gst-plugins-base Elements">
Packit 971217
<link rel="prev" href="gst-plugins-base-plugins-unalignedvideoparse.html" title="unalignedvideoparse">
Packit 971217
<link rel="next" href="gst-plugins-base-plugins-urisourcebin.html" title="urisourcebin">
Packit 971217
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
Packit 971217
<link rel="stylesheet" href="style.css" type="text/css">
Packit 971217
</head>
Packit 971217
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit 971217
Packit 971217
Packit 971217
Top  | 
Packit 971217
                  Description  | 
Packit 971217
                  Object Hierarchy  | 
Packit 971217
                  Implemented Interfaces  | 
Packit 971217
                  Properties  | 
Packit 971217
                  Signals
Packit 971217
Packit 971217
Home
Packit 971217
Up
Packit 971217
Prev
Packit 971217
Next
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

uridecodebin

Packit 971217

uridecodebin

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Properties

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
gint64
Packit 971217
buffer-duration
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
gint
Packit 971217
buffer-size
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstCaps *
Packit 971217
caps
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
guint64
Packit 971217
connection-speed
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
gboolean
Packit 971217
download
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
gboolean
Packit 971217
expose-all-streams
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
guint64
Packit 971217
ring-buffer-max-size
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstElement *
Packit 971217
source
Packit 971217
Read
Packit 971217
Packit 971217
Packit 971217
Packit 971217
gchar *
Packit 971217
subtitle-encoding
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
Packit 971217
gchar *
Packit 971217
uri
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
gboolean
Packit 971217
use-buffering
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Signals

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
gboolean
Packit 971217
autoplug-continue
Packit 971217
Run Last
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GValueArray*
Packit 971217
autoplug-factories
Packit 971217
Run Last
Packit 971217
Packit 971217
Packit 971217
gboolean
Packit 971217
autoplug-query
Packit 971217
Run Last
Packit 971217
Packit 971217
Packit 971217
GstAutoplugSelectResult
Packit 971217
autoplug-select
Packit 971217
Run Last
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GValueArray*
Packit 971217
autoplug-sort
Packit 971217
Run Last
Packit 971217
Packit 971217
Packit 971217
void
Packit 971217
drained
Packit 971217
Run Last
Packit 971217
Packit 971217
Packit 971217
void
Packit 971217
source-setup
Packit 971217
Run Last
Packit 971217
Packit 971217
Packit 971217
void
Packit 971217
unknown-type
Packit 971217
Run Last
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Types and Values

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
struct
Packit 971217
GstURIDecodeBin
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Object Hierarchy

Packit 971217
    GObject
Packit 971217
    ╰── GInitiallyUnowned
Packit 971217
        ╰── GstObject
Packit 971217
            ╰── GstElement
Packit 971217
                ╰── GstBin
Packit 971217
                    ╰── GstURIDecodeBin
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Implemented Interfaces

Packit 971217

Packit 971217
GstURIDecodeBin implements
Packit 971217
 GstChildProxy.

Packit 971217
Packit 971217
Packit 971217

Description

Packit 971217

Decodes data from a URI into raw media. It selects a source element that can

Packit 971217
handle the given “uri” scheme and connects it to a decodebin.

Packit 971217
Packit 971217

Synopsis

Packit 971217
Packit 971217

Element Information

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

plugin

Packit 971217
Packit 971217
            playback
Packit 971217
          
Packit 971217
Packit 971217
Packit 971217

author

Packit 971217
Wim Taymans <wim.taymans@gmail.com>
Packit 971217
Packit 971217
Packit 971217

class

Packit 971217
Generic/Bin/Decoder
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Packit 971217
Packit 971217

Element Pads

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

name

Packit 971217
src_%u
Packit 971217
Packit 971217
Packit 971217

direction

Packit 971217
source
Packit 971217
Packit 971217
Packit 971217

presence

Packit 971217
sometimes
Packit 971217
Packit 971217
Packit 971217

details

Packit 971217
ANY
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Functions

Packit 971217

Packit 971217
Packit 971217
Packit 971217

Types and Values

Packit 971217
Packit 971217

struct GstURIDecodeBin

Packit 971217
struct GstURIDecodeBin;
Packit 971217

uridecodebin element struct

Packit 971217
Packit 971217
Packit 971217
Packit 971217

Property Details

Packit 971217
Packit 971217

The “buffer-duration” property

Packit 971217
  “buffer-duration”          gint64
Packit 971217

Buffer duration when buffering streams (-1 default value).

Packit 971217

Flags: Read / Write

Packit 971217

Allowed values: >= G_MAXULONG

Packit 971217

Default value: -1

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “buffer-size” property

Packit 971217
  “buffer-size”              gint
Packit 971217

Buffer size when buffering streams (-1 default value).

Packit 971217

Flags: Read / Write

Packit 971217

Allowed values: >= G_MAXULONG

Packit 971217

Default value: -1

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “caps” property

Packit 971217
  “caps”                     GstCaps *
Packit 971217

The caps on which to stop decoding. (NULL = default).

Packit 971217

Flags: Read / Write

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “connection-speed” property

Packit 971217
  “connection-speed”         guint64
Packit 971217

Network connection speed in kbps (0 = unknown).

Packit 971217

Flags: Read / Write

Packit 971217

Allowed values: <= 18446744073709551

Packit 971217

Default value: 0

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “download” property

Packit 971217
  “download”                 gboolean
Packit 971217

Attempt download buffering when buffering network streams.

Packit 971217

Flags: Read / Write

Packit 971217

Default value: FALSE

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “expose-all-streams” property

Packit 971217
  “expose-all-streams”       gboolean
Packit 971217

Expose all streams, including those of unknown type or that don't match the 'caps' property.

Packit 971217

Flags: Read / Write

Packit 971217

Default value: TRUE

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “ring-buffer-max-size” property

Packit 971217
  “ring-buffer-max-size”     guint64
Packit 971217

Max. amount of data in the ring buffer (bytes, 0 = ring buffer disabled).

Packit 971217

Flags: Read / Write

Packit 971217

Allowed values: <= G_MAXUINT

Packit 971217

Default value: 0

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “source” property

Packit 971217
  “source”                   GstElement *
Packit 971217

Source object used.

Packit 971217

Flags: Read

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “subtitle-encoding” property

Packit 971217
  “subtitle-encoding”        gchar *
Packit 971217

Encoding to assume if input subtitles are not in UTF-8 encoding. If not set, the GST_SUBTITLE_ENCODING environment variable will be checked for an encoding to use. If that is not set either, ISO-8859-15 will be assumed.

Packit 971217

Flags: Read / Write

Packit 971217

Default value: NULL

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “uri” property

Packit 971217
  “uri”                      gchar *
Packit 971217

URI to decode.

Packit 971217

Flags: Read / Write

Packit 971217

Default value: NULL

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “use-buffering” property

Packit 971217
  “use-buffering”            gboolean
Packit 971217

Perform buffering on demuxed/parsed media.

Packit 971217

Flags: Read / Write

Packit 971217

Default value: FALSE

Packit 971217
Packit 971217
Packit 971217
Packit 971217

Signal Details

Packit 971217
Packit 971217

The “autoplug-continue” signal

Packit 971217
gboolean
Packit 971217
user_function (GstURIDecodeBin *bin,
Packit 971217
               GstPad          *pad,
Packit 971217
               GstCaps         *caps,
Packit 971217
               gpointer         user_data)
Packit 971217

This signal is emitted whenever uridecodebin finds a new stream. It is

Packit 971217
emitted before looking for any elements that can handle that stream.

Packit 971217

Invocation of signal handlers stops after the first signal handler

Packit 971217
  returns FALSE. Signal handlers are invoked in the order they were
Packit 971217
  connected in.

Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

bin

Packit 971217

The uridecodebin.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

pad

Packit 971217

The GstPad.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

caps

Packit 971217

The GstCaps found.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

user_data

Packit 971217

user data set when the signal handler was connected.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Returns

Packit 971217

TRUE if you wish uridecodebin to look for elements that can

Packit 971217
handle the given caps
Packit 971217
. If FALSE, those caps will be considered as
Packit 971217
final and the pad will be exposed as such (see 'pad-added' signal of
Packit 971217
GstElement).

Packit 971217
Packit 971217

Flags: Run Last

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “autoplug-factories” signal

Packit 971217
GValueArray*
Packit 971217
user_function (GstURIDecodeBin *bin,
Packit 971217
               GstPad          *pad,
Packit 971217
               GstCaps         *caps,
Packit 971217
               gpointer         user_data)
Packit 971217

This function is emitted when an array of possible factories for caps

Packit 971217
 on
Packit 971217
pad
Packit 971217
 is needed. Uridecodebin will by default return an array with all
Packit 971217
compatible factories, sorted by rank.

Packit 971217

If this function returns NULL, pad

Packit 971217
 will be exposed as a final caps.

Packit 971217

If this function returns an empty array, the pad will be considered as

Packit 971217
having an unhandled type media type.

Packit 971217

Only the signal handler that is connected first will ever by invoked.

Packit 971217
  Don't connect signal handlers with the G_CONNECT_AFTER flag to this
Packit 971217
  signal, they will never be invoked!

Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

bin

Packit 971217

The uridecodebin.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

pad

Packit 971217

The GstPad.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

caps

Packit 971217

The GstCaps found.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

user_data

Packit 971217

user data set when the signal handler was connected.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Returns

Packit 971217

a GValueArray* with a list of factories to try. The factories are

Packit 971217
by default tried in the returned order or based on the index returned by
Packit 971217
"autoplug-select".

Packit 971217
Packit 971217

Flags: Run Last

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “autoplug-query” signal

Packit 971217
gboolean
Packit 971217
user_function (GstURIDecodeBin *gsturidecodebin,
Packit 971217
               GstPad          *arg1,
Packit 971217
               GstElement      *arg2,
Packit 971217
               GstQuery        *arg3,
Packit 971217
               gpointer         user_data)
Packit 971217

Flags: Run Last

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “autoplug-select” signal

Packit 971217
GstAutoplugSelectResult
Packit 971217
user_function (GstURIDecodeBin   *bin,
Packit 971217
               GstPad            *pad,
Packit 971217
               GstCaps           *caps,
Packit 971217
               GstElementFactory *factory,
Packit 971217
               gpointer           user_data)
Packit 971217

This signal is emitted once uridecodebin has found all the possible

Packit 971217
GstElementFactory that can be used to handle the given caps
Packit 971217
. For each of
Packit 971217
those factories, this signal is emitted.

Packit 971217

The signal handler should return a GST_TYPE_AUTOPLUG_SELECT_RESULT enum

Packit 971217
value indicating what decodebin should do next.

Packit 971217

A value of GST_AUTOPLUG_SELECT_TRY will try to autoplug an element from

Packit 971217
factory
Packit 971217
.

Packit 971217

A value of GST_AUTOPLUG_SELECT_EXPOSE will expose pad

Packit 971217
 without plugging
Packit 971217
any element to it.

Packit 971217

A value of GST_AUTOPLUG_SELECT_SKIP will skip factory

Packit 971217
 and move to the
Packit 971217
next factory.

Packit 971217

The signal handler will not be invoked if any of the previously

Packit 971217
  registered signal handlers (if any) return a value other than
Packit 971217
  GST_AUTOPLUG_SELECT_TRY. Which also means that if you return
Packit 971217
  GST_AUTOPLUG_SELECT_TRY from one signal handler, handlers that get
Packit 971217
  registered next (again, if any) can override that decision.

Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

bin

Packit 971217

The uridecodebin.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

pad

Packit 971217

The GstPad.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

caps

Packit 971217

The GstCaps.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

factory

Packit 971217

A GstElementFactory to use.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

user_data

Packit 971217

user data set when the signal handler was connected.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Returns

Packit 971217

a GST_TYPE_AUTOPLUG_SELECT_RESULT that indicates the required

Packit 971217
operation. The default handler will always return
Packit 971217
GST_AUTOPLUG_SELECT_TRY.

Packit 971217
Packit 971217

Flags: Run Last

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “autoplug-sort” signal

Packit 971217
GValueArray*
Packit 971217
user_function (GstURIDecodeBin *bin,
Packit 971217
               GstPad          *pad,
Packit 971217
               GstCaps         *caps,
Packit 971217
               GValueArray     *factories,
Packit 971217
               gpointer         user_data)
Packit 971217

Once decodebin has found the possible GstElementFactory objects to try

Packit 971217
for caps
Packit 971217
 on pad
Packit 971217
, this signal is emited. The purpose of the signal is for
Packit 971217
the application to perform additional sorting or filtering on the element
Packit 971217
factory array.

Packit 971217

The callee should copy and modify factories

Packit 971217
 or return NULL if the
Packit 971217
order should not change.

Packit 971217

Invocation of signal handlers stops after one signal handler has

Packit 971217
  returned something else than NULL. Signal handlers are invoked in
Packit 971217
  the order they were connected in.
Packit 971217
  Don't connect signal handlers with the G_CONNECT_AFTER flag to this
Packit 971217
  signal, they will never be invoked!

Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

bin

Packit 971217

The uridecodebin.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

pad

Packit 971217

The GstPad.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

caps

Packit 971217

The GstCaps.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

factories

Packit 971217

A GValueArray of possible GstElementFactory to use.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

user_data

Packit 971217

user data set when the signal handler was connected.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Returns

Packit 971217

A new sorted array of GstElementFactory objects.

Packit 971217
Packit 971217

Flags: Run Last

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “drained” signal

Packit 971217
void
Packit 971217
user_function (GstURIDecodeBin *gsturidecodebin,
Packit 971217
               gpointer         user_data)
Packit 971217

This signal is emitted when the data for the current uri is played.

Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

user_data

Packit 971217

user data set when the signal handler was connected.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Flags: Run Last

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “source-setup” signal

Packit 971217
void
Packit 971217
user_function (GstURIDecodeBin *bin,
Packit 971217
               GstElement      *source,
Packit 971217
               gpointer         user_data)
Packit 971217

This signal is emitted after the source element has been created, so

Packit 971217
it can be configured by setting additional properties (e.g. set a
Packit 971217
proxy server for an http source, or set the device and read speed for
Packit 971217
an audio cd source). This is functionally equivalent to connecting to
Packit 971217
the notify::source signal, but more convenient.

Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

bin

Packit 971217

the uridecodebin.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

source

Packit 971217

source element

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

user_data

Packit 971217

user data set when the signal handler was connected.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Flags: Run Last

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “unknown-type” signal

Packit 971217
void
Packit 971217
user_function (GstURIDecodeBin *bin,
Packit 971217
               GstPad          *pad,
Packit 971217
               GstCaps         *caps,
Packit 971217
               gpointer         user_data)
Packit 971217

This signal is emitted when a pad for which there is no further possible

Packit 971217
decoding is added to the uridecodebin.

Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

bin

Packit 971217

The uridecodebin.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

pad

Packit 971217

the new pad containing caps that cannot be resolved to a 'final'.

Packit 971217
stream type.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

caps

Packit 971217

the GstCaps of the pad that cannot be resolved.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

user_data

Packit 971217

user data set when the signal handler was connected.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Flags: Run Last

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

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