Skip to content

Commit

Permalink
Improve examples (#890)
Browse files Browse the repository at this point in the history
* [docs] Improve examples
Example for running live transmit app in listener mode, listening on a specific network interface
  • Loading branch information
dprestegard authored and rndi committed Oct 16, 2019
1 parent cc36fdb commit 1df240e
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/stransmit.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,19 @@ This mode can be specified explicitly using the **mode** parameter. When it's n
- `srt://:1234` - the *port* is specified (1234), but *host* is empty. This assumes **listener** mode.
- `srt://remote.host.com:1234` - both *host* ***and*** *port* are specified. This assumes **caller** mode.

When the `mode` parameter is specified explicitly, then the interpretation of the `host` part is the following:

* For caller, it's always the destination host address. If this is empty, it is resolved to `0.0.0.0`, which usually should mean connecting to the local host
* For listener, it defines the IP address of the local device on which the socket should listen, e.g.:

```
srt://10.10.10.100:5001?mode=listener
```
An alternative method to specify this IP address is the `adapter` parameter:
```
srt://:5001?adapter=10.10.10.100
```

The **rendezvous** mode is not deduced and it has to be specified
explicitly. Note also special cases of the **host** and **port** parts
specified in the URI:
Expand Down

0 comments on commit 1df240e

Please sign in to comment.