<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>multifdsink</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<link rel="start" href="index.html" title="GStreamer Base Plugins 0.10 Plugins Reference Manual">
<link rel="up" href="ch01.html" title="gst-plugins-base Elements">
<link rel="prev" href="gst-plugins-base-plugins-gnomevfssrc.html" title="gnomevfssrc">
<link rel="next" href="gst-plugins-base-plugins-oggdemux.html" title="oggdemux">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="gst-plugins-base Elements">
<link rel="chapter" href="ch02.html" title="gst-plugins-base Plugins">
</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="2">
<tr valign="middle">
<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>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GStreamer Base Plugins 0.10 Plugins Reference Manual</th>
<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>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2567802" class="shortcut">Top</a>
 | 
<a href="#id2567948" class="shortcut">Description</a>
 | 
<a href="#id2584678" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id2562922" class="shortcut">Properties</a>
 | 
<a href="#id2567870" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="gst-plugins-base-plugins-multifdsink"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2567802"></a><span class="refentrytitle">multifdsink</span>
</h2>
<p>multifdsink — Send data to multiple file descriptors</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<a name="GstMultiFdSink"></a><pre class="synopsis">
<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink-struct">GstMultiFdSink</a>;
enum <a href="gst-plugins-base-plugins-multifdsink.html#GstRecoverPolicy">GstRecoverPolicy</a>;
enum <a href="gst-plugins-base-plugins-multifdsink.html#GstSyncMethod">GstSyncMethod</a>;
enum <a href="gst-plugins-base-plugins-multifdsink.html#GstClientStatus">GstClientStatus</a>;
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2584678"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GstObject
+----GstElement
+----GstBaseSink
+----GstMultiFdSink
+----<a href="gst-plugins-base-plugins-tcpserversink.html#GstTCPServerSink">GstTCPServerSink</a>
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2562922"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--buffers-max">buffers-max</a>" gint : Read / Write
"<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--buffers-queued">buffers-queued</a>" guint : Read
"<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--buffers-soft-max">buffers-soft-max</a>" gint : Read / Write
"<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--bytes-served">bytes-served</a>" guint64 : Read
"<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--bytes-to-serve">bytes-to-serve</a>" guint64 : Read
"<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--mode">mode</a>" GstFDSetMode : Read / Write
"<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--protocol">protocol</a>" GstTCPProtocol : Read / Write
"<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--recover-policy">recover-policy</a>" <a href="gst-plugins-base-plugins-multifdsink.html#GstRecoverPolicy">GstRecoverPolicy</a> : Read / Write
"<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--sync-clients">sync-clients</a>" gboolean : Read / Write
"<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--sync-method">sync-method</a>" <a href="gst-plugins-base-plugins-multifdsink.html#GstSyncMethod">GstSyncMethod</a> : Read / Write
"<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--timeout">timeout</a>" guint64 : Read / Write
"<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--buffers-min">buffers-min</a>" gint : Read / Write
"<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--burst-unit">burst-unit</a>" GstTCPUnitType : Read / Write
"<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--burst-value">burst-value</a>" guint64 : Read / Write
"<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--bytes-min">bytes-min</a>" gint : Read / Write
"<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--time-min">time-min</a>" gint64 : Read / Write
"<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--unit-type">unit-type</a>" GstTCPUnitType : Read / Write
"<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--units-max">units-max</a>" gint64 : Read / Write
"<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink--units-soft-max">units-soft-max</a>" gint64 : Read / Write
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2567870"></a><h2>Signals</h2>
<pre class="synopsis">
"<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink-add">add</a>" : Run Last
"<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink-clear">clear</a>" : Run Last
"<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink-client-added">client-added</a>" : Run Last
"<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink-client-removed">client-removed</a>" : Run Last
"<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink-get-stats">get-stats</a>" : Run Last
"<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink-remove">remove</a>" : Run Last
"<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink-client-fd-removed">client-fd-removed</a>" : Run Last
"<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink-add-full">add-full</a>" : Run Last
"<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink-remove-flush">remove-flush</a>" : Run Last
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2567948"></a><h2>Description</h2>
<p>
</p>
<div class="refsect2" lang="en">
<a name="id2567961"></a><p>
This plugin writes incoming data to a set of file descriptors. The
file descriptors can be added to multifdsink by emitting the "add" signal.
For each descriptor added, the "client-added" signal will be called.
</p>
<p>
As of version 0.10.8, a client can also be added with the "add-full" signal
that allows for more control over what and how much data a client
initially receives.
</p>
<p>
Clients can be removed from multifdsink by emitting the "remove" signal. For
each descriptor removed, the "client-removed" signal will be called. The
"client-removed" signal can also be fired when multifdsink decides that a
client is not active anymore or, depending on the value of the
"recover-policy" property, if the client is reading too slowly.
In all cases, multifdsink will never close a file descriptor itself.
The user of multifdsink is responsible for closing all file descriptors.
This can for example be done in response to the "client-fd-removed" signal.
Note that multifdsink still has a reference to the file descriptor when the
"client-removed" signal is emitted, so that "get-stats" can be performed on
the descriptor; it is therefore not safe to close the file descriptor in
the "client-removed" signal handler, and you should use the
"client-fd-removed" signal to safely close the fd.
</p>
<p>
Multifdsink internally keeps a queue of the incoming buffers and uses a
separate thread to send the buffers to the clients. This ensures that no
client write can block the pipeline and that clients can read with different
speeds.
</p>
<p>
When adding a client to multifdsink, the "sync-method" property will define
which buffer in the queued buffers will be sent first to the client. Clients
can be sent the most recent buffer (which might not be decodable by the
client if it is not a keyframe), the next keyframe received in
multifdsink (which can take some time depending on the keyframe rate), or the
last received keyframe (which will cause a simple burst-on-connect).
Multifdsink will always keep at least one keyframe in its internal buffers
when the sync-mode is set to latest-keyframe.
</p>
<p>
As of version 0.10.8, there are additional values for the sync-method
property to allow finer control over burst-on-connect behaviour. By selecting
the 'burst' method a minimum burst size can be chosen, 'burst-keyframe'
additionally requires that the burst begin with a keyframe, and
'burst-with-keyframe' attempts to burst beginning with a keyframe, but will
prefer a minimum burst size even if it requires not starting with a keyframe.
</p>
<p>
Multifdsink can be instructed to keep at least a minimum amount of data
expressed in time or byte units in its internal queues with the the
"time-min" and "bytes-min" properties respectively. These properties are
useful if the application adds clients with the "add-full" signal to
make sure that a burst connect can actually be honored.
</p>
<p>
When streaming data, clients are allowed to read at a different rate than
the rate at which multifdsink receives data. If the client is reading too
fast, no data will be send to the client until multifdsink receives more
data. If the client, however, reads too slowly, data for that client will be
queued up in multifdsink. Two properties control the amount of data
(buffers) that is queued in multifdsink: "buffers-max" and
"buffers-soft-max". A client that falls behind by "buffers-max" is removed
from multifdsink forcibly.
</p>
<p>
A client with a lag of at least "buffers-soft-max" enters the recovery
procedure which is controlled with the "recover-policy" property. A recover
policy of NONE will do nothing, RESYNC_LATEST will send the most recently
received buffer as the next buffer for the client, RESYNC_SOFT_LIMIT
positions the client to the soft limit in the buffer queue and
RESYNC_KEYFRAME positions the client at the most recent keyframe in the
buffer queue.
</p>
<p>
multifdsink will by default synchronize on the clock before serving the
buffers to the clients. This behaviour can be disabled by setting the sync
property to FALSE. Multifdsink will by default not do QoS and will never
drop late buffers.
</p>
</div>
<p>
</p>
<p>
Last reviewed on 2006-09-12 (0.10.10)</p>
<div class="refsect2" lang="en">
<a name="id2601338"></a><h3>Element Information</h3>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term">plugin</span></td>
<td>
<a href="gst-plugins-base-plugins-plugin-tcp.html#plugin-tcp">tcp</a>
</td>
</tr>
<tr>
<td><span class="term">author</span></td>
<td>Thomas Vander Stichele <thomas at apestaart dot org>, Wim Taymans <wim@fluendo.com></td>
</tr>
<tr>
<td><span class="term">class</span></td>
<td>Sink/Network</td>
</tr>
</tbody>
</table></div>
<h3>Element Pads</h3>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term">name</span></td>
<td>sink</td>
</tr>
<tr>
<td><span class="term">direction</span></td>
<td>sink</td>
</tr>
<tr>
<td><span class="term">presence</span></td>
<td>always</td>
</tr>
<tr>
<td><span class="term">details</span></td>
<td>ANY</td>
</tr>
</tbody>
</table></div>
</div>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2601475"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2601486"></a><h3>
<a name="GstMultiFdSink-struct"></a>GstMultiFdSink</h3>
<a class="indexterm" name="id2601498"></a><pre class="programlisting">typedef struct _GstMultiFdSink GstMultiFdSink;</pre>
<p>
The multifdsink object structure.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2601518"></a><h3>
<a name="GstRecoverPolicy"></a>enum GstRecoverPolicy</h3>
<a class="indexterm" name="id2601531"></a><pre class="programlisting">typedef enum
{
GST_RECOVER_POLICY_NONE,
GST_RECOVER_POLICY_RESYNC_LATEST,
GST_RECOVER_POLICY_RESYNC_SOFT_LIMIT,
GST_RECOVER_POLICY_RESYNC_KEYFRAME
} GstRecoverPolicy;
</pre>
<p>
Possible values for the recovery procedure to use when a client consumes
data too slow and has a backlag of more that soft-limit buffers.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><a name="GST-RECOVER-POLICY-NONE:CAPS"></a><code class="literal">GST_RECOVER_POLICY_NONE</code></span></td>
<td> no recovering is done
</td>
</tr>
<tr>
<td><span class="term"><a name="GST-RECOVER-POLICY-RESYNC-LATEST:CAPS"></a><code class="literal">GST_RECOVER_POLICY_RESYNC_LATEST</code></span></td>
<td> client is moved to last buffer
</td>
</tr>
<tr>
<td><span class="term"><a name="GST-RECOVER-POLICY-RESYNC-SOFT-LIMIT:CAPS"></a><code class="literal">GST_RECOVER_POLICY_RESYNC_SOFT_LIMIT</code></span></td>
<td> client is moved to the soft limit
</td>
</tr>
<tr>
<td><span class="term"><a name="GST-RECOVER-POLICY-RESYNC-KEYFRAME:CAPS"></a><code class="literal">GST_RECOVER_POLICY_RESYNC_KEYFRAME</code></span></td>
<td> client is moved to latest keyframe
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609301"></a><h3>
<a name="GstSyncMethod"></a>enum GstSyncMethod</h3>
<a class="indexterm" name="id2609312"></a><pre class="programlisting">typedef enum
{
GST_SYNC_METHOD_LATEST,
GST_SYNC_METHOD_NEXT_KEYFRAME,
GST_SYNC_METHOD_LATEST_KEYFRAME,
GST_SYNC_METHOD_BURST,
GST_SYNC_METHOD_BURST_KEYFRAME,
GST_SYNC_METHOD_BURST_WITH_KEYFRAME
} GstSyncMethod;
</pre>
<p>
This enum defines the selection of the first buffer that is sent
to a new client.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><a name="GST-SYNC-METHOD-LATEST:CAPS"></a><code class="literal">GST_SYNC_METHOD_LATEST</code></span></td>
<td> client receives most recent buffer
</td>
</tr>
<tr>
<td><span class="term"><a name="GST-SYNC-METHOD-NEXT-KEYFRAME:CAPS"></a><code class="literal">GST_SYNC_METHOD_NEXT_KEYFRAME</code></span></td>
<td> client receives next keyframe
</td>
</tr>
<tr>
<td><span class="term"><a name="GST-SYNC-METHOD-LATEST-KEYFRAME:CAPS"></a><code class="literal">GST_SYNC_METHOD_LATEST_KEYFRAME</code></span></td>
<td> client receives latest keyframe (burst)
</td>
</tr>
<tr>
<td><span class="term"><a name="GST-SYNC-METHOD-BURST:CAPS"></a><code class="literal">GST_SYNC_METHOD_BURST</code></span></td>
<td> client receives specific amount of data
</td>
</tr>
<tr>
<td><span class="term"><a name="GST-SYNC-METHOD-BURST-KEYFRAME:CAPS"></a><code class="literal">GST_SYNC_METHOD_BURST_KEYFRAME</code></span></td>
<td> client receives specific amount of data
starting from latest keyframe
</td>
</tr>
<tr>
<td><span class="term"><a name="GST-SYNC-METHOD-BURST-WITH-KEYFRAME:CAPS"></a><code class="literal">GST_SYNC_METHOD_BURST_WITH_KEYFRAME</code></span></td>
<td> client receives specific amount of data from
a keyframe, or if there is not enough data after
the keyframe, starting before the keyframe
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609469"></a><h3>
<a name="GstClientStatus"></a>enum GstClientStatus</h3>
<a class="indexterm" name="id2609479"></a><pre class="programlisting">typedef enum
{
GST_CLIENT_STATUS_OK = 0,
GST_CLIENT_STATUS_CLOSED = 1,
GST_CLIENT_STATUS_REMOVED = 2,
GST_CLIENT_STATUS_SLOW = 3,
GST_CLIENT_STATUS_ERROR = 4,
GST_CLIENT_STATUS_DUPLICATE = 5,
GST_CLIENT_STATUS_FLUSHING = 6
} GstClientStatus;
</pre>
<p>
This specifies the reason why a client was removed from
multifdsink and is received in the "client-removed" signal.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><a name="GST-CLIENT-STATUS-OK:CAPS"></a><code class="literal">GST_CLIENT_STATUS_OK</code></span></td>
<td> client is ok
</td>
</tr>
<tr>
<td><span class="term"><a name="GST-CLIENT-STATUS-CLOSED:CAPS"></a><code class="literal">GST_CLIENT_STATUS_CLOSED</code></span></td>
<td> client closed the socket
</td>
</tr>
<tr>
<td><span class="term"><a name="GST-CLIENT-STATUS-REMOVED:CAPS"></a><code class="literal">GST_CLIENT_STATUS_REMOVED</code></span></td>
<td> client is removed
</td>
</tr>
<tr>
<td><span class="term"><a name="GST-CLIENT-STATUS-SLOW:CAPS"></a><code class="literal">GST_CLIENT_STATUS_SLOW</code></span></td>
<td> client is too slow
</td>
</tr>
<tr>
<td><span class="term"><a name="GST-CLIENT-STATUS-ERROR:CAPS"></a><code class="literal">GST_CLIENT_STATUS_ERROR</code></span></td>
<td> client is in error
</td>
</tr>
<tr>
<td><span class="term"><a name="GST-CLIENT-STATUS-DUPLICATE:CAPS"></a><code class="literal">GST_CLIENT_STATUS_DUPLICATE</code></span></td>
<td> same client added twice
</td>
</tr>
<tr>
<td><span class="term"><a name="GST-CLIENT-STATUS-FLUSHING:CAPS"></a><code class="literal">GST_CLIENT_STATUS_FLUSHING</code></span></td>
<td> client is flushing out the remaining buffers.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2609648"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2609658"></a><h3>
<a name="GstMultiFdSink--buffers-max"></a>The "<code class="literal">buffers-max</code>" property</h3>
<a class="indexterm" name="id2609670"></a><pre class="programlisting"> "buffers-max" gint : Read / Write</pre>
<p>max number of buffers to queue for a client (-1 = no limit).</p>
<p>Allowed values: >= -1</p>
<p>Default value: -1</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609697"></a><h3>
<a name="GstMultiFdSink--buffers-queued"></a>The "<code class="literal">buffers-queued</code>" property</h3>
<a class="indexterm" name="id2609712"></a><pre class="programlisting"> "buffers-queued" guint : Read</pre>
<p>Number of buffers currently queued.</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609735"></a><h3>
<a name="GstMultiFdSink--buffers-soft-max"></a>The "<code class="literal">buffers-soft-max</code>" property</h3>
<a class="indexterm" name="id2609750"></a><pre class="programlisting"> "buffers-soft-max" gint : Read / Write</pre>
<p>Recover client when going over this limit (-1 = no limit).</p>
<p>Allowed values: >= -1</p>
<p>Default value: -1</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609777"></a><h3>
<a name="GstMultiFdSink--bytes-served"></a>The "<code class="literal">bytes-served</code>" property</h3>
<a class="indexterm" name="id2609792"></a><pre class="programlisting"> "bytes-served" guint64 : Read</pre>
<p>Total number of bytes send to all clients.</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609814"></a><h3>
<a name="GstMultiFdSink--bytes-to-serve"></a>The "<code class="literal">bytes-to-serve</code>" property</h3>
<a class="indexterm" name="id2609828"></a><pre class="programlisting"> "bytes-to-serve" guint64 : Read</pre>
<p>Number of bytes received to serve to clients.</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609852"></a><h3>
<a name="GstMultiFdSink--mode"></a>The "<code class="literal">mode</code>" property</h3>
<a class="indexterm" name="id2609864"></a><pre class="programlisting"> "mode" GstFDSetMode : Read / Write</pre>
<p>The mode for selecting activity on the fds.</p>
<p>Default value: Poll</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609888"></a><h3>
<a name="GstMultiFdSink--protocol"></a>The "<code class="literal">protocol</code>" property</h3>
<a class="indexterm" name="id2609900"></a><pre class="programlisting"> "protocol" GstTCPProtocol : Read / Write</pre>
<p>The protocol to wrap data in.</p>
<p>Default value: GST_TCP_PROTOCOL_NONE</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609925"></a><h3>
<a name="GstMultiFdSink--recover-policy"></a>The "<code class="literal">recover-policy</code>" property</h3>
<a class="indexterm" name="id2609939"></a><pre class="programlisting"> "recover-policy" <a href="gst-plugins-base-plugins-multifdsink.html#GstRecoverPolicy">GstRecoverPolicy</a> : Read / Write</pre>
<p>How to recover when client reaches the soft max.</p>
<p>Default value: Do not try to recover</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609964"></a><h3>
<a name="GstMultiFdSink--sync-clients"></a>The "<code class="literal">sync-clients</code>" property</h3>
<a class="indexterm" name="id2609978"></a><pre class="programlisting"> "sync-clients" gboolean : Read / Write</pre>
<p>(DEPRECATED) Sync clients to a keyframe.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610002"></a><h3>
<a name="GstMultiFdSink--sync-method"></a>The "<code class="literal">sync-method</code>" property</h3>
<a class="indexterm" name="id2610014"></a><pre class="programlisting"> "sync-method" <a href="gst-plugins-base-plugins-multifdsink.html#GstSyncMethod">GstSyncMethod</a> : Read / Write</pre>
<p>How to sync new clients to the stream.</p>
<p>Default value: Serve starting from the latest buffer</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610039"></a><h3>
<a name="GstMultiFdSink--timeout"></a>The "<code class="literal">timeout</code>" property</h3>
<a class="indexterm" name="id2610051"></a><pre class="programlisting"> "timeout" guint64 : Read / Write</pre>
<p>Maximum inactivity timeout in nanoseconds for a client (0 = no limit).</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610076"></a><h3>
<a name="GstMultiFdSink--buffers-min"></a>The "<code class="literal">buffers-min</code>" property</h3>
<a class="indexterm" name="id2610088"></a><pre class="programlisting"> "buffers-min" gint : Read / Write</pre>
<p>min number of buffers to queue (-1 = as few as possible).</p>
<p>Allowed values: >= -1</p>
<p>Default value: -1</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610116"></a><h3>
<a name="GstMultiFdSink--burst-unit"></a>The "<code class="literal">burst-unit</code>" property</h3>
<a class="indexterm" name="id2610128"></a><pre class="programlisting"> "burst-unit" GstTCPUnitType : Read / Write</pre>
<p>The format of the burst units (when sync-method is burst[[-with]-keyframe]).</p>
<p>Default value: Undefined</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610153"></a><h3>
<a name="GstMultiFdSink--burst-value"></a>The "<code class="literal">burst-value</code>" property</h3>
<a class="indexterm" name="id2610165"></a><pre class="programlisting"> "burst-value" guint64 : Read / Write</pre>
<p>The amount of burst expressed in burst-unit.</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610189"></a><h3>
<a name="GstMultiFdSink--bytes-min"></a>The "<code class="literal">bytes-min</code>" property</h3>
<a class="indexterm" name="id2610202"></a><pre class="programlisting"> "bytes-min" gint : Read / Write</pre>
<p>min number of bytes to queue (-1 = as little as possible).</p>
<p>Allowed values: >= -1</p>
<p>Default value: -1</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610230"></a><h3>
<a name="GstMultiFdSink--time-min"></a>The "<code class="literal">time-min</code>" property</h3>
<a class="indexterm" name="id2610242"></a><pre class="programlisting"> "time-min" gint64 : Read / Write</pre>
<p>min number of time to queue (-1 = as little as possible).</p>
<p>Allowed values: >= -1</p>
<p>Default value: -1</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610270"></a><h3>
<a name="GstMultiFdSink--unit-type"></a>The "<code class="literal">unit-type</code>" property</h3>
<a class="indexterm" name="id2610282"></a><pre class="programlisting"> "unit-type" GstTCPUnitType : Read / Write</pre>
<p>The unit to measure the max/soft-max/queued properties.</p>
<p>Default value: Buffers</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610306"></a><h3>
<a name="GstMultiFdSink--units-max"></a>The "<code class="literal">units-max</code>" property</h3>
<a class="indexterm" name="id2610318"></a><pre class="programlisting"> "units-max" gint64 : Read / Write</pre>
<p>max number of units to queue (-1 = no limit).</p>
<p>Allowed values: >= -1</p>
<p>Default value: -1</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610346"></a><h3>
<a name="GstMultiFdSink--units-soft-max"></a>The "<code class="literal">units-soft-max</code>" property</h3>
<a class="indexterm" name="id2610360"></a><pre class="programlisting"> "units-soft-max" gint64 : Read / Write</pre>
<p>Recover client when going over this limit (-1 = no limit).</p>
<p>Allowed values: >= -1</p>
<p>Default value: -1</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2610389"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id2610398"></a><h3>
<a name="GstMultiFdSink-add"></a>The "add" signal</h3>
<a class="indexterm" name="id2610406"></a><pre class="programlisting">void user_function (<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink">GstMultiFdSink</a> *gstmultifdsink,
gint fd,
gpointer user_data) : Run Last</pre>
<p>
Hand the given open file descriptor to multifdsink to write to.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>gstmultifdsink</code></em> :</span></td>
<td> the multifdsink element to emit this signal on
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>fd</code></em> :</span></td>
<td> the file descriptor to add to multifdsink
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610492"></a><h3>
<a name="GstMultiFdSink-clear"></a>The "clear" signal</h3>
<a class="indexterm" name="id2610500"></a><pre class="programlisting">void user_function (<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink">GstMultiFdSink</a> *gstmultifdsink,
gpointer user_data) : Run Last</pre>
<p>
Remove all file descriptors from multifdsink. Since multifdsink did not
open fd's itself, it does not explicitly close the fd. The application
should do so by connecting to the client-fd-removed callback.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>gstmultifdsink</code></em> :</span></td>
<td> the multifdsink element to emit this signal on
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610568"></a><h3>
<a name="GstMultiFdSink-client-added"></a>The "client-added" signal</h3>
<a class="indexterm" name="id2610575"></a><pre class="programlisting">void user_function (<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink">GstMultiFdSink</a> *gstmultifdsink,
gint fd,
gpointer user_data) : Run Last</pre>
<p>
The given file descriptor was added to multifdsink. This signal will
be emitted from the streaming thread so application should be prepared
for that.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>gstmultifdsink</code></em> :</span></td>
<td> the multifdsink element that emitted this signal
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>fd</code></em> :</span></td>
<td> the file descriptor that was added to multifdsink
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610664"></a><h3>
<a name="GstMultiFdSink-client-removed"></a>The "client-removed" signal</h3>
<a class="indexterm" name="id2610673"></a><pre class="programlisting">void user_function (<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink">GstMultiFdSink</a> *gstmultifdsink,
gint fd,
<a href="gst-plugins-base-plugins-multifdsink.html#GstClientStatus">GstClientStatus</a> status,
gpointer user_data) : Run Last</pre>
<p>
The given file descriptor is about to be removed from multifdsink. This
signal will be emitted from the streaming thread so applications should
be prepared for that.
</p>
<p>
<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
the get-stats signal from this callback. For the same reason it is
not safe to <code class="function">close()</code> and reuse <em class="parameter"><code>fd</code></em> in this callback.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>gstmultifdsink</code></em> :</span></td>
<td> the multifdsink element that emitted this signal
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>fd</code></em> :</span></td>
<td> the file descriptor that is to be removed from multifdsink
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>status</code></em> :</span></td>
<td> the reason why the client was removed
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610811"></a><h3>
<a name="GstMultiFdSink-get-stats"></a>The "get-stats" signal</h3>
<a class="indexterm" name="id2610818"></a><pre class="programlisting">GValueArray* user_function (<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink">GstMultiFdSink</a> *gstmultifdsink,
gint fd,
gpointer user_data) : Run Last</pre>
<p>
Get statistics about <em class="parameter"><code>fd</code></em>. This function returns a GValueArray to ease
automatic wrapping for bindings.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>gstmultifdsink</code></em> :</span></td>
<td> the multifdsink element to emit this signal on
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>fd</code></em> :</span></td>
<td> the file descriptor to get stats of from multifdsink
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a GValueArray with the statistics. The array contains guint64
values that represent respectively: total number of bytes sent, time
when the client was added, time when the client was
disconnected/removed, time the client is/was active, last activity
time (in epoch seconds), number of buffers dropped.
All times are expressed in nanoseconds (GstClockTime).
The array can be 0-length if the client was not found.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610927"></a><h3>
<a name="GstMultiFdSink-remove"></a>The "remove" signal</h3>
<a class="indexterm" name="id2610934"></a><pre class="programlisting">void user_function (<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink">GstMultiFdSink</a> *gstmultifdsink,
gint fd,
gpointer user_data) : Run Last</pre>
<p>
Remove the given open file descriptor from multifdsink.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>gstmultifdsink</code></em> :</span></td>
<td> the multifdsink element to emit this signal on
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>fd</code></em> :</span></td>
<td> the file descriptor to remove from multifdsink
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2611021"></a><h3>
<a name="GstMultiFdSink-client-fd-removed"></a>The "client-fd-removed" signal</h3>
<a class="indexterm" name="id2611030"></a><pre class="programlisting">void user_function (<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink">GstMultiFdSink</a> *gstmultifdsink,
gint fd,
gpointer user_data) : Run Last</pre>
<p>
The given file descriptor was removed from multifdsink. This signal will
be emitted from the streaming thread so applications should be prepared
for that.
</p>
<p>
In this callback, <em class="parameter"><code>gstmultifdsink</code></em> has removed all the information
associated with <em class="parameter"><code>fd</code></em> and it is therefore not possible to call get-stats
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.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>gstmultifdsink</code></em> :</span></td>
<td> the multifdsink element that emitted this signal
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>fd</code></em> :</span></td>
<td> the file descriptor that was removed from multifdsink
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
<p>Since 0.10.7
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2611157"></a><h3>
<a name="GstMultiFdSink-add-full"></a>The "add-full" signal</h3>
<a class="indexterm" name="id2611165"></a><pre class="programlisting">void user_function (<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink">GstMultiFdSink</a> *gstmultifdsink,
gint fd,
gboolean keyframe,
GstTCPUnitType unit_type_min,
guint64 value_min,
GstTCPUnitType unit_type_max,
guint64 value_max,
gpointer user_data) : Run Last</pre>
<p>
Hand the given open file descriptor to multifdsink to write to and
specify the burst parameters for the new connection.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>gstmultifdsink</code></em> :</span></td>
<td> the multifdsink element to emit this signal on
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>fd</code></em> :</span></td>
<td> the file descriptor to add to multifdsink
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>keyframe</code></em> :</span></td>
<td> start bursting from a keyframe
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>unit_type_min</code></em> :</span></td>
<td> the unit-type of <em class="parameter"><code>value_min</code></em>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>value_min</code></em> :</span></td>
<td> the minimum amount of data to burst expressed in
<em class="parameter"><code>unit_type_min</code></em> units.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>unit_type_max</code></em> :</span></td>
<td> the unit-type of <em class="parameter"><code>value_max</code></em>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>value_max</code></em> :</span></td>
<td> the maximum amount of data to burst expressed in
<em class="parameter"><code>unit_type_max</code></em> units.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2611372"></a><h3>
<a name="GstMultiFdSink-remove-flush"></a>The "remove-flush" signal</h3>
<a class="indexterm" name="id2611380"></a><pre class="programlisting">void user_function (<a href="gst-plugins-base-plugins-multifdsink.html#GstMultiFdSink">GstMultiFdSink</a> *gstmultifdsink,
gint arg1,
gpointer user_data) : Run Last</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>gstmultifdsink</code></em> :</span></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>arg1</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2611463"></a><h2>See Also</h2>
tcpserversink
</div>
</div>
</body>
</html>
