|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
<html>
|
|
Packit |
a6ee4b |
<head>
|
|
Packit |
a6ee4b |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
Packit |
a6ee4b |
<title>downloadbuffer: GStreamer Core Plugins 1.0 Plugins 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 Core Plugins 1.0 Plugins Reference Manual">
|
|
Packit |
a6ee4b |
<link rel="up" href="ch01.html" title="gstreamer Elements">
|
|
Packit |
a6ee4b |
<link rel="prev" href="gstreamer-plugins-dataurisrc.html" title="dataurisrc">
|
|
Packit |
a6ee4b |
<link rel="next" href="gstreamer-plugins-fakesink.html" title="fakesink">
|
|
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 |
Object Hierarchy |
|
|
Packit |
a6ee4b |
Properties
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
downloadbuffer
|
|
Packit |
a6ee4b |
downloadbuffer
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
Properties
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
gint
|
|
Packit |
a6ee4b |
high-percent
|
|
Packit |
a6ee4b |
Read / Write
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
gint
|
|
Packit |
a6ee4b |
low-percent
|
|
Packit |
a6ee4b |
Read / Write
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
guint
|
|
Packit |
a6ee4b |
max-size-bytes
|
|
Packit |
a6ee4b |
Read / Write
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
guint64
|
|
Packit |
a6ee4b |
max-size-time
|
|
Packit |
a6ee4b |
Read / Write
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
gchar *
|
|
Packit |
a6ee4b |
temp-location
|
|
Packit |
a6ee4b |
Read
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
gboolean
|
|
Packit |
a6ee4b |
temp-remove
|
|
Packit |
a6ee4b |
Read / Write
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
gchar *
|
|
Packit |
a6ee4b |
temp-template
|
|
Packit |
a6ee4b |
Read / Write
|
|
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 |
struct
|
|
Packit |
a6ee4b |
GstDownloadBuffer
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
Object Hierarchy
|
|
Packit |
a6ee4b |
GObject
|
|
Packit |
a6ee4b |
╰── GInitiallyUnowned
|
|
Packit |
a6ee4b |
╰── GstObject
|
|
Packit |
a6ee4b |
╰── GstElement
|
|
Packit |
a6ee4b |
╰── GstDownloadBuffer
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
Description
|
|
Packit |
a6ee4b |
The downloadbuffer element provides on-disk buffering and caching of, typically,
|
|
Packit |
a6ee4b |
a network file. temp-template should be set to a value such as
|
|
Packit |
a6ee4b |
/tmp/gstreamer-XXXXXX and the element will allocate a random free filename and
|
|
Packit |
a6ee4b |
buffer the data in the file.
|
|
Packit |
a6ee4b |
With max-size-bytes and max-size-time you can configure the buffering limits.
|
|
Packit |
a6ee4b |
The downloadbuffer element will try to read-ahead these amounts of data. When
|
|
Packit |
a6ee4b |
the amount of read-ahead data drops below low-percent of the configured max,
|
|
Packit |
a6ee4b |
the element will start emitting BUFFERING messages until high-percent of max is
|
|
Packit |
a6ee4b |
reached again.
|
|
Packit |
a6ee4b |
The downloadbuffer provides push and pull based scheduling on its source pad
|
|
Packit |
a6ee4b |
and will efficiently seek in the upstream element when needed.
|
|
Packit |
a6ee4b |
The temp-location property will be used to notify the application of the
|
|
Packit |
a6ee4b |
allocated filename.
|
|
Packit |
a6ee4b |
When the downloadbuffer has completely downloaded the media, it will
|
|
Packit |
a6ee4b |
post an application message named "GstCacheDownloadComplete"
|
|
Packit |
a6ee4b |
with the following information:
|
|
Packit |
a6ee4b |
*
|
|
Packit |
a6ee4b |
G_TYPE_STRING
|
|
Packit |
a6ee4b |
"location":
|
|
Packit |
a6ee4b |
the location of the completely downloaded file.
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
Synopsis
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
Element Information
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
plugin
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
coreelements
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
author
|
|
Packit |
a6ee4b |
Wim Taymans <wim.taymans@gmail.com>
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
class
|
|
Packit |
a6ee4b |
Generic
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
Element Pads
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
name
|
|
Packit |
a6ee4b |
sink
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
direction
|
|
Packit |
a6ee4b |
sink
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
presence
|
|
Packit |
a6ee4b |
always
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
details
|
|
Packit |
a6ee4b |
ANY
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
name
|
|
Packit |
a6ee4b |
src
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
direction
|
|
Packit |
a6ee4b |
source
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
presence
|
|
Packit |
a6ee4b |
always
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
details
|
|
Packit |
a6ee4b |
ANY
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
Functions
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
Types and Values
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
struct GstDownloadBuffer
|
|
Packit |
a6ee4b |
struct GstDownloadBuffer;
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
Property Details
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
The “high-percent” property
|
|
Packit |
a6ee4b |
“high-percent” gint
|
|
Packit |
a6ee4b |
High threshold for buffering to finish. Only used if use-buffering is True.
|
|
Packit |
a6ee4b |
Flags: Read / Write
|
|
Packit |
a6ee4b |
Allowed values: [0,100]
|
|
Packit |
a6ee4b |
Default value: 99
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
The “low-percent” property
|
|
Packit |
a6ee4b |
“low-percent” gint
|
|
Packit |
a6ee4b |
Low threshold for buffering to start. Only used if use-buffering is True.
|
|
Packit |
a6ee4b |
Flags: Read / Write
|
|
Packit |
a6ee4b |
Allowed values: [0,100]
|
|
Packit |
a6ee4b |
Default value: 10
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
The “max-size-bytes” property
|
|
Packit |
a6ee4b |
“max-size-bytes” guint
|
|
Packit |
a6ee4b |
Max. amount of data to buffer (bytes, 0=disable).
|
|
Packit |
a6ee4b |
Flags: Read / Write
|
|
Packit |
a6ee4b |
Default value: 2097152
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
The “max-size-time” property
|
|
Packit |
a6ee4b |
“max-size-time” guint64
|
|
Packit |
a6ee4b |
Max. amount of data to buffer (in ns, 0=disable).
|
|
Packit |
a6ee4b |
Flags: Read / Write
|
|
Packit |
a6ee4b |
Default value: 2000000000
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
The “temp-location” property
|
|
Packit |
a6ee4b |
“temp-location” gchar *
|
|
Packit |
a6ee4b |
Location to store temporary files in (Only read this property, use temp-template to configure the name template).
|
|
Packit |
a6ee4b |
Flags: Read
|
|
Packit |
a6ee4b |
Default value: NULL
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
The “temp-remove” property
|
|
Packit |
a6ee4b |
“temp-remove” gboolean
|
|
Packit |
a6ee4b |
When temp-template is set, remove the temporary file when going to READY.
|
|
Packit |
a6ee4b |
Flags: Read / Write
|
|
Packit |
a6ee4b |
Default value: TRUE
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
The “temp-template” property
|
|
Packit |
a6ee4b |
“temp-template” gchar *
|
|
Packit |
a6ee4b |
File template to store temporary files in, should contain directory and XXXXXX. (NULL == disabled).
|
|
Packit |
a6ee4b |
Flags: Read / Write
|
|
Packit |
a6ee4b |
Default value: NULL
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
|
|
Packit |
a6ee4b |
Generated by GTK-Doc V1.28
|
|
Packit |
a6ee4b |
</body>
|
|
Packit |
a6ee4b |
</html>
|