141 lines
6.6 KiB
HTML
141 lines
6.6 KiB
HTML
|
||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
<title>UDP file options — Shaka Packager documentation</title>
|
||
<link rel="stylesheet" href="../_static/sphinxdoc_new.css" type="text/css" />
|
||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="../_static/table_styling.css" type="text/css" />
|
||
<script type="text/javascript">
|
||
var DOCUMENTATION_OPTIONS = {
|
||
URL_ROOT: '../',
|
||
VERSION: '',
|
||
COLLAPSE_INDEX: false,
|
||
FILE_SUFFIX: '.html',
|
||
HAS_SOURCE: true,
|
||
SOURCELINK_SUFFIX: '.txt'
|
||
};
|
||
</script>
|
||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||
<script type="text/javascript" src="../_static/underscore.js"></script>
|
||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||
<link rel="index" title="Index" href="../genindex.html" />
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
</head>
|
||
<body>
|
||
<div class="related" role="navigation" aria-label="related navigation">
|
||
<h3>Navigation</h3>
|
||
<ul>
|
||
<li class="right" style="margin-right: 10px">
|
||
<a href="../genindex.html" title="General Index"
|
||
accesskey="I">index</a></li>
|
||
<li class="nav-item nav-item-0"><a href="../index.html">Shaka Packager documentation</a> »</li>
|
||
</ul>
|
||
</div>
|
||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||
<div class="sphinxsidebarwrapper">
|
||
<div role="note" aria-label="source link">
|
||
<h3>This Page</h3>
|
||
<ul class="this-page-menu">
|
||
<li><a href="../_sources/options/udp_file_options.rst.txt"
|
||
rel="nofollow">Show Source</a></li>
|
||
</ul>
|
||
</div>
|
||
<div id="searchbox" style="display: none" role="search">
|
||
<h3>Quick search</h3>
|
||
<form class="search" action="../search.html" method="get">
|
||
<div><input type="text" name="q" /></div>
|
||
<div><input type="submit" value="Go" /></div>
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
<div class="body" role="main">
|
||
|
||
<div class="section" id="udp-file-options">
|
||
<h1>UDP file options<a class="headerlink" href="#udp-file-options" title="Permalink to this headline">¶</a></h1>
|
||
<p>UDP file is of the form:</p>
|
||
<div class="highlight-default"><div class="highlight"><pre><span></span>udp://<ip>:<port>[?<option>[&<option>]...]
|
||
</pre></div>
|
||
</div>
|
||
<p>Here is the list of supported options:</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name" colspan="2">buffer_size=<size_in_bytes>:</th></tr>
|
||
<tr class="field-odd field"><td> </td><td class="field-body">UDP maximum receive buffer size in bytes. Note that although it can be set
|
||
to any value, the actual value is capped by maximum allowed size defined by
|
||
the underlying operating system. On linux, the maximum size allowed can be
|
||
retrieved using <cite>sysctl net.core.rmem_max</cite> and configured using
|
||
<cite>sysctl -w net.core.rmem_max=<size_in_bytes></cite>.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name" colspan="2">interface=<addr>:</th></tr>
|
||
<tr class="field-even field"><td> </td><td class="field-body">Multicast group interface address. Only the packets sent to this address are
|
||
received. Default to “0.0.0.0” if not specified.</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">reuse=0|1:</th><td class="field-body">Allow or disallow reusing UDP sockets.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">source=<addr>:</th><td class="field-body">Multicast source ip address. Only the packets sent from this source address
|
||
are received. Enables Source Specific Multicast (SSM) if set.</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name" colspan="2">timeout=<microseconds>:</th></tr>
|
||
<tr class="field-odd field"><td> </td><td class="field-body">UDP timeout in microseconds.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>Example:</p>
|
||
<div class="highlight-default"><div class="highlight"><pre><span></span>udp://224.1.2.30:88?interface=10.11.12.13&reuse=1
|
||
</pre></div>
|
||
</div>
|
||
<div class="admonition note">
|
||
<p class="first admonition-title">Note</p>
|
||
<p>UDP is by definition unreliable. There could be packets dropped.</p>
|
||
<p>UDP packets do not get lost magically. There are things you can do to
|
||
minimize the packet loss. A common cause of packet loss is buffer overrun,
|
||
either in send buffer or receive buffer.</p>
|
||
<p>On Linux, you can check UDP errors by monitoring the output from
|
||
<cite>netstat -suna</cite> command.</p>
|
||
<p>If there is an increase in <cite>send buffer errors</cite> from the <cite>netstat</cite> output,
|
||
then try increasing <cite>buffer_size</cite> in
|
||
[FFmpeg](<a class="reference external" href="https://ffmpeg.org/ffmpeg-protocols.html#udp">https://ffmpeg.org/ffmpeg-protocols.html#udp</a>).</p>
|
||
<p class="last">If there is an increase in <cite>receive buffer errors</cite>, then try increasing
|
||
<cite>buffer_size</cite> in UDP options (See above) or increasing <cite>–io_cache_size</cite>.
|
||
<cite>buffer_size</cite> in UDP options defines the UDP buffer size of the underlying
|
||
system while <cite>io_cache_size</cite> defines the size of the internal circular
|
||
buffer managed by <cite>Shaka Packager</cite>.</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="clearer"></div>
|
||
</div>
|
||
<div class="related" role="navigation" aria-label="related navigation">
|
||
<h3>Navigation</h3>
|
||
<ul>
|
||
<li class="right" style="margin-right: 10px">
|
||
<a href="../genindex.html" title="General Index"
|
||
>index</a></li>
|
||
<li class="nav-item nav-item-0"><a href="../index.html">Shaka Packager documentation</a> »</li>
|
||
</ul>
|
||
</div>
|
||
<div class="footer" role="contentinfo">
|
||
© Copyright 2017, Google.
|
||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.7.
|
||
</div>
|
||
</body>
|
||
</html> |