|
|
|
**Output of --help for both ristsender and ristreceiver**
|
|
|
|
|
|
|
|
`$ ristsender --help`
|
|
|
|
|
|
|
|
`Starting ristsender version: v0.2.0-10`
|
|
|
|
|
|
|
|
`Usage: %s [OPTIONS]`
|
|
|
|
|
|
|
|
`Where OPTIONS are:`
|
|
|
|
|
|
|
|
| Abbrev. | Long | Description |
|
|
|
|
| ------ | ------ | ------ |
|
|
|
|
| -i | --inputurl udp://... or rtp://... | *Comma separated list of input udp or rtp URLs |
|
|
|
|
| -o | --outputurl rist://... | *Comma separated list of output rist URLs |
|
|
|
|
| -b | --buffer value | Default buffer size for packet retransmissions |
|
|
|
|
| -s | --secret PWD | Default pre-shared encryption secret |
|
|
|
|
| -e | --encryption-type TYPE | Default Encryption type (0, 128 = AES-128, 256 = AES-256) |
|
|
|
|
| -p | --profile number | RIST profile (0 = simple, 1 = main, 2 = advanced) |
|
|
|
|
| -n | --null-packet-deletion | Enable NPD, receiver needs to support this! |
|
|
|
|
| -S | --statsinterval value (ms) | Interval at which stats get printed, 0 to disable |
|
|
|
|
| -v | --verbose-level value | To disable logging: -1, log levels match syslog levels |
|
|
|
|
| -r | --remote-logging IP:PORT | Send logs and stats to this IP:PORT using udp messages |
|
|
|
|
| -F | --srpfile filepath | When in listening mode, use this file to hold the list of usernames and passwords to validate against. Use the ristsrppasswd tool to create the line entries. See wiki page regarding [Authorization.](https://code.videolan.org/rist/librist/-/wikis/Authentication-and-the-ristsrppasswd-Utility) |
|
|
|
|
| -f | --fast-start value | Controls data output flow before handshake is completed. 0 = hold data out; 1 = start to send data immediately |
|
|
|
|
| -h | --help | Show this help |
|
|
|
|
| -u | --help-url | Show all the possible url options |
|
|
|
|
|
|
|
|
`* == mandatory value`
|
|
|
|
|
|
|
|
`Default values: %s`
|
|
|
|
|
|
|
|
`--profile 1`
|
|
|
|
|
|
|
|
`--statsinterval 1000`
|
|
|
|
|
|
|
|
`--verbose-level 6`
|
|
|
|
|
|
|
|
**Output of --help-url**
|
|
|
|
|
|
|
|
| Parameter | Description |
|
|
|
|
| ------ | ------ |
|
|
|
|
| | Simple, Main and Advanced Profiles |
|
|
|
|
| buffer=### | buffer size in milliseconds |
|
|
|
|
| bandwidth=### | max bandwidth in Kbps |
|
|
|
|
| return-bandwidth=### | max bandwidth for messaging return in Kbps |
|
|
|
|
| reorder-buffer=### | reordering buffer size in ms |
|
|
|
|
| cname=abcde | arbitrary name for stream for display in logging |
|
|
|
|
| rtt-min=### | minimum expected rtt |
|
|
|
|
| rtt-max=### | maximum expected rtt |
|
|
|
|
| verbose-level=# | Disable -1; Error 3, Warning 4, Notice 5, Info 6, Debug 7, simulation/dry-run 100 |
|
|
|
|
| timing-mode=# | 0 = RTP Timestamp (defaut); 1 = Arrival Time, 2 = RTP/RTCP Timestamp+NTP |
|
|
|
|
| | Main and Advanced Profiles |
|
|
|
|
| aes-type=# | 128 = AES-128, 256 = AES-256 must have passphrase too |
|
|
|
|
| secret=abcde | encryption passphrase |
|
|
|
|
| virt-dst-port | destination port inside the GRE header |
|
|
|
|
| session-timeout=### | timeout in ms for closing of connection where keep-alive fails |
|
|
|
|
| keepalive-interval=### | interval in ms |
|
|
|
|
| key-rotation=## | number of IP packets before a key rotation is triggered |
|
|
|
|
| congestion-control=# | mitigation mode: (0=disabled, 1=normal, 2=aggressive) |
|
|
|
|
| min-retries=## | min retries count before congestion control kicks in |
|
|
|
|
| max-retries=## | max retries count |
|
|
|
|
| weight=# | default weight for multi-path load balancing. Use 0 for duplicate paths. |
|
|
|
|
| username=abcde | Username to identify this peer during authentication |
|
|
|
|
| password=abcde | Password corresponding to this peer's Username |
|
|
|
|
| | Advanced Profile |
|
|
|
|
| compression=1 or 0 | lz4 levels |
|
|
|
|
| | udp:// and rtp:// only |
|
|
|
|
| miface=(device) | device name (e.g. eth0) for multicast |
|
|
|
|
| stream-id=# | ID number (arbitrary) for multiplex/demultiplexing steam in peer connector |
|
|
|
|
| rtp-timestamp=# | carry over the timestamp to/from the rtp header into/from rist (0 or 1) |
|
|
|
|
| rtp-sequence=# | carry over the sequence number to/from the rtp header into/from rist (0 or 1) |
|
|
|
|
| rtp-ptype=# | override the default RTP PTYPE to this value |
|
|
|
|
|
|
|
|
|
