docs/plugins/html/gst-plugins-base-plugins-multifdsink.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>multifdsink</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-gnomevfssrc.html" title="gnomevfssrc">
  10 <link rel="next" href="gst-plugins-base-plugins-oggdemux.html" title="oggdemux">
  11 <meta name="generator" content="GTK-Doc V1.17 (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-gnomevfssrc.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-oggdemux.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-multifdsink.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-base-plugins-multifdsink.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-base-plugins-multifdsink.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-base-plugins-multifdsink.properties" class="shortcut">Properties</a>
  31                    |
  32                   <a href="#gst-plugins-base-plugins-multifdsink.signals" class="shortcut">Signals</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="gst-plugins-base-plugins-multifdsink"></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-multifdsink.top_of_page"></a>multifdsink</span></h2>
  40 <p>multifdsink — Send data to multiple filedescriptors</p>
  41 </td>
  42 <td valign="top" align="right"></td>
  43 </tr></table></div>
  44 <div class="refsynopsisdiv">
  45 <a name="gst-plugins-base-plugins-multifdsink.synopsis"></a><h2>Synopsis</h2>
  46 <a name="GstMultiFdSink"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink-struct" title="struct GstMultiFdSink">GstMultiFdSink</a>;
  47 enum                <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstRecoverPolicy" title="enum GstRecoverPolicy">GstRecoverPolicy</a>;
  48 enum                <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstSyncMethod" title="enum GstSyncMethod">GstSyncMethod</a>;
  49 enum                <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstClientStatus" title="enum GstClientStatus">GstClientStatus</a>;
  50 enum                <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstTCPProtocol" title="enum GstTCPProtocol">GstTCPProtocol</a>;
  51 enum                <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstTCPUnitType" title="enum GstTCPUnitType">GstTCPUnitType</a>;
  52 </pre>
  53 </div>
  54 <div class="refsect1">
  55 <a name="gst-plugins-base-plugins-multifdsink.object-hierarchy"></a><h2>Object Hierarchy</h2>
  56 <pre class="synopsis">
  57   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  58    +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
  59          +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
  60                +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseSink.html">GstBaseSink</a>
  61                      +----GstMultiFdSink
  62                            +----<a class="link" href="gst-plugins-base-plugins-tcpserversink.html#GstTCPServerSink">GstTCPServerSink</a>
  63 </pre>
  64 </div>
  65 <div class="refsect1">
  66 <a name="gst-plugins-base-plugins-multifdsink.properties"></a><h2>Properties</h2>
  67 <pre class="synopsis">
  68   "<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--buffers-max" title='The "buffers-max" property'>buffers-max</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  69   "<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--buffers-queued" title='The "buffers-queued" property'>buffers-queued</a>"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read
  70   "<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--buffers-soft-max" title='The "buffers-soft-max" property'>buffers-soft-max</a>"         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  71   "<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--bytes-served" title='The "bytes-served" property'>bytes-served</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a>               : Read
  72   "<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--bytes-to-serve" title='The "bytes-to-serve" property'>bytes-to-serve</a>"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a>               : Read
  73   "<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--mode" title='The "mode" property'>mode</a>"                     <span class="type">GstFDSetMode</span>          : Read / Write
  74   "<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--protocol" title='The "protocol" property'>protocol</a>"                 <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstTCPProtocol" title="enum GstTCPProtocol"><span class="type">GstTCPProtocol</span></a>        : Read / Write
  75   "<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--recover-policy" title='The "recover-policy" property'>recover-policy</a>"           <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstRecoverPolicy" title="enum GstRecoverPolicy"><span class="type">GstRecoverPolicy</span></a>      : Read / Write
  76   "<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--sync-clients" title='The "sync-clients" property'>sync-clients</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  77   "<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--sync-method" title='The "sync-method" property'>sync-method</a>"              <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstSyncMethod" title="enum GstSyncMethod"><span class="type">GstSyncMethod</span></a>         : Read / Write
  78   "<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--timeout" title='The "timeout" property'>timeout</a>"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a>               : Read / Write
  79   "<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--buffers-min" title='The "buffers-min" property'>buffers-min</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  80   "<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--burst-unit" title='The "burst-unit" property'>burst-unit</a>"               <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstTCPUnitType" title="enum GstTCPUnitType"><span class="type">GstTCPUnitType</span></a>        : Read / Write
  81   "<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--burst-value" title='The "burst-value" property'>burst-value</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a>               : Read / Write
  82   "<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--bytes-min" title='The "bytes-min" property'>bytes-min</a>"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  83   "<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--time-min" title='The "time-min" property'>time-min</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a>                : Read / Write
  84   "<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--unit-type" title='The "unit-type" property'>unit-type</a>"                <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstTCPUnitType" title="enum GstTCPUnitType"><span class="type">GstTCPUnitType</span></a>        : Read / Write
  85   "<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--units-max" title='The "units-max" property'>units-max</a>"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a>                : Read / Write
  86   "<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--units-soft-max" title='The "units-soft-max" property'>units-soft-max</a>"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a>                : Read / Write
  87   "<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--qos-dscp" title='The "qos-dscp" property'>qos-dscp</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  88   "<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--handle-read" title='The "handle-read" property'>handle-read</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  89   "<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--resend-streamheader" title='The "resend-streamheader" property'>resend-streamheader</a>"      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  90   "<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--num-fds" title='The "num-fds" property'>num-fds</a>"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read
  91 </pre>
  92 </div>
  93 <div class="refsect1">
  94 <a name="gst-plugins-base-plugins-multifdsink.signals"></a><h2>Signals</h2>
  95 <pre class="synopsis">
  96   "<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink-add" title='The "add" signal'>add</a>"                                            : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a>
  97   "<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink-clear" title='The "clear" signal'>clear</a>"                                          : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a>
  98   "<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink-client-added" title='The "client-added" signal'>client-added</a>"                                   : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
  99   "<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink-client-removed" title='The "client-removed" signal'>client-removed</a>"                                 : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
 100   "<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink-get-stats" title='The "get-stats" signal'>get-stats</a>"                                      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a>
 101   "<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink-remove" title='The "remove" signal'>remove</a>"                                         : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a>
 102   "<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink-client-fd-removed" title='The "client-fd-removed" signal'>client-fd-removed</a>"                              : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
 103   "<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink-add-full" title='The "add-full" signal'>add-full</a>"                                       : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a>
 104   "<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink-remove-flush" title='The "remove-flush" signal'>remove-flush</a>"                                   : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a>
 105 </pre>
 106 </div>
 107 <div class="refsect1">
 108 <a name="gst-plugins-base-plugins-multifdsink.description"></a><h2>Description</h2>
 109 <p>
 110 This plugin writes incoming data to a set of file descriptors. The
 111 file descriptors can be added to multifdsink by emitting the <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink-add" title='The "add" signal'><span class="type">"add"</span></a> signal.
 112 For each descriptor added, the <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink-client-added" title='The "client-added" signal'><span class="type">"client-added"</span></a> signal will be called.
 113 </p>
 114 <p>
 115 As of version 0.10.8, a client can also be added with the <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink-add-full" title='The "add-full" signal'><span class="type">"add-full"</span></a> signal
 116 that allows for more control over what and how much data a client
 117 initially receives.
 118 </p>
 119 <p>
 120 Clients can be removed from multifdsink by emitting the <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink-remove" title='The "remove" signal'><span class="type">"remove"</span></a> signal. For
 121 each descriptor removed, the <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink-client-removed" title='The "client-removed" signal'><span class="type">"client-removed"</span></a> signal will be called. The
 122 <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink-client-removed" title='The "client-removed" signal'><span class="type">"client-removed"</span></a> signal can also be fired when multifdsink decides that a
 123 client is not active anymore or, depending on the value of the
 124 <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--recover-policy" title='The "recover-policy" property'><span class="type">"recover-policy"</span></a> property, if the client is reading too slowly.
 125 In all cases, multifdsink will never close a file descriptor itself.
 126 The user of multifdsink is responsible for closing all file descriptors.
 127 This can for example be done in response to the <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink-client-fd-removed" title='The "client-fd-removed" signal'><span class="type">"client-fd-removed"</span></a> signal.
 128 Note that multifdsink still has a reference to the file descriptor when the
 129 <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink-client-removed" title='The "client-removed" signal'><span class="type">"client-removed"</span></a> signal is emitted, so that "get-stats" can be performed on
 130 the descriptor; it is therefore not safe to close the file descriptor in
 131 the <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink-client-removed" title='The "client-removed" signal'><span class="type">"client-removed"</span></a> signal handler, and you should use the
 132 <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink-client-fd-removed" title='The "client-fd-removed" signal'><span class="type">"client-fd-removed"</span></a> signal to safely close the fd.
 133 </p>
 134 <p>
 135 Multifdsink internally keeps a queue of the incoming buffers and uses a
 136 separate thread to send the buffers to the clients. This ensures that no
 137 client write can block the pipeline and that clients can read with different
 138 speeds.
 139 </p>
 140 <p>
 141 When adding a client to multifdsink, the <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--sync-method" title='The "sync-method" property'><span class="type">"sync-method"</span></a> property will define
 142 which buffer in the queued buffers will be sent first to the client. Clients
 143 can be sent the most recent buffer (which might not be decodable by the
 144 client if it is not a keyframe), the next keyframe received in
 145 multifdsink (which can take some time depending on the keyframe rate), or the
 146 last received keyframe (which will cause a simple burst-on-connect).
 147 Multifdsink will always keep at least one keyframe in its internal buffers
 148 when the sync-mode is set to latest-keyframe.
 149 </p>
 150 <p>
 151 As of version 0.10.8, there are additional values for the <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--sync-method" title='The "sync-method" property'><span class="type">"sync-method"</span></a>
 152 property to allow finer control over burst-on-connect behaviour. By selecting
 153 the 'burst' method a minimum burst size can be chosen, 'burst-keyframe'
 154 additionally requires that the burst begin with a keyframe, and
 155 'burst-with-keyframe' attempts to burst beginning with a keyframe, but will
 156 prefer a minimum burst size even if it requires not starting with a keyframe.
 157 </p>
 158 <p>
 159 Multifdsink can be instructed to keep at least a minimum amount of data
 160 expressed in time or byte units in its internal queues with the the
 161 <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--time-min" title='The "time-min" property'><span class="type">"time-min"</span></a> and <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--bytes-min" title='The "bytes-min" property'><span class="type">"bytes-min"</span></a> properties respectively.
 162 These properties are useful if the application adds clients with the
 163 <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink-add-full" title='The "add-full" signal'><span class="type">"add-full"</span></a> signal to make sure that a burst connect can
 164 actually be honored.
 165 </p>
 166 <p>
 167 When streaming data, clients are allowed to read at a different rate than
 168 the rate at which multifdsink receives data. If the client is reading too
 169 fast, no data will be send to the client until multifdsink receives more
 170 data. If the client, however, reads too slowly, data for that client will be
 171 queued up in multifdsink. Two properties control the amount of data
 172 (buffers) that is queued in multifdsink: <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--buffers-max" title='The "buffers-max" property'><span class="type">"buffers-max"</span></a> and
 173 <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--buffers-soft-max" title='The "buffers-soft-max" property'><span class="type">"buffers-soft-max"</span></a>. A client that falls behind by
 174 <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--buffers-max" title='The "buffers-max" property'><span class="type">"buffers-max"</span></a> is removed from multifdsink forcibly.
 175 </p>
 176 <p>
 177 A client with a lag of at least <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--buffers-soft-max" title='The "buffers-soft-max" property'><span class="type">"buffers-soft-max"</span></a> enters the recovery
 178 procedure which is controlled with the <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--recover-policy" title='The "recover-policy" property'><span class="type">"recover-policy"</span></a> property.
 179 A recover policy of NONE will do nothing, RESYNC_LATEST will send the most recently
 180 received buffer as the next buffer for the client, RESYNC_SOFT_LIMIT
 181 positions the client to the soft limit in the buffer queue and
 182 RESYNC_KEYFRAME positions the client at the most recent keyframe in the
 183 buffer queue.
 184 </p>
 185 <p>
 186 multifdsink will by default synchronize on the clock before serving the
 187 buffers to the clients. This behaviour can be disabled by setting the sync
 188 property to FALSE. Multifdsink will by default not do QoS and will never
 189 drop late buffers.
 190 </p>
 191 <p>
 192 Last reviewed on 2006-09-12 (0.10.10)
 193 </p>
 194 <div class="refsynopsisdiv">
 195 <h2>Synopsis</h2>
 196 <div class="refsect2">
 197 <a name="idp12152560"></a><h3>Element Information</h3>
 198 <div class="variablelist"><table border="0">
 199 <col align="left" valign="top">
 200 <tbody>
 201 <tr>
 202 <td><p><span class="term">plugin</span></p></td>
 203 <td>
 204             <a class="link" href="gst-plugins-base-plugins-plugin-tcp.html#plugin-tcp">tcp</a>
 205           </td>
 206 </tr>
 207 <tr>
 208 <td><p><span class="term">author</span></p></td>
 209 <td>Thomas Vander Stichele &lt;thomas at apestaart dot org&gt;, Wim Taymans &lt;wim@fluendo.com&gt;</td>
 210 </tr>
 211 <tr>
 212 <td><p><span class="term">class</span></p></td>
 213 <td>Sink/Network</td>
 214 </tr>
 215 </tbody>
 216 </table></div>
 217 </div>
 218 <hr>
 219 <div class="refsect2">
 220 <a name="idp12159968"></a><h3>Element Pads</h3>
 221 <div class="variablelist"><table border="0">
 222 <col align="left" valign="top">
 223 <tbody>
 224 <tr>
 225 <td><p><span class="term">name</span></p></td>
 226 <td>sink</td>
 227 </tr>
 228 <tr>
 229 <td><p><span class="term">direction</span></p></td>
 230 <td>sink</td>
 231 </tr>
 232 <tr>
 233 <td><p><span class="term">presence</span></p></td>
 234 <td>always</td>
 235 </tr>
 236 <tr>
 237 <td><p><span class="term">details</span></p></td>
 238 <td>ANY</td>
 239 </tr>
 240 </tbody>
 241 </table></div>
 242 </div>
 243 </div>
 244 <p>
 245 </p>
 246 </div>
 247 <div class="refsect1">
 248 <a name="gst-plugins-base-plugins-multifdsink.details"></a><h2>Details</h2>
 249 <div class="refsect2">
 250 <a name="GstMultiFdSink-struct"></a><h3>struct GstMultiFdSink</h3>
 251 <pre class="programlisting">struct GstMultiFdSink;</pre>
 252 <p>
 253 The multifdsink object structure.
 254 </p>
 255 </div>
 256 <hr>
 257 <div class="refsect2">
 258 <a name="GstRecoverPolicy"></a><h3>enum GstRecoverPolicy</h3>
 259 <pre class="programlisting">typedef enum
 260 {
 261   GST_RECOVER_POLICY_NONE,
 262   GST_RECOVER_POLICY_RESYNC_LATEST,
 263   GST_RECOVER_POLICY_RESYNC_SOFT_LIMIT,
 264   GST_RECOVER_POLICY_RESYNC_KEYFRAME
 265 } GstRecoverPolicy;
 266 </pre>
 267 <p>
 268 Possible values for the recovery procedure to use when a client consumes
 269 data too slow and has a backlag of more that soft-limit buffers.
 270 </p>
 271 <div class="variablelist"><table border="0">
 272 <col align="left" valign="top">
 273 <tbody>
 274 <tr>
 275 <td><p><a name="GST-RECOVER-POLICY-NONE:CAPS"></a><span class="term"><code class="literal">GST_RECOVER_POLICY_NONE</code></span></p></td>
 276 <td>no recovering is done
 277 </td>
 278 </tr>
 279 <tr>
 280 <td><p><a name="GST-RECOVER-POLICY-RESYNC-LATEST:CAPS"></a><span class="term"><code class="literal">GST_RECOVER_POLICY_RESYNC_LATEST</code></span></p></td>
 281 <td>client is moved to last buffer
 282 </td>
 283 </tr>
 284 <tr>
 285 <td><p><a name="GST-RECOVER-POLICY-RESYNC-SOFT-LIMIT:CAPS"></a><span class="term"><code class="literal">GST_RECOVER_POLICY_RESYNC_SOFT_LIMIT</code></span></p></td>
 286 <td>client is moved to the soft limit
 287 </td>
 288 </tr>
 289 <tr>
 290 <td><p><a name="GST-RECOVER-POLICY-RESYNC-KEYFRAME:CAPS"></a><span class="term"><code class="literal">GST_RECOVER_POLICY_RESYNC_KEYFRAME</code></span></p></td>
 291 <td>client is moved to latest keyframe
 292 </td>
 293 </tr>
 294 </tbody>
 295 </table></div>
 296 </div>
 297 <hr>
 298 <div class="refsect2">
 299 <a name="GstSyncMethod"></a><h3>enum GstSyncMethod</h3>
 300 <pre class="programlisting">typedef enum
 301 {
 302   GST_SYNC_METHOD_LATEST,
 303   GST_SYNC_METHOD_NEXT_KEYFRAME,
 304   GST_SYNC_METHOD_LATEST_KEYFRAME,
 305   GST_SYNC_METHOD_BURST,
 306   GST_SYNC_METHOD_BURST_KEYFRAME,
 307   GST_SYNC_METHOD_BURST_WITH_KEYFRAME
 308 } GstSyncMethod;
 309 </pre>
 310 <p>
 311 This enum defines the selection of the first buffer that is sent
 312 to a new client.
 313 </p>
 314 <div class="variablelist"><table border="0">
 315 <col align="left" valign="top">
 316 <tbody>
 317 <tr>
 318 <td><p><a name="GST-SYNC-METHOD-LATEST:CAPS"></a><span class="term"><code class="literal">GST_SYNC_METHOD_LATEST</code></span></p></td>
 319 <td>client receives most recent buffer
 320 </td>
 321 </tr>
 322 <tr>
 323 <td><p><a name="GST-SYNC-METHOD-NEXT-KEYFRAME:CAPS"></a><span class="term"><code class="literal">GST_SYNC_METHOD_NEXT_KEYFRAME</code></span></p></td>
 324 <td>client receives next keyframe
 325 </td>
 326 </tr>
 327 <tr>
 328 <td><p><a name="GST-SYNC-METHOD-LATEST-KEYFRAME:CAPS"></a><span class="term"><code class="literal">GST_SYNC_METHOD_LATEST_KEYFRAME</code></span></p></td>
 329 <td>client receives latest keyframe (burst)
 330 </td>
 331 </tr>
 332 <tr>
 333 <td><p><a name="GST-SYNC-METHOD-BURST:CAPS"></a><span class="term"><code class="literal">GST_SYNC_METHOD_BURST</code></span></p></td>
 334 <td>client receives specific amount of data
 335 </td>
 336 </tr>
 337 <tr>
 338 <td><p><a name="GST-SYNC-METHOD-BURST-KEYFRAME:CAPS"></a><span class="term"><code class="literal">GST_SYNC_METHOD_BURST_KEYFRAME</code></span></p></td>
 339 <td>client receives specific amount of data
 340                                        starting from latest keyframe
 341 </td>
 342 </tr>
 343 <tr>
 344 <td><p><a name="GST-SYNC-METHOD-BURST-WITH-KEYFRAME:CAPS"></a><span class="term"><code class="literal">GST_SYNC_METHOD_BURST_WITH_KEYFRAME</code></span></p></td>
 345 <td>client receives specific amount of data from
 346                                        a keyframe, or if there is not enough data after
 347                                        the keyframe, starting before the keyframe
 348 </td>
 349 </tr>
 350 </tbody>
 351 </table></div>
 352 </div>
 353 <hr>
 354 <div class="refsect2">
 355 <a name="GstClientStatus"></a><h3>enum GstClientStatus</h3>
 356 <pre class="programlisting">typedef enum
 357 {
 358   GST_CLIENT_STATUS_OK          = 0,
 359   GST_CLIENT_STATUS_CLOSED      = 1,
 360   GST_CLIENT_STATUS_REMOVED     = 2,
 361   GST_CLIENT_STATUS_SLOW        = 3,
 362   GST_CLIENT_STATUS_ERROR       = 4,
 363   GST_CLIENT_STATUS_DUPLICATE   = 5,
 364   GST_CLIENT_STATUS_FLUSHING    = 6
 365 } GstClientStatus;
 366 </pre>
 367 <p>
 368 This specifies the reason why a client was removed from
 369 multifdsink and is received in the "client-removed" signal.
 370 </p>
 371 <div class="variablelist"><table border="0">
 372 <col align="left" valign="top">
 373 <tbody>
 374 <tr>
 375 <td><p><a name="GST-CLIENT-STATUS-OK:CAPS"></a><span class="term"><code class="literal">GST_CLIENT_STATUS_OK</code></span></p></td>
 376 <td>client is ok
 377 </td>
 378 </tr>
 379 <tr>
 380 <td><p><a name="GST-CLIENT-STATUS-CLOSED:CAPS"></a><span class="term"><code class="literal">GST_CLIENT_STATUS_CLOSED</code></span></p></td>
 381 <td>client closed the socket
 382 </td>
 383 </tr>
 384 <tr>
 385 <td><p><a name="GST-CLIENT-STATUS-REMOVED:CAPS"></a><span class="term"><code class="literal">GST_CLIENT_STATUS_REMOVED</code></span></p></td>
 386 <td>client is removed
 387 </td>
 388 </tr>
 389 <tr>
 390 <td><p><a name="GST-CLIENT-STATUS-SLOW:CAPS"></a><span class="term"><code class="literal">GST_CLIENT_STATUS_SLOW</code></span></p></td>
 391 <td>client is too slow
 392 </td>
 393 </tr>
 394 <tr>
 395 <td><p><a name="GST-CLIENT-STATUS-ERROR:CAPS"></a><span class="term"><code class="literal">GST_CLIENT_STATUS_ERROR</code></span></p></td>
 396 <td>client is in error
 397 </td>
 398 </tr>
 399 <tr>
 400 <td><p><a name="GST-CLIENT-STATUS-DUPLICATE:CAPS"></a><span class="term"><code class="literal">GST_CLIENT_STATUS_DUPLICATE</code></span></p></td>
 401 <td>same client added twice
 402 </td>
 403 </tr>
 404 <tr>
 405 <td><p><a name="GST-CLIENT-STATUS-FLUSHING:CAPS"></a><span class="term"><code class="literal">GST_CLIENT_STATUS_FLUSHING</code></span></p></td>
 406 <td>client is flushing out the remaining buffers.
 407 </td>
 408 </tr>
 409 </tbody>
 410 </table></div>
 411 </div>
 412 <hr>
 413 <div class="refsect2">
 414 <a name="GstTCPProtocol"></a><h3>enum GstTCPProtocol</h3>
 415 <pre class="programlisting">typedef enum
 416 {
 417   GST_TCP_PROTOCOL_NONE,
 418   GST_TCP_PROTOCOL_GDP
 419 } GstTCPProtocol;
 420 </pre>
 421 <p>
 422 This enum is provided by the tcp/multifd elements to configure the format of
 423 data transmission/reception.
 424 </p>
 425 <p>
 426 The GDP protocol wraps data buffers in a header that also carries format
 427 information and timestamps. The None value indicates the data is
 428 sent/received as-is. In that case, format information and timestamping
 429 must be transmitted separately, or implicit in the bytestream itself.
 430 </p>
 431 <div class="variablelist"><table border="0">
 432 <col align="left" valign="top">
 433 <tbody>
 434 <tr>
 435 <td><p><a name="GST-TCP-PROTOCOL-NONE:CAPS"></a><span class="term"><code class="literal">GST_TCP_PROTOCOL_NONE</code></span></p></td>
 436 <td>Raw data transmission
 437 </td>
 438 </tr>
 439 <tr>
 440 <td><p><a name="GST-TCP-PROTOCOL-GDP:CAPS"></a><span class="term"><code class="literal">GST_TCP_PROTOCOL_GDP</code></span></p></td>
 441 <td>
 442 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffers</span></a> are wrapped and sent/received using the
 443      GDP protocol.
 444 </td>
 445 </tr>
 446 </tbody>
 447 </table></div>
 448 </div>
 449 <hr>
 450 <div class="refsect2">
 451 <a name="GstTCPUnitType"></a><h3>enum GstTCPUnitType</h3>
 452 <pre class="programlisting">typedef enum
 453 {
 454   GST_TCP_UNIT_TYPE_UNDEFINED,
 455   GST_TCP_UNIT_TYPE_BUFFERS,
 456   GST_TCP_UNIT_TYPE_TIME,
 457   GST_TCP_UNIT_TYPE_BYTES
 458 } GstTCPUnitType;
 459 </pre>
 460 <p>
 461 The units used to specify limits.
 462 </p>
 463 <div class="variablelist"><table border="0">
 464 <col align="left" valign="top">
 465 <tbody>
 466 <tr>
 467 <td><p><a name="GST-TCP-UNIT-TYPE-UNDEFINED:CAPS"></a><span class="term"><code class="literal">GST_TCP_UNIT_TYPE_UNDEFINED</code></span></p></td>
 468 <td>undefined
 469 </td>
 470 </tr>
 471 <tr>
 472 <td><p><a name="GST-TCP-UNIT-TYPE-BUFFERS:CAPS"></a><span class="term"><code class="literal">GST_TCP_UNIT_TYPE_BUFFERS</code></span></p></td>
 473 <td>buffers
 474 </td>
 475 </tr>
 476 <tr>
 477 <td><p><a name="GST-TCP-UNIT-TYPE-TIME:CAPS"></a><span class="term"><code class="literal">GST_TCP_UNIT_TYPE_TIME</code></span></p></td>
 478 <td>timeunits (in nanoseconds)
 479 </td>
 480 </tr>
 481 <tr>
 482 <td><p><a name="GST-TCP-UNIT-TYPE-BYTES:CAPS"></a><span class="term"><code class="literal">GST_TCP_UNIT_TYPE_BYTES</code></span></p></td>
 483 <td>bytes
 484 </td>
 485 </tr>
 486 </tbody>
 487 </table></div>
 488 </div>
 489 </div>
 490 <div class="refsect1">
 491 <a name="gst-plugins-base-plugins-multifdsink.property-details"></a><h2>Property Details</h2>
 492 <div class="refsect2">
 493 <a name="GstMultiFdSink--buffers-max"></a><h3>The <code class="literal">"buffers-max"</code> property</h3>
 494 <pre class="programlisting">  "buffers-max"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 495 <p>max number of buffers to queue for a client (-1 = no limit).</p>
 496 <p>Allowed values: &gt;= G_MAXULONG</p>
 497 <p>Default value: -1</p>
 498 </div>
 499 <hr>
 500 <div class="refsect2">
 501 <a name="GstMultiFdSink--buffers-queued"></a><h3>The <code class="literal">"buffers-queued"</code> property</h3>
 502 <pre class="programlisting">  "buffers-queued"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read</pre>
 503 <p>Number of buffers currently queued.</p>
 504 <p>Default value: 0</p>
 505 </div>
 506 <hr>
 507 <div class="refsect2">
 508 <a name="GstMultiFdSink--buffers-soft-max"></a><h3>The <code class="literal">"buffers-soft-max"</code> property</h3>
 509 <pre class="programlisting">  "buffers-soft-max"         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 510 <p>Recover client when going over this limit (-1 = no limit).</p>
 511 <p>Allowed values: &gt;= G_MAXULONG</p>
 512 <p>Default value: -1</p>
 513 </div>
 514 <hr>
 515 <div class="refsect2">
 516 <a name="GstMultiFdSink--bytes-served"></a><h3>The <code class="literal">"bytes-served"</code> property</h3>
 517 <pre class="programlisting">  "bytes-served"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a>               : Read</pre>
 518 <p>Total number of bytes send to all clients.</p>
 519 <p>Default value: 0</p>
 520 </div>
 521 <hr>
 522 <div class="refsect2">
 523 <a name="GstMultiFdSink--bytes-to-serve"></a><h3>The <code class="literal">"bytes-to-serve"</code> property</h3>
 524 <pre class="programlisting">  "bytes-to-serve"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a>               : Read</pre>
 525 <p>Number of bytes received to serve to clients.</p>
 526 <p>Default value: 0</p>
 527 </div>
 528 <hr>
 529 <div class="refsect2">
 530 <a name="GstMultiFdSink--mode"></a><h3>The <code class="literal">"mode"</code> property</h3>
 531 <pre class="programlisting">  "mode"                     <span class="type">GstFDSetMode</span>          : Read / Write</pre>
 532 <p>The mode for selecting activity on the fds (deprecated).</p>
 533 <p>Default value: Poll</p>
 534 </div>
 535 <hr>
 536 <div class="refsect2">
 537 <a name="GstMultiFdSink--protocol"></a><h3>The <code class="literal">"protocol"</code> property</h3>
 538 <pre class="programlisting">  "protocol"                 <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstTCPProtocol" title="enum GstTCPProtocol"><span class="type">GstTCPProtocol</span></a>        : Read / Write</pre>
 539 <p>The protocol to wrap data in. GDP protocol here is deprecated. Please use gdppay element.</p>
 540 <p>Default value: GST_TCP_PROTOCOL_NONE</p>
 541 </div>
 542 <hr>
 543 <div class="refsect2">
 544 <a name="GstMultiFdSink--recover-policy"></a><h3>The <code class="literal">"recover-policy"</code> property</h3>
 545 <pre class="programlisting">  "recover-policy"           <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstRecoverPolicy" title="enum GstRecoverPolicy"><span class="type">GstRecoverPolicy</span></a>      : Read / Write</pre>
 546 <p>How to recover when client reaches the soft max.</p>
 547 <p>Default value: Do not try to recover</p>
 548 </div>
 549 <hr>
 550 <div class="refsect2">
 551 <a name="GstMultiFdSink--sync-clients"></a><h3>The <code class="literal">"sync-clients"</code> property</h3>
 552 <pre class="programlisting">  "sync-clients"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 553 <p>(DEPRECATED) Sync clients to a keyframe.</p>
 554 <p>Default value: FALSE</p>
 555 </div>
 556 <hr>
 557 <div class="refsect2">
 558 <a name="GstMultiFdSink--sync-method"></a><h3>The <code class="literal">"sync-method"</code> property</h3>
 559 <pre class="programlisting">  "sync-method"              <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstSyncMethod" title="enum GstSyncMethod"><span class="type">GstSyncMethod</span></a>         : Read / Write</pre>
 560 <p>How to sync new clients to the stream.</p>
 561 <p>Default value: Serve starting from the latest buffer</p>
 562 </div>
 563 <hr>
 564 <div class="refsect2">
 565 <a name="GstMultiFdSink--timeout"></a><h3>The <code class="literal">"timeout"</code> property</h3>
 566 <pre class="programlisting">  "timeout"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a>               : Read / Write</pre>
 567 <p>Maximum inactivity timeout in nanoseconds for a client (0 = no limit).</p>
 568 <p>Default value: 0</p>
 569 </div>
 570 <hr>
 571 <div class="refsect2">
 572 <a name="GstMultiFdSink--buffers-min"></a><h3>The <code class="literal">"buffers-min"</code> property</h3>
 573 <pre class="programlisting">  "buffers-min"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 574 <p>min number of buffers to queue (-1 = as few as possible).</p>
 575 <p>Allowed values: &gt;= G_MAXULONG</p>
 576 <p>Default value: -1</p>
 577 </div>
 578 <hr>
 579 <div class="refsect2">
 580 <a name="GstMultiFdSink--burst-unit"></a><h3>The <code class="literal">"burst-unit"</code> property</h3>
 581 <pre class="programlisting">  "burst-unit"               <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstTCPUnitType" title="enum GstTCPUnitType"><span class="type">GstTCPUnitType</span></a>        : Read / Write</pre>
 582 <p>The format of the burst units (when sync-method is burst[[-with]-keyframe]).</p>
 583 <p>Default value: Undefined</p>
 584 </div>
 585 <hr>
 586 <div class="refsect2">
 587 <a name="GstMultiFdSink--burst-value"></a><h3>The <code class="literal">"burst-value"</code> property</h3>
 588 <pre class="programlisting">  "burst-value"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a>               : Read / Write</pre>
 589 <p>The amount of burst expressed in burst-unit.</p>
 590 <p>Default value: 0</p>
 591 </div>
 592 <hr>
 593 <div class="refsect2">
 594 <a name="GstMultiFdSink--bytes-min"></a><h3>The <code class="literal">"bytes-min"</code> property</h3>
 595 <pre class="programlisting">  "bytes-min"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 596 <p>min number of bytes to queue (-1 = as little as possible).</p>
 597 <p>Allowed values: &gt;= G_MAXULONG</p>
 598 <p>Default value: -1</p>
 599 </div>
 600 <hr>
 601 <div class="refsect2">
 602 <a name="GstMultiFdSink--time-min"></a><h3>The <code class="literal">"time-min"</code> property</h3>
 603 <pre class="programlisting">  "time-min"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a>                : Read / Write</pre>
 604 <p>min number of time to queue (-1 = as little as possible).</p>
 605 <p>Allowed values: &gt;= G_MAXULONG</p>
 606 <p>Default value: -1</p>
 607 </div>
 608 <hr>
 609 <div class="refsect2">
 610 <a name="GstMultiFdSink--unit-type"></a><h3>The <code class="literal">"unit-type"</code> property</h3>
 611 <pre class="programlisting">  "unit-type"                <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstTCPUnitType" title="enum GstTCPUnitType"><span class="type">GstTCPUnitType</span></a>        : Read / Write</pre>
 612 <p>The unit to measure the max/soft-max/queued properties.</p>
 613 <p>Default value: Buffers</p>
 614 </div>
 615 <hr>
 616 <div class="refsect2">
 617 <a name="GstMultiFdSink--units-max"></a><h3>The <code class="literal">"units-max"</code> property</h3>
 618 <pre class="programlisting">  "units-max"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a>                : Read / Write</pre>
 619 <p>max number of units to queue (-1 = no limit).</p>
 620 <p>Allowed values: &gt;= G_MAXULONG</p>
 621 <p>Default value: -1</p>
 622 </div>
 623 <hr>
 624 <div class="refsect2">
 625 <a name="GstMultiFdSink--units-soft-max"></a><h3>The <code class="literal">"units-soft-max"</code> property</h3>
 626 <pre class="programlisting">  "units-soft-max"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a>                : Read / Write</pre>
 627 <p>Recover client when going over this limit (-1 = no limit).</p>
 628 <p>Allowed values: &gt;= G_MAXULONG</p>
 629 <p>Default value: -1</p>
 630 </div>
 631 <hr>
 632 <div class="refsect2">
 633 <a name="GstMultiFdSink--qos-dscp"></a><h3>The <code class="literal">"qos-dscp"</code> property</h3>
 634 <pre class="programlisting">  "qos-dscp"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 635 <p>Quality of Service, differentiated services code point (-1 default).</p>
 636 <p>Allowed values: [G_MAXULONG,63]</p>
 637 <p>Default value: -1</p>
 638 </div>
 639 <hr>
 640 <div class="refsect2">
 641 <a name="GstMultiFdSink--handle-read"></a><h3>The <code class="literal">"handle-read"</code> property</h3>
 642 <pre class="programlisting">  "handle-read"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 643 <p>Handle client reads and discard the data.</p>
 644 <p>Default value: TRUE</p>
 645 </div>
 646 <hr>
 647 <div class="refsect2">
 648 <a name="GstMultiFdSink--resend-streamheader"></a><h3>The <code class="literal">"resend-streamheader"</code> property</h3>
 649 <pre class="programlisting">  "resend-streamheader"      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 650 <p>Resend the streamheader if it changes in the caps.</p>
 651 <p>Default value: TRUE</p>
 652 </div>
 653 <hr>
 654 <div class="refsect2">
 655 <a name="GstMultiFdSink--num-fds"></a><h3>The <code class="literal">"num-fds"</code> property</h3>
 656 <pre class="programlisting">  "num-fds"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read</pre>
 657 <p>The current number of client file descriptors.</p>
 658 <p>Default value: 0</p>
 659 </div>
 660 </div>
 661 <div class="refsect1">
 662 <a name="gst-plugins-base-plugins-multifdsink.signal-details"></a><h2>Signal Details</h2>
 663 <div class="refsect2">
 664 <a name="GstMultiFdSink-add"></a><h3>The <code class="literal">"add"</code> signal</h3>
 665 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink"><span class="type">GstMultiFdSink</span></a> *gstmultifdsink,
 666                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>            fd,
 667                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>        user_data)           : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a></pre>
 668 <p>
 669 Hand the given open file descriptor to multifdsink to write to.
 670 </p>
 671 <div class="variablelist"><table border="0">
 672 <col align="left" valign="top">
 673 <tbody>
 674 <tr>
 675 <td><p><span class="term"><em class="parameter"><code>gstmultifdsink</code></em> :</span></p></td>
 676 <td>the multifdsink element to emit this signal on</td>
 677 </tr>
 678 <tr>
 679 <td><p><span class="term"><em class="parameter"><code>fd</code></em> :</span></p></td>
 680 <td>the file descriptor to add to multifdsink</td>
 681 </tr>
 682 <tr>
 683 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 684 <td>user data set when the signal handler was connected.</td>
 685 </tr>
 686 </tbody>
 687 </table></div>
 688 </div>
 689 <hr>
 690 <div class="refsect2">
 691 <a name="GstMultiFdSink-clear"></a><h3>The <code class="literal">"clear"</code> signal</h3>
 692 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink"><span class="type">GstMultiFdSink</span></a> *gstmultifdsink,
 693                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>        user_data)           : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a></pre>
 694 <p>
 695 Remove all file descriptors from multifdsink.  Since multifdsink did not
 696 open fd's itself, it does not explicitly close the fd.  The application
 697 should do so by connecting to the client-fd-removed callback.
 698 </p>
 699 <div class="variablelist"><table border="0">
 700 <col align="left" valign="top">
 701 <tbody>
 702 <tr>
 703 <td><p><span class="term"><em class="parameter"><code>gstmultifdsink</code></em> :</span></p></td>
 704 <td>the multifdsink element to emit this signal on</td>
 705 </tr>
 706 <tr>
 707 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 708 <td>user data set when the signal handler was connected.</td>
 709 </tr>
 710 </tbody>
 711 </table></div>
 712 </div>
 713 <hr>
 714 <div class="refsect2">
 715 <a name="GstMultiFdSink-client-added"></a><h3>The <code class="literal">"client-added"</code> signal</h3>
 716 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink"><span class="type">GstMultiFdSink</span></a> *gstmultifdsink,
 717                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>            fd,
 718                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>        user_data)           : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 719 <p>
 720 The given file descriptor was added to multifdsink. This signal will
 721 be emitted from the streaming thread so application should be prepared
 722 for that.
 723 </p>
 724 <div class="variablelist"><table border="0">
 725 <col align="left" valign="top">
 726 <tbody>
 727 <tr>
 728 <td><p><span class="term"><em class="parameter"><code>gstmultifdsink</code></em> :</span></p></td>
 729 <td>the multifdsink element that emitted this signal</td>
 730 </tr>
 731 <tr>
 732 <td><p><span class="term"><em class="parameter"><code>fd</code></em> :</span></p></td>
 733 <td>the file descriptor that was added to multifdsink</td>
 734 </tr>
 735 <tr>
 736 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 737 <td>user data set when the signal handler was connected.</td>
 738 </tr>
 739 </tbody>
 740 </table></div>
 741 </div>
 742 <hr>
 743 <div class="refsect2">
 744 <a name="GstMultiFdSink-client-removed"></a><h3>The <code class="literal">"client-removed"</code> signal</h3>
 745 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink"><span class="type">GstMultiFdSink</span></a> *gstmultifdsink,
 746                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>            fd,
 747                                                         <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstClientStatus" title="enum GstClientStatus"><span class="type">GstClientStatus</span></a> status,
 748                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>        user_data)           : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 749 <p>
 750 The given file descriptor is about to be removed from multifdsink. This
 751 signal will be emitted from the streaming thread so applications should
 752 be prepared for that.
 753 </p>
 754 <p>
 755 <em class="parameter"><code>gstmultifdsink</code></em> still holds a handle to <em class="parameter"><code>fd</code></em> so it is possible to call
 756 the get-stats signal from this callback. For the same reason it is
 757 not safe to <code class="function">close()</code> and reuse <em class="parameter"><code>fd</code></em> in this callback.
 758 </p>
 759 <div class="variablelist"><table border="0">
 760 <col align="left" valign="top">
 761 <tbody>
 762 <tr>
 763 <td><p><span class="term"><em class="parameter"><code>gstmultifdsink</code></em> :</span></p></td>
 764 <td>the multifdsink element that emitted this signal</td>
 765 </tr>
 766 <tr>
 767 <td><p><span class="term"><em class="parameter"><code>fd</code></em> :</span></p></td>
 768 <td>the file descriptor that is to be removed from multifdsink</td>
 769 </tr>
 770 <tr>
 771 <td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td>
 772 <td>the reason why the client was removed</td>
 773 </tr>
 774 <tr>
 775 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 776 <td>user data set when the signal handler was connected.</td>
 777 </tr>
 778 </tbody>
 779 </table></div>
 780 </div>
 781 <hr>
 782 <div class="refsect2">
 783 <a name="GstMultiFdSink-get-stats"></a><h3>The <code class="literal">"get-stats"</code> signal</h3>
 784 <pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Value-arrays.html#GValueArray"><span class="returnvalue">GValueArray</span></a>*        user_function                      (<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink"><span class="type">GstMultiFdSink</span></a> *gstmultifdsink,
 785                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>            fd,
 786                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>        user_data)           : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a></pre>
 787 <p>
 788 Get statistics about <em class="parameter"><code>fd</code></em>. This function returns a GValueArray to ease
 789 automatic wrapping for bindings.
 790 </p>
 791 <div class="variablelist"><table border="0">
 792 <col align="left" valign="top">
 793 <tbody>
 794 <tr>
 795 <td><p><span class="term"><em class="parameter"><code>gstmultifdsink</code></em> :</span></p></td>
 796 <td>the multifdsink element to emit this signal on</td>
 797 </tr>
 798 <tr>
 799 <td><p><span class="term"><em class="parameter"><code>fd</code></em> :</span></p></td>
 800 <td>the file descriptor to get stats of from multifdsink</td>
 801 </tr>
 802 <tr>
 803 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 804 <td>user data set when the signal handler was connected.</td>
 805 </tr>
 806 <tr>
 807 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 808 <td>a GValueArray with the statistics. The array contains guint64
 809 values that represent respectively: total number of bytes sent, time
 810 when the client was added, time when the client was
 811 disconnected/removed, time the client is/was active, last activity
 812 time (in epoch seconds), number of buffers dropped.
 813 All times are expressed in nanoseconds (GstClockTime).
 814 The array can be 0-length if the client was not found.</td>
 815 </tr>
 816 </tbody>
 817 </table></div>
 818 </div>
 819 <hr>
 820 <div class="refsect2">
 821 <a name="GstMultiFdSink-remove"></a><h3>The <code class="literal">"remove"</code> signal</h3>
 822 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink"><span class="type">GstMultiFdSink</span></a> *gstmultifdsink,
 823                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>            fd,
 824                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>        user_data)           : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a></pre>
 825 <p>
 826 Remove the given open file descriptor from multifdsink.
 827 </p>
 828 <div class="variablelist"><table border="0">
 829 <col align="left" valign="top">
 830 <tbody>
 831 <tr>
 832 <td><p><span class="term"><em class="parameter"><code>gstmultifdsink</code></em> :</span></p></td>
 833 <td>the multifdsink element to emit this signal on</td>
 834 </tr>
 835 <tr>
 836 <td><p><span class="term"><em class="parameter"><code>fd</code></em> :</span></p></td>
 837 <td>the file descriptor to remove from multifdsink</td>
 838 </tr>
 839 <tr>
 840 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 841 <td>user data set when the signal handler was connected.</td>
 842 </tr>
 843 </tbody>
 844 </table></div>
 845 </div>
 846 <hr>
 847 <div class="refsect2">
 848 <a name="GstMultiFdSink-client-fd-removed"></a><h3>The <code class="literal">"client-fd-removed"</code> signal</h3>
 849 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink"><span class="type">GstMultiFdSink</span></a> *gstmultifdsink,
 850                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>            fd,
 851                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>        user_data)           : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 852 <p>
 853 The given file descriptor was removed from multifdsink. This signal will
 854 be emitted from the streaming thread so applications should be prepared
 855 for that.
 856 </p>
 857 <p>
 858 In this callback, <em class="parameter"><code>gstmultifdsink</code></em> has removed all the information
 859 associated with <em class="parameter"><code>fd</code></em> and it is therefore not possible to call get-stats
 860 with <em class="parameter"><code>fd</code></em>. It is however safe to <code class="function">close()</code> and reuse <em class="parameter"><code>fd</code></em> in the callback.
 861 </p>
 862 <div class="variablelist"><table border="0">
 863 <col align="left" valign="top">
 864 <tbody>
 865 <tr>
 866 <td><p><span class="term"><em class="parameter"><code>gstmultifdsink</code></em> :</span></p></td>
 867 <td>the multifdsink element that emitted this signal</td>
 868 </tr>
 869 <tr>
 870 <td><p><span class="term"><em class="parameter"><code>fd</code></em> :</span></p></td>
 871 <td>the file descriptor that was removed from multifdsink</td>
 872 </tr>
 873 <tr>
 874 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 875 <td>user data set when the signal handler was connected.</td>
 876 </tr>
 877 </tbody>
 878 </table></div>
 879 <p class="since">Since 0.10.7</p>
 880 </div>
 881 <hr>
 882 <div class="refsect2">
 883 <a name="GstMultiFdSink-add-full"></a><h3>The <code class="literal">"add-full"</code> signal</h3>
 884 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink"><span class="type">GstMultiFdSink</span></a> *gstmultifdsink,
 885                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>            fd,
 886                                                         <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstSyncMethod" title="enum GstSyncMethod"><span class="type">GstSyncMethod</span></a>   sync,
 887                                                         <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstTCPUnitType" title="enum GstTCPUnitType"><span class="type">GstTCPUnitType</span></a>  unit_type_min,
 888                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a>         value_min,
 889                                                         <a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstTCPUnitType" title="enum GstTCPUnitType"><span class="type">GstTCPUnitType</span></a>  unit_type_max,
 890                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a>         value_max,
 891                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>        user_data)           : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a></pre>
 892 <p>
 893 Hand the given open file descriptor to multifdsink to write to and
 894 specify the burst parameters for the new connection.
 895 </p>
 896 <div class="variablelist"><table border="0">
 897 <col align="left" valign="top">
 898 <tbody>
 899 <tr>
 900 <td><p><span class="term"><em class="parameter"><code>gstmultifdsink</code></em> :</span></p></td>
 901 <td>the multifdsink element to emit this signal on</td>
 902 </tr>
 903 <tr>
 904 <td><p><span class="term"><em class="parameter"><code>fd</code></em> :</span></p></td>
 905 <td>the file descriptor to add to multifdsink</td>
 906 </tr>
 907 <tr>
 908 <td><p><span class="term"><em class="parameter"><code>sync</code></em> :</span></p></td>
 909 <td>the sync method to use</td>
 910 </tr>
 911 <tr>
 912 <td><p><span class="term"><em class="parameter"><code>unit_type_min</code></em> :</span></p></td>
 913 <td>the unit-type of <em class="parameter"><code>value_min</code></em>
 914 </td>
 915 </tr>
 916 <tr>
 917 <td><p><span class="term"><em class="parameter"><code>value_min</code></em> :</span></p></td>
 918 <td>the minimum amount of data to burst expressed in
 919 <em class="parameter"><code>unit_type_min</code></em> units.</td>
 920 </tr>
 921 <tr>
 922 <td><p><span class="term"><em class="parameter"><code>unit_type_max</code></em> :</span></p></td>
 923 <td>the unit-type of <em class="parameter"><code>value_max</code></em>
 924 </td>
 925 </tr>
 926 <tr>
 927 <td><p><span class="term"><em class="parameter"><code>value_max</code></em> :</span></p></td>
 928 <td>the maximum amount of data to burst expressed in
 929 <em class="parameter"><code>unit_type_max</code></em> units.</td>
 930 </tr>
 931 <tr>
 932 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 933 <td>user data set when the signal handler was connected.</td>
 934 </tr>
 935 </tbody>
 936 </table></div>
 937 </div>
 938 <hr>
 939 <div class="refsect2">
 940 <a name="GstMultiFdSink-remove-flush"></a><h3>The <code class="literal">"remove-flush"</code> signal</h3>
 941 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink"><span class="type">GstMultiFdSink</span></a> *gstmultifdsink,
 942                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>            fd,
 943                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>        user_data)           : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a></pre>
 944 <p>
 945 Remove the given open file descriptor from multifdsink after flushing all
 946 the pending data to the fd.
 947 </p>
 948 <div class="variablelist"><table border="0">
 949 <col align="left" valign="top">
 950 <tbody>
 951 <tr>
 952 <td><p><span class="term"><em class="parameter"><code>gstmultifdsink</code></em> :</span></p></td>
 953 <td>the multifdsink element to emit this signal on</td>
 954 </tr>
 955 <tr>
 956 <td><p><span class="term"><em class="parameter"><code>fd</code></em> :</span></p></td>
 957 <td>the file descriptor to remove from multifdsink</td>
 958 </tr>
 959 <tr>
 960 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 961 <td>user data set when the signal handler was connected.</td>
 962 </tr>
 963 </tbody>
 964 </table></div>
 965 </div>
 966 </div>
 967 <div class="refsect1">
 968 <a name="gst-plugins-base-plugins-multifdsink.see-also"></a><h2>See Also</h2>
 969 tcpserversink
 970 </div>
 971 </div>
 972 <div class="footer">
 973 <hr>
 974           Generated by GTK-Doc V1.17</div>
 975 </body>
 976 </html>