blob: 4bd7f0902e80e57b9313f2bd4312abe13a4bcaf9 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>souphttpclientsink: GStreamer Good Plugins 1.0 Plugins Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GStreamer Good Plugins 1.0 Plugins Reference Manual">
<link rel="up" href="ch01.html" title="gst-plugins-good Elements">
<link rel="prev" href="gst-plugins-good-plugins-smpte.html" title="smpte">
<link rel="next" href="gst-plugins-good-plugins-souphttpsrc.html" title="souphttpsrc">
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
<a href="#gst-plugins-good-plugins-souphttpclientsink.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
<a href="#gst-plugins-good-plugins-souphttpclientsink.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
<a href="#gst-plugins-good-plugins-souphttpclientsink.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gst-plugins-good-plugins-smpte.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gst-plugins-good-plugins-souphttpsrc.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gst-plugins-good-plugins-souphttpclientsink"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-souphttpclientsink.top_of_page"></a>souphttpclientsink</span></h2>
<p>souphttpclientsink</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-souphttpclientsink.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-good-plugins-souphttpclientsink.html#GstSoupHttpClientSink--automatic-redirect" title="The “automatic-redirect” property">automatic-redirect</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glibglib-String-Utility-Functions.html#GStrv"><span class="type">GStrv</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-good-plugins-souphttpclientsink.html#GstSoupHttpClientSink--cookies" title="The “cookies” property">cookies</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="gst-plugins-good-plugins-souphttpclientsink.html#GstSoupHttpClientSink--location" title="The “location” property">location</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="gst-plugins-good-plugins-souphttpclientsink.html#GstSoupHttpClientSink--proxy" title="The “proxy” property">proxy</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="gst-plugins-good-plugins-souphttpclientsink.html#GstSoupHttpClientSink--proxy-id" title="The “proxy-id” property">proxy-id</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="gst-plugins-good-plugins-souphttpclientsink.html#GstSoupHttpClientSink--proxy-pw" title="The “proxy-pw” property">proxy-pw</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<span class="type">SoupSession</span> *</td>
<td class="property_name"><a class="link" href="gst-plugins-good-plugins-souphttpclientsink.html#GstSoupHttpClientSink--session" title="The “session” property">session</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="gst-plugins-good-plugins-souphttpclientsink.html#GstSoupHttpClientSink--user-agent" title="The “user-agent” property">user-agent</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="gst-plugins-good-plugins-souphttpclientsink.html#GstSoupHttpClientSink--user-id" title="The “user-id” property">user-id</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="gst-plugins-good-plugins-souphttpclientsink.html#GstSoupHttpClientSink--user-pw" title="The “user-pw” property">user-pw</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">SoupLoggerLogLevel</span></td>
<td class="property_name"><a class="link" href="gst-plugins-good-plugins-souphttpclientsink.html#GstSoupHttpClientSink--http-log-level" title="The “http-log-level” property">http-log-level</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-good-plugins-souphttpclientsink.html#GstSoupHttpClientSink--retries" title="The “retries” property">retries</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-good-plugins-souphttpclientsink.html#GstSoupHttpClientSink--retry-delay" title="The “retry-delay” property">retry-delay</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<a name="GstSoupHttpClientSink"></a><div class="refsect1">
<a name="gst-plugins-good-plugins-souphttpclientsink.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="gst-plugins-good-plugins-souphttpclientsink.html#GstSoupHttpClientSink-struct" title="struct GstSoupHttpClientSink">GstSoupHttpClientSink</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-souphttpclientsink.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0GstObject.html#GstObject-struct">GstObject</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0GstElement.html#GstElement-struct">GstElement</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0GstBaseSink.html#GstBaseSink-struct">GstBaseSink</a>
<span class="lineart">╰──</span> GstSoupHttpClientSink
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-souphttpclientsink.description"></a><h2>Description</h2>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<div class="refsect2">
<a name="id-1.2.233.7.2.1"></a><h3>Element Information</h3>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">plugin</span></p></td>
<td>
<a class="link" href="gst-plugins-good-plugins-plugin-soup.html#plugin-soup">soup</a>
</td>
</tr>
<tr>
<td><p><span class="term">author</span></p></td>
<td>David Schleef &lt;ds@entropywave.com&gt;</td>
</tr>
<tr>
<td><p><span class="term">class</span></p></td>
<td>Generic</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="id-1.2.233.7.2.2"></a><h3>Element Pads</h3>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">name</span></p></td>
<td>sink</td>
</tr>
<tr>
<td><p><span class="term">direction</span></p></td>
<td>sink</td>
</tr>
<tr>
<td><p><span class="term">presence</span></p></td>
<td>always</td>
</tr>
<tr>
<td><p><span class="term">details</span></p></td>
<td>ANY</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-souphttpclientsink.functions_details"></a><h2>Functions</h2>
<p></p>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-souphttpclientsink.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GstSoupHttpClientSink-struct"></a><h3>struct GstSoupHttpClientSink</h3>
<pre class="programlisting">struct GstSoupHttpClientSink;</pre>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-souphttpclientsink.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GstSoupHttpClientSink--automatic-redirect"></a><h3>The <code class="literal">“automatic-redirect”</code> property</h3>
<pre class="programlisting"> “automatic-redirect” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Automatically follow HTTP redirects (HTTP Status Code 3xx).</p>
<p>Flags: Read / Write</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="GstSoupHttpClientSink--cookies"></a><h3>The <code class="literal">“cookies”</code> property</h3>
<pre class="programlisting"> “cookies” <a href="/usr/share/gtk-doc/html/glibglib-String-Utility-Functions.html#GStrv"><span class="type">GStrv</span></a></pre>
<p>HTTP request cookies.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="GstSoupHttpClientSink--location"></a><h3>The <code class="literal">“location”</code> property</h3>
<pre class="programlisting"> “location” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>URI to send to.</p>
<p>Flags: Read / Write</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2">
<a name="GstSoupHttpClientSink--proxy"></a><h3>The <code class="literal">“proxy”</code> property</h3>
<pre class="programlisting"> “proxy” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>HTTP proxy server URI.</p>
<p>Flags: Read / Write</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2">
<a name="GstSoupHttpClientSink--proxy-id"></a><h3>The <code class="literal">“proxy-id”</code> property</h3>
<pre class="programlisting"> “proxy-id” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>user id for proxy authentication.</p>
<p>Flags: Read / Write</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2">
<a name="GstSoupHttpClientSink--proxy-pw"></a><h3>The <code class="literal">“proxy-pw”</code> property</h3>
<pre class="programlisting"> “proxy-pw” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>user password for proxy authentication.</p>
<p>Flags: Read / Write</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2">
<a name="GstSoupHttpClientSink--session"></a><h3>The <code class="literal">“session”</code> property</h3>
<pre class="programlisting"> “session” <span class="type">SoupSession</span> *</pre>
<p>SoupSession object to use for communication.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="GstSoupHttpClientSink--user-agent"></a><h3>The <code class="literal">“user-agent”</code> property</h3>
<pre class="programlisting"> “user-agent” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>Value of the User-Agent HTTP request header field.</p>
<p>Flags: Read / Write</p>
<p>Default value: "GStreamer souphttpclientsink "</p>
</div>
<hr>
<div class="refsect2">
<a name="GstSoupHttpClientSink--user-id"></a><h3>The <code class="literal">“user-id”</code> property</h3>
<pre class="programlisting"> “user-id” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>user id for authentication.</p>
<p>Flags: Read / Write</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2">
<a name="GstSoupHttpClientSink--user-pw"></a><h3>The <code class="literal">“user-pw”</code> property</h3>
<pre class="programlisting"> “user-pw” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>user password for authentication.</p>
<p>Flags: Read / Write</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2">
<a name="GstSoupHttpClientSink--http-log-level"></a><h3>The <code class="literal">“http-log-level”</code> property</h3>
<pre class="programlisting"> “http-log-level” <span class="type">SoupLoggerLogLevel</span></pre>
<p>Set log level for soup's HTTP session log.</p>
<p>Flags: Read / Write</p>
<p>Default value: SOUP_LOGGER_LOG_NONE</p>
</div>
<hr>
<div class="refsect2">
<a name="GstSoupHttpClientSink--retries"></a><h3>The <code class="literal">“retries”</code> property</h3>
<pre class="programlisting"> “retries” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>Maximum number of retries, zero to disable, -1 to retry forever.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: &gt;= G_MAXULONG</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GstSoupHttpClientSink--retry-delay"></a><h3>The <code class="literal">“retry-delay”</code> property</h3>
<pre class="programlisting"> “retry-delay” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>Delay in seconds between retries after a failure.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: &gt;= 1</p>
<p>Default value: 5</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>