← Back to branch summary

~broder/ubuntu/natty/gst-plugins-base0.10/perlsectomy

« back to all changes in this revision

Viewing changes to docs/plugins/html/gst-plugins-base-plugins-element-giosink.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastian Dröge
  • Date: 2010-06-26 21:12:29 UTC
  • mfrom: (11.5.1 upstream) (33.1.6 sid)
  • Revision ID: james.westby@ubuntu.com-20100626211229-0k34egbnd2octtpv
Tags: 0.10.29.2-1
* New upstream pre-release:
  + debian/rules,
    debian/compat,
    debian/control.in,
    debian/source/format,
    debian/patches/*:
    - Update to debhelper compat level 7.
    - Update to source format 3.0 (quilt).
    - Update to Standards-Version 3.8.4.
  + debian/build-deps.in,
    debian/rules:
    - Build depend on GLib 2.20 and GStreamer 0.10.29.2.
    - Build depend on ORC instead of liboil.
  + debian/patches/00*:
    - Dropped, merged upstream.
  + debian/libgstreamer-plugins-base.symbols:
    - Update symbols file with the new API.
  + debian/patches/01_videotestsrc-libm-linking.patch,
    debian/patches/02_videoscale-libm-linking.patch:
    - Link videotestsrc and videoscale with libm to fix FTBFS.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/plugins/html/gst-plugins-base-plugins-element-giosink.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>giosink</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
 
7
<link rel="home" href="index.html" title="GStreamer Base Plugins 0.10 Plugins Reference Manual">
 
8
<link rel="up" href="ch01.html" title="gst-plugins-base Elements">
 
9
<link rel="prev" href="gst-plugins-base-plugins-element-gdppay.html" title="gdppay">
 
10
<link rel="next" href="gst-plugins-base-plugins-element-giosrc.html" title="giosrc">
 
11
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
16
<tr valign="middle">
 
17
<td><a accesskey="p" href="gst-plugins-base-plugins-element-gdppay.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
20
<th width="100%" align="center">GStreamer Base Plugins 0.10 Plugins Reference Manual</th>
 
21
<td><a accesskey="n" href="gst-plugins-base-plugins-element-giosrc.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
22
</tr>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#gst-plugins-base-plugins-element-giosink.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#gst-plugins-base-plugins-element-giosink.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#gst-plugins-base-plugins-element-giosink.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
                   | 
 
30
                  <a href="#gst-plugins-base-plugins-element-giosink.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
 
31
                   | 
 
32
                  <a href="#gst-plugins-base-plugins-element-giosink.properties" class="shortcut">Properties</a>
 
33
</td></tr>
 
34
</table>
 
35
<div class="refentry" title="giosink">
 
36
<a name="gst-plugins-base-plugins-element-giosink"></a><div class="titlepage"></div>
 
37
<div class="refnamediv"><table width="100%"><tr>
 
38
<td valign="top">
 
39
<h2><span class="refentrytitle"><a name="gst-plugins-base-plugins-element-giosink.top_of_page"></a>giosink</span></h2>
 
40
<p>giosink — Write to any GIO-supported location</p>
 
41
</td>
 
42
<td valign="top" align="right"></td>
 
43
</tr></table></div>
 
44
<div class="refsynopsisdiv" title="Synopsis">
 
45
<a name="gst-plugins-base-plugins-element-giosink.synopsis"></a><h2>Synopsis</h2>
 
46
<a name="GstGioSink"></a><pre class="synopsis">                    <a class="link" href="gst-plugins-base-plugins-element-giosink.html#GstGioSink-struct" title="GstGioSink">GstGioSink</a>;
 
47
</pre>
 
48
</div>
 
49
<div class="refsect1" title="Object Hierarchy">
 
50
<a name="gst-plugins-base-plugins-element-giosink.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
51
<pre class="synopsis">
 
52
  <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
53
   +----<a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstObject.html">GstObject</a>
 
54
         +----<a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstElement.html">GstElement</a>
 
55
               +----<a href="/usr/share/gtk-doc/html/gstreamer-libs-0.10/GstBaseSink.html">GstBaseSink</a>
 
56
                     +----GstGioBaseSink
 
57
                           +----GstGioSink
 
58
</pre>
 
59
</div>
 
60
<div class="refsect1" title="Implemented Interfaces">
 
61
<a name="gst-plugins-base-plugins-element-giosink.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
 
62
<p>
 
63
GstGioSink implements
 
64
 <a href="/usr/share/gtk-doc/html/gstreamer-0.10/gstreamer-GstUriHandler.html#GstURIHandler">GstURIHandler</a>.</p>
 
65
</div>
 
66
<div class="refsect1" title="Properties">
 
67
<a name="gst-plugins-base-plugins-element-giosink.properties"></a><h2>Properties</h2>
 
68
<pre class="synopsis">
 
69
  "<a class="link" href="gst-plugins-base-plugins-element-giosink.html#GstGioSink--location" title='The "location" property'>location</a>"                 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
 
70
  "<a class="link" href="gst-plugins-base-plugins-element-giosink.html#GstGioSink--file" title='The "file" property'>file</a>"                     <a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a>*                : Read / Write
 
71
</pre>
 
72
</div>
 
73
<div class="refsect1" title="Description">
 
74
<a name="gst-plugins-base-plugins-element-giosink.description"></a><h2>Description</h2>
 
75
<p>
 
76
This plugin writes incoming data to a local or remote location specified
 
77
by an URI. This location can be specified using any protocol supported by
 
78
the GIO library or it's VFS backends. Common protocols are 'file', 'ftp',
 
79
or 'smb'.
 
80
</p>
 
81
<p>
 
82
If the URI or <a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a> already exists giosink will post a message of
 
83
type <a href="/usr/share/gtk-doc/html/gstreamer-0.10/gstreamer-GstMessage.html#GST-MESSAGE-ELEMENT:CAPS"><code class="literal">GST_MESSAGE_ELEMENT</code></a> with name "file-exists" on the bus. The message
 
84
also contains the <a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a> and the corresponding URI.
 
85
Applications can use the "file-exists" message to notify the user about
 
86
the problem and to set a different target location or to remove the
 
87
existing file. Note that right after the "file-exists" message a normal
 
88
error message is posted on the bus which should be ignored if "file-exists"
 
89
is handled by the application, for example by calling
 
90
gst_bus_set_flushing(bus, TRUE) after the "file-exists" message was
 
91
received and gst_bus_set_flushing(bus, FALSE) after the problem is
 
92
resolved.
 
93
</p>
 
94
<p>
 
95
Similar to the "file-exist" message a "not-mounted" message is posted
 
96
on the bus if the target location is not mounted yet and needs to be
 
97
mounted. This message can be used by application to mount the location
 
98
and retry after the location was mounted successfully.
 
99
</p>
 
100
<div class="refsect2" title="Example pipelines">
 
101
<a name="id608182"></a><h3>Example pipelines</h3>
 
102
<div class="informalexample">
 
103
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 
104
    <tbody>
 
105
      <tr>
 
106
        <td class="listing_lines" align="right"><pre>1</pre></td>
 
107
        <td class="listing_code"><pre class="programlisting">gst<span class="symbol">-</span>launch <span class="symbol">-</span>v filesrc location<span class="symbol">=</span>input<span class="symbol">.</span>xyz <span class="symbol">!</span> giosink location<span class="symbol">=</span>file<span class="symbol">:</span><span class="gtkdoc slc">///home/joe/out.xyz</span></pre></td>
 
108
      </tr>
 
109
    </tbody>
 
110
  </table>
 
111
</div>
 
112
 The above pipeline will simply copy a local file. Instead of giosink,
 
113
we could just as well have used the filesink element here.
 
114
<div class="informalexample">
 
115
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 
116
    <tbody>
 
117
      <tr>
 
118
        <td class="listing_lines" align="right"><pre>1</pre></td>
 
119
        <td class="listing_code"><pre class="programlisting">gst<span class="symbol">-</span>launch <span class="symbol">-</span>v filesrc location<span class="symbol">=</span>foo<span class="symbol">.</span>mp3 <span class="symbol">!</span> mad <span class="symbol">!</span> flacenc <span class="symbol">!</span> giosink location<span class="symbol">=</span>smb<span class="symbol">:</span><span class="gtkdoc slc">//othercomputer/foo.flac</span></pre></td>
 
120
      </tr>
 
121
    </tbody>
 
122
  </table>
 
123
</div>
 
124
 The above pipeline will re-encode an mp3 file into FLAC format and store
 
125
it on a remote host using the Samba protocol.
 
126
<div class="informalexample">
 
127
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 
128
    <tbody>
 
129
      <tr>
 
130
        <td class="listing_lines" align="right"><pre>1</pre></td>
 
131
        <td class="listing_code"><pre class="programlisting">gst<span class="symbol">-</span>launch <span class="symbol">-</span>v audiotestsrc num<span class="symbol">-</span>buffers<span class="symbol">=</span><span class="number">100</span> <span class="symbol">!</span> vorbisenc <span class="symbol">!</span> oggmux <span class="symbol">!</span> giosink location<span class="symbol">=</span>file<span class="symbol">:</span><span class="gtkdoc slc">///home/foo/bar.ogg</span></pre></td>
 
132
      </tr>
 
133
    </tbody>
 
134
  </table>
 
135
</div>
 
136
 The above pipeline will encode a 440Hz sine wave to Ogg Vorbis and stores
 
137
it in the home directory of user foo.
 
138
</div>
 
139
</div>
 
140
<div class="refsect1" title="Details">
 
141
<a name="gst-plugins-base-plugins-element-giosink.details"></a><h2>Details</h2>
 
142
<div class="refsect2" title="GstGioSink">
 
143
<a name="GstGioSink-struct"></a><h3>GstGioSink</h3>
 
144
<pre class="programlisting">typedef struct _GstGioSink GstGioSink;</pre>
 
145
<p>
 
146
Opaque data structure.
 
147
</p>
 
148
</div>
 
149
</div>
 
150
<div class="refsect1" title="Property Details">
 
151
<a name="gst-plugins-base-plugins-element-giosink.property-details"></a><h2>Property Details</h2>
 
152
<div class="refsect2" title='The "location" property'>
 
153
<a name="GstGioSink--location"></a><h3>The <code class="literal">"location"</code> property</h3>
 
154
<pre class="programlisting">  "location"                 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 
155
<p>URI location to write to.</p>
 
156
<p>Default value: NULL</p>
 
157
</div>
 
158
<hr>
 
159
<div class="refsect2" title='The "file" property'>
 
160
<a name="GstGioSink--file"></a><h3>The <code class="literal">"file"</code> property</h3>
 
161
<pre class="programlisting">  "file"                     <a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a>*                : Read / Write</pre>
 
162
<p>
 
163
<a href="/usr/share/gtk-doc/html/gio/GFile.html"><code class="literal">GFile</code></a> to write to.
 
164
</p>
 
165
<p class="since">Since 0.10.20</p>
 
166
</div>
 
167
</div>
 
168
<div class="refsect1" title="See Also">
 
169
<a name="gst-plugins-base-plugins-element-giosink.see-also"></a><h2>See Also</h2>
 
170
<a href="/usr/share/gtk-doc/html/gstreamer-plugins-0.10/gstreamer-plugins-filesink.html#GstFileSink"><span class="type">GstFileSink</span></a>, <a class="link" href="gst-plugins-base-plugins-gnomevfssink.html#GstGnomeVFSSink"><span class="type">GstGnomeVFSSink</span></a>, <a class="link" href="gst-plugins-base-plugins-element-giosrc.html#GstGioSrc"><span class="type">GstGioSrc</span></a>
 
171
</div>
 
172
</div>
 
173
<div class="footer">
 
174
<hr>
 
175
          Generated by GTK-Doc V1.15</div>
 
176
</body>
 
177
</html>
 
 
b'\\ No newline at end of file'