docs/plugins/html/gst-plugins-good-plugins-souphttpsrc.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>souphttpsrc</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GStreamer Good Plugins 0.10 Plugins Reference Manual">
   8 <link rel="up" href="ch01.html" title="gst-plugins-good Elements">
   9 <link rel="prev" href="gst-plugins-good-plugins-smptealpha.html" title="smptealpha">
  10 <link rel="next" href="gst-plugins-good-plugins-spectrum.html" title="spectrum">
  11 <meta name="generator" content="GTK-Doc V1.18 (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-good-plugins-smptealpha.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 Good Plugins 0.10 Plugins Reference Manual</th>
  21 <td><a accesskey="n" href="gst-plugins-good-plugins-spectrum.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-good-plugins-souphttpsrc.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-souphttpsrc.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-good-plugins-souphttpsrc.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-good-plugins-souphttpsrc.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#gst-plugins-good-plugins-souphttpsrc.properties" class="shortcut">Properties</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="gst-plugins-good-plugins-souphttpsrc"></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-good-plugins-souphttpsrc.top_of_page"></a>souphttpsrc</span></h2>
  40 <p>souphttpsrc — Receive data as a client over the network via HTTP using SOUP</p>
  41 </td>
  42 <td valign="top" align="right"></td>
  43 </tr></table></div>
  44 <div class="refsynopsisdiv">
  45 <a name="gst-plugins-good-plugins-souphttpsrc.synopsis"></a><h2>Synopsis</h2>
  46 <a name="GstSoupHTTPSrc"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-souphttpsrc.html#GstSoupHTTPSrc-struct" title="struct GstSoupHTTPSrc">GstSoupHTTPSrc</a>;
  47 </pre>
  48 </div>
  49 <div class="refsect1">
  50 <a name="gst-plugins-good-plugins-souphttpsrc.object-hierarchy"></a><h2>Object Hierarchy</h2>
  51 <pre class="synopsis">
  52   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  53    +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
  54          +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
  55                +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseSrc.html">GstBaseSrc</a>
  56                      +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstPushSrc.html">GstPushSrc</a>
  57                            +----GstSoupHTTPSrc
  58 </pre>
  59 </div>
  60 <div class="refsect1">
  61 <a name="gst-plugins-good-plugins-souphttpsrc.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  62 <p>
  63 GstSoupHTTPSrc implements
  64  <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstUriHandler.html#GstURIHandler">GstURIHandler</a>.</p>
  65 </div>
  66 <div class="refsect1">
  67 <a name="gst-plugins-good-plugins-souphttpsrc.properties"></a><h2>Properties</h2>
  68 <pre class="synopsis">
  69   "<a class="link" href="gst-plugins-good-plugins-souphttpsrc.html#GstSoupHTTPSrc--automatic-redirect" title='The "automatic-redirect" property'>automatic-redirect</a>"       <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  70   "<a class="link" href="gst-plugins-good-plugins-souphttpsrc.html#GstSoupHTTPSrc--cookies" title='The "cookies" property'>cookies</a>"                  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Boxed-Types.html#GStrv"><span class="type">GStrv</span></a>                 : Read / Write
  71   "<a class="link" href="gst-plugins-good-plugins-souphttpsrc.html#GstSoupHTTPSrc--iradio-genre" title='The "iradio-genre" property'>iradio-genre</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read
  72   "<a class="link" href="gst-plugins-good-plugins-souphttpsrc.html#GstSoupHTTPSrc--iradio-mode" title='The "iradio-mode" property'>iradio-mode</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  73   "<a class="link" href="gst-plugins-good-plugins-souphttpsrc.html#GstSoupHTTPSrc--iradio-name" title='The "iradio-name" property'>iradio-name</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read
  74   "<a class="link" href="gst-plugins-good-plugins-souphttpsrc.html#GstSoupHTTPSrc--iradio-title" title='The "iradio-title" property'>iradio-title</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read
  75   "<a class="link" href="gst-plugins-good-plugins-souphttpsrc.html#GstSoupHTTPSrc--iradio-url" title='The "iradio-url" property'>iradio-url</a>"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read
  76   "<a class="link" href="gst-plugins-good-plugins-souphttpsrc.html#GstSoupHTTPSrc--location" title='The "location" property'>location</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
  77   "<a class="link" href="gst-plugins-good-plugins-souphttpsrc.html#GstSoupHTTPSrc--proxy" title='The "proxy" property'>proxy</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
  78   "<a class="link" href="gst-plugins-good-plugins-souphttpsrc.html#GstSoupHTTPSrc--user-agent" title='The "user-agent" property'>user-agent</a>"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
  79   "<a class="link" href="gst-plugins-good-plugins-souphttpsrc.html#GstSoupHTTPSrc--is-live" title='The "is-live" property'>is-live</a>"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  80   "<a class="link" href="gst-plugins-good-plugins-souphttpsrc.html#GstSoupHTTPSrc--proxy-id" title='The "proxy-id" property'>proxy-id</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
  81   "<a class="link" href="gst-plugins-good-plugins-souphttpsrc.html#GstSoupHTTPSrc--proxy-pw" title='The "proxy-pw" property'>proxy-pw</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
  82   "<a class="link" href="gst-plugins-good-plugins-souphttpsrc.html#GstSoupHTTPSrc--user-id" title='The "user-id" property'>user-id</a>"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
  83   "<a class="link" href="gst-plugins-good-plugins-souphttpsrc.html#GstSoupHTTPSrc--user-pw" title='The "user-pw" property'>user-pw</a>"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
  84   "<a class="link" href="gst-plugins-good-plugins-souphttpsrc.html#GstSoupHTTPSrc--extra-headers" title='The "extra-headers" property'>extra-headers</a>"            <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstStructure.html#GstStructure"><span class="type">GstStructure</span></a>*         : Read / Write
  85   "<a class="link" href="gst-plugins-good-plugins-souphttpsrc.html#GstSoupHTTPSrc--timeout" title='The "timeout" property'>timeout</a>"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write
  86 </pre>
  87 </div>
  88 <div class="refsect1">
  89 <a name="gst-plugins-good-plugins-souphttpsrc.description"></a><h2>Description</h2>
  90 <div class="refsynopsisdiv">
  91 <h2>Synopsis</h2>
  92 <div class="refsect2">
  93 <a name="idp20672624"></a><h3>Element Information</h3>
  94 <div class="variablelist"><table border="0">
  95 <col align="left" valign="top">
  96 <tbody>
  97 <tr>
  98 <td><p><span class="term">plugin</span></p></td>
  99 <td>
 100             <a class="link" href="gst-plugins-good-plugins-plugin-soup.html#plugin-soup">soup</a>
 101           </td>
 102 </tr>
 103 <tr>
 104 <td><p><span class="term">author</span></p></td>
 105 <td>Wouter Cloetens &lt;wouter@mind.be&gt;</td>
 106 </tr>
 107 <tr>
 108 <td><p><span class="term">class</span></p></td>
 109 <td>Source/Network</td>
 110 </tr>
 111 </tbody>
 112 </table></div>
 113 </div>
 114 <hr>
 115 <div class="refsect2">
 116 <a name="idp22423808"></a><h3>Element Pads</h3>
 117 <div class="variablelist"><table border="0">
 118 <col align="left" valign="top">
 119 <tbody>
 120 <tr>
 121 <td><p><span class="term">name</span></p></td>
 122 <td>src</td>
 123 </tr>
 124 <tr>
 125 <td><p><span class="term">direction</span></p></td>
 126 <td>source</td>
 127 </tr>
 128 <tr>
 129 <td><p><span class="term">presence</span></p></td>
 130 <td>always</td>
 131 </tr>
 132 <tr>
 133 <td><p><span class="term">details</span></p></td>
 134 <td>ANY</td>
 135 </tr>
 136 </tbody>
 137 </table></div>
 138 </div>
 139 </div>
 140 <p>
 141 </p>
 142 </div>
 143 <div class="refsect1">
 144 <a name="gst-plugins-good-plugins-souphttpsrc.details"></a><h2>Details</h2>
 145 <div class="refsect2">
 146 <a name="GstSoupHTTPSrc-struct"></a><h3>struct GstSoupHTTPSrc</h3>
 147 <pre class="programlisting">struct GstSoupHTTPSrc;</pre>
 148 <p>
 149 </p>
 150 </div>
 151 </div>
 152 <div class="refsect1">
 153 <a name="gst-plugins-good-plugins-souphttpsrc.property-details"></a><h2>Property Details</h2>
 154 <div class="refsect2">
 155 <a name="GstSoupHTTPSrc--automatic-redirect"></a><h3>The <code class="literal">"automatic-redirect"</code> property</h3>
 156 <pre class="programlisting">  "automatic-redirect"       <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 157 <p>Automatically follow HTTP redirects (HTTP Status Code 3xx).</p>
 158 <p>Default value: TRUE</p>
 159 </div>
 160 <hr>
 161 <div class="refsect2">
 162 <a name="GstSoupHTTPSrc--cookies"></a><h3>The <code class="literal">"cookies"</code> property</h3>
 163 <pre class="programlisting">  "cookies"                  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Boxed-Types.html#GStrv"><span class="type">GStrv</span></a>                 : Read / Write</pre>
 164 <p>HTTP request cookies.</p>
 165 </div>
 166 <hr>
 167 <div class="refsect2">
 168 <a name="GstSoupHTTPSrc--iradio-genre"></a><h3>The <code class="literal">"iradio-genre"</code> property</h3>
 169 <pre class="programlisting">  "iradio-genre"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read</pre>
 170 <p>Genre of the stream.</p>
 171 <p>Default value: NULL</p>
 172 </div>
 173 <hr>
 174 <div class="refsect2">
 175 <a name="GstSoupHTTPSrc--iradio-mode"></a><h3>The <code class="literal">"iradio-mode"</code> property</h3>
 176 <pre class="programlisting">  "iradio-mode"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 177 <p>Enable internet radio mode (extraction of shoutcast/icecast metadata).</p>
 178 <p>Default value: FALSE</p>
 179 </div>
 180 <hr>
 181 <div class="refsect2">
 182 <a name="GstSoupHTTPSrc--iradio-name"></a><h3>The <code class="literal">"iradio-name"</code> property</h3>
 183 <pre class="programlisting">  "iradio-name"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read</pre>
 184 <p>Name of the stream.</p>
 185 <p>Default value: NULL</p>
 186 </div>
 187 <hr>
 188 <div class="refsect2">
 189 <a name="GstSoupHTTPSrc--iradio-title"></a><h3>The <code class="literal">"iradio-title"</code> property</h3>
 190 <pre class="programlisting">  "iradio-title"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read</pre>
 191 <p>Name of currently playing song.</p>
 192 <p>Default value: NULL</p>
 193 </div>
 194 <hr>
 195 <div class="refsect2">
 196 <a name="GstSoupHTTPSrc--iradio-url"></a><h3>The <code class="literal">"iradio-url"</code> property</h3>
 197 <pre class="programlisting">  "iradio-url"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read</pre>
 198 <p>Homepage URL for radio stream.</p>
 199 <p>Default value: NULL</p>
 200 </div>
 201 <hr>
 202 <div class="refsect2">
 203 <a name="GstSoupHTTPSrc--location"></a><h3>The <code class="literal">"location"</code> property</h3>
 204 <pre class="programlisting">  "location"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 205 <p>Location to read from.</p>
 206 <p>Default value: ""</p>
 207 </div>
 208 <hr>
 209 <div class="refsect2">
 210 <a name="GstSoupHTTPSrc--proxy"></a><h3>The <code class="literal">"proxy"</code> property</h3>
 211 <pre class="programlisting">  "proxy"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 212 <p>HTTP proxy server URI.</p>
 213 <p>Default value: ""</p>
 214 </div>
 215 <hr>
 216 <div class="refsect2">
 217 <a name="GstSoupHTTPSrc--user-agent"></a><h3>The <code class="literal">"user-agent"</code> property</h3>
 218 <pre class="programlisting">  "user-agent"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 219 <p>Value of the User-Agent HTTP request header field.</p>
 220 <p>Default value: "GStreamer souphttpsrc "</p>
 221 </div>
 222 <hr>
 223 <div class="refsect2">
 224 <a name="GstSoupHTTPSrc--is-live"></a><h3>The <code class="literal">"is-live"</code> property</h3>
 225 <pre class="programlisting">  "is-live"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 226 <p>Act like a live source.</p>
 227 <p>Default value: FALSE</p>
 228 </div>
 229 <hr>
 230 <div class="refsect2">
 231 <a name="GstSoupHTTPSrc--proxy-id"></a><h3>The <code class="literal">"proxy-id"</code> property</h3>
 232 <pre class="programlisting">  "proxy-id"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 233 <p>HTTP proxy URI user id for authentication.</p>
 234 <p>Default value: ""</p>
 235 </div>
 236 <hr>
 237 <div class="refsect2">
 238 <a name="GstSoupHTTPSrc--proxy-pw"></a><h3>The <code class="literal">"proxy-pw"</code> property</h3>
 239 <pre class="programlisting">  "proxy-pw"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 240 <p>HTTP proxy URI user password for authentication.</p>
 241 <p>Default value: ""</p>
 242 </div>
 243 <hr>
 244 <div class="refsect2">
 245 <a name="GstSoupHTTPSrc--user-id"></a><h3>The <code class="literal">"user-id"</code> property</h3>
 246 <pre class="programlisting">  "user-id"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 247 <p>HTTP location URI user id for authentication.</p>
 248 <p>Default value: ""</p>
 249 </div>
 250 <hr>
 251 <div class="refsect2">
 252 <a name="GstSoupHTTPSrc--user-pw"></a><h3>The <code class="literal">"user-pw"</code> property</h3>
 253 <pre class="programlisting">  "user-pw"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 254 <p>HTTP location URI user password for authentication.</p>
 255 <p>Default value: ""</p>
 256 </div>
 257 <hr>
 258 <div class="refsect2">
 259 <a name="GstSoupHTTPSrc--extra-headers"></a><h3>The <code class="literal">"extra-headers"</code> property</h3>
 260 <pre class="programlisting">  "extra-headers"            <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstStructure.html#GstStructure"><span class="type">GstStructure</span></a>*         : Read / Write</pre>
 261 <p>Extra headers to append to the HTTP request.</p>
 262 </div>
 263 <hr>
 264 <div class="refsect2">
 265 <a name="GstSoupHTTPSrc--timeout"></a><h3>The <code class="literal">"timeout"</code> property</h3>
 266 <pre class="programlisting">  "timeout"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
 267 <p>Value in seconds to timeout a blocking I/O (0 = No timeout).</p>
 268 <p>Allowed values: &lt;= 3600</p>
 269 <p>Default value: 0</p>
 270 </div>
 271 </div>
 272 </div>
 273 <div class="footer">
 274 <hr>
 275           Generated by GTK-Doc V1.18</div>
 276 </body>
 277 </html>