~ubuntu-branches/ubuntu/karmic/gst-plugins-bad0.10/karmic-proposed

« back to all changes in this revision

Viewing changes to docs/plugins/html/gst-plugins-bad-plugins-dccpclientsrc.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastian Dröge
  • Date: 2009-01-08 07:59:36 UTC
  • mto: (18.1.3 sid) (1.2.1 upstream)
  • mto: This revision was merged to the branch mainline in revision 23.
  • Revision ID: james.westby@ubuntu.com-20090108075936-dpmodc3g7ko1scwd
Tags: upstream-0.10.9.2
Import upstream version 0.10.9.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
51
51
<div class="refsect1" lang="en">
52
52
<a name="gst-plugins-bad-plugins-dccpclientsrc.object-hierarchy"></a><h2>Object Hierarchy</h2>
53
53
<pre class="synopsis">
54
 
  GObject
 
54
  <a
 
55
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
 
56
>GObject</a>
55
57
   +----GstObject
56
58
         +----GstElement
57
59
               +----GstBaseSrc
63
65
<a name="gst-plugins-bad-plugins-dccpclientsrc.properties"></a><h2>Properties</h2>
64
66
<pre class="synopsis">
65
67
  "<a class="link" href="gst-plugins-bad-plugins-dccpclientsrc.html#GstDCCPClientSrc--caps" title='The "caps" property'>caps</a>"                     GstCaps*              : Read / Write
66
 
  "<a class="link" href="gst-plugins-bad-plugins-dccpclientsrc.html#GstDCCPClientSrc--ccid" title='The "ccid" property'>ccid</a>"                     gint                  : Read / Write
67
 
  "<a class="link" href="gst-plugins-bad-plugins-dccpclientsrc.html#GstDCCPClientSrc--close-socket" title='The "close-socket" property'>close-socket</a>"             gboolean              : Read / Write
68
 
  "<a class="link" href="gst-plugins-bad-plugins-dccpclientsrc.html#GstDCCPClientSrc--host" title='The "host" property'>host</a>"                     gchar*                : Read / Write
69
 
  "<a class="link" href="gst-plugins-bad-plugins-dccpclientsrc.html#GstDCCPClientSrc--port" title='The "port" property'>port</a>"                     gint                  : Read / Write
70
 
  "<a class="link" href="gst-plugins-bad-plugins-dccpclientsrc.html#GstDCCPClientSrc--sockfd" title='The "sockfd" property'>sockfd</a>"                   gint                  : Read / Write
 
68
  "<a class="link" href="gst-plugins-bad-plugins-dccpclientsrc.html#GstDCCPClientSrc--ccid" title='The "ccid" property'>ccid</a>"                     <a
 
69
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
 
70
>gint</a>                  : Read / Write
 
71
  "<a class="link" href="gst-plugins-bad-plugins-dccpclientsrc.html#GstDCCPClientSrc--close-socket" title='The "close-socket" property'>close-socket</a>"             <a
 
72
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
73
>gboolean</a>              : Read / Write
 
74
  "<a class="link" href="gst-plugins-bad-plugins-dccpclientsrc.html#GstDCCPClientSrc--host" title='The "host" property'>host</a>"                     <a
 
75
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
76
>gchar</a>*                : Read / Write
 
77
  "<a class="link" href="gst-plugins-bad-plugins-dccpclientsrc.html#GstDCCPClientSrc--port" title='The "port" property'>port</a>"                     <a
 
78
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
 
79
>gint</a>                  : Read / Write
 
80
  "<a class="link" href="gst-plugins-bad-plugins-dccpclientsrc.html#GstDCCPClientSrc--sockfd" title='The "sockfd" property'>sockfd</a>"                   <a
 
81
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
 
82
>gint</a>                  : Read / Write
71
83
</pre>
72
84
</div>
73
85
<div class="refsect1" lang="en">
87
99
<p>
88
100
</p>
89
101
<div class="refsect2" lang="en">
90
 
<a name="id2522913"></a><h3>Example pipeline</h3>
 
102
<a name="id2863475"></a><h3>Example pipeline</h3>
91
103
<p>
92
104
</p>
93
105
<div class="informalexample"><pre class="programlisting">
110
122
<div class="refsynopsisdiv">
111
123
<h2>Synopsis</h2>
112
124
<div class="refsect2" lang="en">
113
 
<a name="id2522953"></a><h3>Element Information</h3>
 
