133 lines
6.0 KiB
HTML
133 lines
6.0 KiB
HTML
|
||
<!DOCTYPE html>
|
||
|
||
<html>
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||
|
||
<title>UDP file options — Shaka Packager documentation</title>
|
||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/sphinxdoc_new.css" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/table_styling.css" />
|
||
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
|
||
<script src="../_static/jquery.js"></script>
|
||
<script src="../_static/underscore.js"></script>
|
||
<script src="../_static/doctools.js"></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>
|
||
<li class="nav-item nav-item-this"><a href="">UDP file options</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
<div class="body" role="main">
|
||
|
||
<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 notranslate"><div class="highlight"><pre><span></span>udp://<ip>:<port>[?<option>[&<option>]...]
|
||
</pre></div>
|
||
</div>
|
||
<p>Here is the list of supported options:</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">buffer_size=<size_in_bytes></dt>
|
||
<dd class="field-odd"><p>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>.</p>
|
||
</dd>
|
||
<dt class="field-even">interface=<addr></dt>
|
||
<dd class="field-even"><p>Multicast group interface address. Only the packets sent to this address are
|
||
received. Default to “0.0.0.0” if not specified.</p>
|
||
</dd>
|
||
<dt class="field-odd">reuse=0|1</dt>
|
||
<dd class="field-odd"><p>Allow or disallow reusing UDP sockets.</p>
|
||
</dd>
|
||
<dt class="field-even">source=<addr></dt>
|
||
<dd class="field-even"><p>Multicast source ip address. Only the packets sent from this source address
|
||
are received. Enables Source Specific Multicast (SSM) if set.</p>
|
||
</dd>
|
||
<dt class="field-odd">timeout=<microseconds></dt>
|
||
<dd class="field-odd"><p>UDP timeout in microseconds.</p>
|
||
</dd>
|
||
</dl>
|
||
<p>Example:</p>
|
||
<div class="highlight-default notranslate"><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="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>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>
|
||
</section>
|
||
|
||
|
||
<div class="clearer"></div>
|
||
</div>
|
||
</div>
|
||
</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 id="searchlabel">Quick search</h3>
|
||
<div class="searchformwrapper">
|
||
<form class="search" action="../search.html" method="get">
|
||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||
<input type="submit" value="Go" />
|
||
</form>
|
||
</div>
|
||
</div>
|
||
<script>$('#searchbox').show(0);</script>
|
||
</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>
|
||
<li class="nav-item nav-item-this"><a href="">UDP file options</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="footer" role="contentinfo">
|
||
© Copyright 2017, Google.
|
||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.0.2.
|
||
</div>
|
||
</body>
|
||
</html> |