shaka-packager/docs/source/options/udp_file_options.rst

UDP file options
^^^^^^^^^^^^^^^^

UDP file is of the form::

    udp://<ip>:<port>[?<option>[&<option>]...]

Here is the list of supported options:

:reuse=0|1:

    Allow or disallow reusing UDP sockets.

:interface=<addr>:

    Multicast group interface address. Only the packets sent to this address are
    received. Default to "0.0.0.0" if not specified.

:source=<addr>:

    Multicast source ip address. Only the packets sent from this source address
    are received. Enables Source Specific Multicast (SSM) if set.

:timeout=<microseconds>:

    UDP timeout in microseconds.

Example::

    udp://224.1.2.30:88?interface=10.11.12.13&reuse=1
Move command line options to Sphinxdoc Change-Id: Ia043612012ff3d101afcf3366d95f9001f0dc8f4 2017-09-06 20:57:07 +00:00			`UDP file options`
			`^^^^^^^^^^^^^^^^`

[Doc] Make UDP file options clearer Issue #332. Change-Id: I3a2b1e1e0525eaba5bb657ce0481d96ceafb4e89 2018-03-07 01:40:50 +00:00			`UDP file is of the form::`

Fix documentation syntaxes for RST option-list http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#option-lists RST only accepts two forms for option argument: - Begins with a letter and consists of [a-zA-Z0-9_]. - Begins with "<" and ends with ">"; any characters except angle brackets are allowed internally. Updated documents to obey the above rule. Also cleaned up the documents to follow the syntaxes defined in http://docopt.org/. Change-Id: I06c6fa6db524325373053b26fc99169469664f01 2018-05-02 17:55:51 +00:00			`udp://<ip>:<port>[?<option>[&<option>]...]`
[Doc] Make UDP file options clearer Issue #332. Change-Id: I3a2b1e1e0525eaba5bb657ce0481d96ceafb4e89 2018-03-07 01:40:50 +00:00
			`Here is the list of supported options:`
Move command line options to Sphinxdoc Change-Id: Ia043612012ff3d101afcf3366d95f9001f0dc8f4 2017-09-06 20:57:07 +00:00
			`:reuse=0\|1:`

			`Allow or disallow reusing UDP sockets.`

Fix documentation syntaxes for RST option-list http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#option-lists RST only accepts two forms for option argument: - Begins with a letter and consists of [a-zA-Z0-9_]. - Begins with "<" and ends with ">"; any characters except angle brackets are allowed internally. Updated documents to obey the above rule. Also cleaned up the documents to follow the syntaxes defined in http://docopt.org/. Change-Id: I06c6fa6db524325373053b26fc99169469664f01 2018-05-02 17:55:51 +00:00			`:interface=<addr>:`
Move command line options to Sphinxdoc Change-Id: Ia043612012ff3d101afcf3366d95f9001f0dc8f4 2017-09-06 20:57:07 +00:00
Add Source Specific Multicast (SSM) support SSM can be enabled using "source" option in UDP options. Previously, "source" is considered the same as "interface", which is incorrect. Fixes #332. 2018-03-06 18:09:28 +00:00			`Multicast group interface address. Only the packets sent to this address are`
Default multicast interface address to "0.0.0.0" if absent It aligns with what a lot of other apps are doing, e.g. tsplay. Also added notes in docker to adjust network setting if wants to use multicast in docker container. Change-Id: I666a8979cc041c904f7ff8e3e022f800c0830d5d 2017-12-02 00:09:40 +00:00			`received. Default to "0.0.0.0" if not specified.`
Move command line options to Sphinxdoc Change-Id: Ia043612012ff3d101afcf3366d95f9001f0dc8f4 2017-09-06 20:57:07 +00:00
Fix documentation syntaxes for RST option-list http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#option-lists RST only accepts two forms for option argument: - Begins with a letter and consists of [a-zA-Z0-9_]. - Begins with "<" and ends with ">"; any characters except angle brackets are allowed internally. Updated documents to obey the above rule. Also cleaned up the documents to follow the syntaxes defined in http://docopt.org/. Change-Id: I06c6fa6db524325373053b26fc99169469664f01 2018-05-02 17:55:51 +00:00			`:source=<addr>:`
Add Source Specific Multicast (SSM) support SSM can be enabled using "source" option in UDP options. Previously, "source" is considered the same as "interface", which is incorrect. Fixes #332. 2018-03-06 18:09:28 +00:00
			`Multicast source ip address. Only the packets sent from this source address`
[Doc] Make UDP file options clearer Issue #332. Change-Id: I3a2b1e1e0525eaba5bb657ce0481d96ceafb4e89 2018-03-07 01:40:50 +00:00			`are received. Enables Source Specific Multicast (SSM) if set.`
Add Source Specific Multicast (SSM) support SSM can be enabled using "source" option in UDP options. Previously, "source" is considered the same as "interface", which is incorrect. Fixes #332. 2018-03-06 18:09:28 +00:00
Fix documentation syntaxes for RST option-list http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#option-lists RST only accepts two forms for option argument: - Begins with a letter and consists of [a-zA-Z0-9_]. - Begins with "<" and ends with ">"; any characters except angle brackets are allowed internally. Updated documents to obey the above rule. Also cleaned up the documents to follow the syntaxes defined in http://docopt.org/. Change-Id: I06c6fa6db524325373053b26fc99169469664f01 2018-05-02 17:55:51 +00:00			`:timeout=<microseconds>:`
Move command line options to Sphinxdoc Change-Id: Ia043612012ff3d101afcf3366d95f9001f0dc8f4 2017-09-06 20:57:07 +00:00
			`UDP timeout in microseconds.`
[Doc] Make UDP file options clearer Issue #332. Change-Id: I3a2b1e1e0525eaba5bb657ce0481d96ceafb4e89 2018-03-07 01:40:50 +00:00
			`Example::`

			`udp://224.1.2.30:88?interface=10.11.12.13&reuse=1`