125
<a name="id2863516"></a><h3>Element Information</h3>
114
126
<div class="variablelist"><table border="0">
115
127
<col align="left" valign="top">
116
128
<tbody>
133
145
</div>
134
146
<hr>
135
147
<div class="refsect2" lang="en">
136
 
<a name="id2523017"></a><h3>Element Pads</h3>
 
148
<a name="id2838311"></a><h3>Element Pads</h3>
137
149
<div class="variablelist"><table border="0">
138
150
<col align="left" valign="top">
139
151
<tbody>
181
193
<hr>
182
194
<div class="refsect2" lang="en">
183
195
<a name="GstDCCPClientSrc--ccid"></a><h3>The <code class="literal">"ccid"</code> property</h3>
184
 
<pre class="programlisting">  "ccid"                     gint                  : Read / Write</pre>
 
196
<pre class="programlisting">  "ccid"                     <a
 
197
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
 
198
>gint</a>                  : Read / Write</pre>
185
199
<p>The Congestion Control IDentified to be used.</p>
186
200
<p>Allowed values: &gt;= 2</p>
187
201
<p>Default value: 2</p>
189
203
<hr>
190
204
<div class="refsect2" lang="en">
191
205
<a name="GstDCCPClientSrc--close-socket"></a><h3>The <code class="literal">"close-socket"</code> property</h3>
192
 
<pre class="programlisting">  "close-socket"             gboolean              : Read / Write</pre>
 
206
<pre class="programlisting">  "close-socket"             <a
 
207
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
208
>gboolean</a>              : Read / Write</pre>
193
209
<p>Close socket at the end of stream.</p>
194
210
<p>Default value: TRUE</p>
195
211
</div>
196
212
<hr>
197
213
<div class="refsect2" lang="en">
198
214
<a name="GstDCCPClientSrc--host"></a><h3>The <code class="literal">"host"</code> property</h3>
199
 
<pre class="programlisting">  "host"                     gchar*                : Read / Write</pre>
 
215
<pre class="programlisting">  "host"                     <a
 
216
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
217
>gchar</a>*                : Read / Write</pre>
200
218
<p>The host IP address to receive packets from.</p>
201
219
<p>Default value: "127.0.0.1"</p>
202
220
</div>
203
221
<hr>
204
222
<div class="refsect2" lang="en">
205
223
<a name="GstDCCPClientSrc--port"></a><h3>The <code class="literal">"port"</code> property</h3>
206
 
<pre class="programlisting">  "port"                     gint                  : Read / Write</pre>
207
 
<p>The port to receive the packets from, 0=allocate.</p>
 
224
<pre class="programlisting">  "port"                     <a
 
225
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
 
226
>gint</a>                  : Read / Write</pre>
 
227
<p>The port to receive packets from.</p>
208
228
<p>Allowed values: [0,65535]</p>
209
229
<p>Default value: 5001</p>
210
230
</div>
211
231
<hr>
212
232
<div class="refsect2" lang="en">
213
233
<a name="GstDCCPClientSrc--sockfd"></a><h3>The <code class="literal">"sockfd"</code> property</h3>
214
 
<pre class="programlisting">  "sockfd"                   gint                  : Read / Write</pre>
 
234
<pre class="programlisting">  "sockfd"                   <a
 
235
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
 
236
>gint</a>                  : Read / Write</pre>
215
237
<p>The socket file descriptor.</p>
216
 
<p>Allowed values: &gt;= -1</p>
 
238
<p>Allowed values: &gt;= G_MAXULONG</p>
217
239
<p>Default value: -1</p>
218
240
</div>
219
241
</div>
222
244
<div class="refsect2" lang="en">
223
245
<a name="GstDCCPClientSrc-connected"></a><h3>The <code class="literal">"connected"</code> signal</h3>
224
246
<pre class="programlisting">void                user_function                      (<a class="link" href="gst-plugins-bad-plugins-dccpclientsrc.html#GstDCCPClientSrc">GstDCCPClientSrc</a> *gstdccpclientsrc,
225
 
                                                        gint              arg1,
226
 
                                                        gpointer          user_data)             : Run First</pre>
 
247
                                                        <a
 
248
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
 
249
>gint</a>              arg1,
 
250
                                                        <a
 
251
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
 
252
>gpointer</a>          user_data)             : Run First</pre>
227
253
<p>
228
254
 
229
255
</p>