Skip to content

Commit af741fa

Browse files
committed
Update README.md
1 parent f6f8bd2 commit af741fa

File tree

1 file changed

+7
-23
lines changed

1 file changed

+7
-23
lines changed

README.md

Lines changed: 7 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -32,29 +32,12 @@ The `go-irl` application supports several command line options to customize its
3232
- **`-srtla-port`** (default: `5000`)
3333
Port for the SRTLA upstream. This is the port where your mobile streaming client (IRL Pro, Moblin, BELABOX, etc.) will connect to send the bonded stream.
3434

35+
- **`-passphrase`** (default: `""`)
36+
Optional passphrase for SRT encryption. When set, both the server and client must use the same passphrase to establish a secure encrypted connection. This adds an extra layer of security to your stream.
37+
3538
- **`-verbose`** (default: `false`)
3639
Enable verbose logging in SRTLA. Use this flag to get detailed logging information for troubleshooting connection issues.
3740

38-
### Usage Examples
39-
40-
Run with default settings:
41-
42-
```bash
43-
./go-irl
44-
```
45-
46-
Run with custom ports:
47-
48-
```bash
49-
./go-irl -srtla-port 5001 -udp-port 5003 -ws-port 8889 -bs-port 10000
50-
```
51-
52-
Run with verbose logging enabled:
53-
54-
```bash
55-
./go-irl -verbose
56-
```
57-
5841
## Getting Started
5942

6043
Follow these steps to download the tools, and configure OBS.
@@ -115,19 +98,20 @@ First, configure OBS to receive the stream and use the bridge for stats and scen
11598
| ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
11699
| simple | <img width="345" alt="スクリーンショット 2025-06-29 22 42 24" src="https://github.com/user-attachments/assets/ce8dd8b6-fb3b-44e8-aacc-f74f24d3b2b5" /> |
117100
| graph | <img width="347" alt="スクリーンショット 2025-06-29 22 41 47" src="https://github.com/user-attachments/assets/bd77524d-f5ae-43ce-84b9-616bca1e6110" /> |
118-
| none | (none, just for switching scene)
101+
| none | (none, just for switching scene) |
119102
120103
**Metric Explanations (left to right):**
121-
104+
122105
- Bitrate (Mbps)
123106
- RTT (ms)
124107
- Packet Loss (%)
108+
125109
- Set the Width and Height as desired.
126110
- **IMPORTANT:** For automatic scene switching to work, scroll down in the properties window and set **Page permissions** to **Advanced access to OBS**.
127111
- Click OK.
128112
129113
<img width="800" src="https://github.com/user-attachments/assets/6bb9e601-a2e1-453c-98e0-ea6488f838e4" />
130-
114+
131115
132116
---
133117

0 commit comments

Comments
 (0)