Skip to content

Commit 0567f6f

Browse files
authored
docs: enhance clarity in streaming documentation (#697)
This commit updates the wording in the streaming-related documentation to improve clarity. It provides more precise guidance for users on which elements they need to interact with to achieve their desired outcome.
1 parent 219ab35 commit 0567f6f

File tree

3 files changed

+22
-25
lines changed

3 files changed

+22
-25
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview
66
the documentation changes locally. To install, use the following command
77

8-
```
8+
```bash
99
npm i -g mintlify
1010
```
1111

1212
Run the following command at the root of your documentation (where mint.json is)
1313

14-
```
14+
```bash
1515
mintlify dev
1616
```

gateways/guides/playback-content.mdx

+5-10
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,8 @@ This section explains how to view content from the Livepeer Gateway. We will be
99
using [VLC Media Player](https://videolan.org/).
1010

1111
1. Download and install
12-
[VLC Media Player](https://www.videolan.org/vlc/index.html)
13-
14-
2. Launch VLC Media Player
15-
16-
3. Select Media > Open Network Stream... (Ctrl-N)
17-
18-
4. Enter `http://<GATEWAY IP ADDRESS>:8935/stream/<YOUR STREAM KEY>.m3u8` as the
19-
network URL
20-
21-
5. Click "Play", and view the content from the `obs-studio` stream:
12+
[VLC Media Player](https://www.videolan.org/vlc/index.html).
13+
2. Launch VLC Media Player.
14+
3. Select **Media > Open Network Stream...** (Ctrl-N).
15+
4. Enter `http://<GATEWAY IP ADDRESS>:8935/stream/<YOUR STREAM KEY>.m3u8` as the network URL.
16+
5. Click **Play** and view the content from the `obs-studio` stream.

gateways/guides/publish-content.mdx

+15-13
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,10 @@ ffmpeg -re -f lavfi -i \
3939

4040
```
4141
ffmpeg \
42-
-re \
43-
-i video.mov \
44-
-codec copy \
45-
-f flv rtmp://<YOUR IP ADDRESS>:1935/video_file
42+
-re \
43+
-i video.mov \
44+
-codec copy \
45+
-f flv rtmp://<YOUR IP ADDRESS>:1935/video_file
4646
```
4747

4848
- `video_file` is the "stream key" for this stream.
@@ -56,14 +56,16 @@ graphical user interface (GUI).
5656

5757
OBS Studio can be used to publish streaming media to the Livepeer Gateway:
5858

59-
Download and install [OBS Studio](https://obsproject.com/)
59+
1. Install [OBS Studio](https://obsproject.com/).
60+
2. Open OBS Studio and go to **File > Settings > Stream**.
61+
3. Enter the following details:
6062

61-
In the **Stream** section of OBS Studio enter the following:
63+
```txt
64+
Service: Custom
65+
Server: rtmp://<YOUR IP ADDRESS>:1935
66+
Stream Key: stream-key
67+
```
6268

63-
```
64-
Service: Custom
65-
Server: rtmp://<YOUR IP ADDRESS>:1935
66-
Stream Key: stream-key
67-
```
68-
69-
In the main window choose **Start Streaming**
69+
4. Go to the **Output** tab and set **Output Mode** to **Advanced**.
70+
5. Set the **Keyframe Interval** to `1`.
71+
6. Click **OK** and then **Start Streaming** in the main window.

0 commit comments

Comments
 (0)