update readme / config readme

This commit is contained in:
aler9 2021-08-14 11:40:35 +02:00
parent 9486f4f32d
commit 67e0db13ab
2 changed files with 13 additions and 5 deletions

View file

@ -318,7 +318,7 @@ ffmpeg -re -stream_loop -1 -i file.ts -c copy -f flv rtmp://localhost:8554/mystr
### HLS protocol
HLS is a media format that allows to embed live streams into web pages, inside standard `<video>` HTML tags. Every stream published to the server can be accessed with a web browser by visiting
HLS is a media format that allows to embed live streams into web pages. Every stream published to the server can be accessed with a web browser by visiting:
```
http://localhost:8888/mystream
@ -326,6 +326,14 @@ http://localhost:8888/mystream
where `mystream` is the name of a stream that is being published.
The direct HLS URL, that can be used to read the stream with Javascript libraries (hls.js) can be obtained by appending `/stream.m3u8`:
```
http://localhost:8888/mystream/stream.m3u8
```
Please note that most browsers don't support HLS directly (except Safari); a Javascript library, like [hls.js](https://github.com/video-dev/hls.js/), must be used to load the stream.
### Publish from OBS Studio
In `Settings -> Stream` (or in the Auto-configuration Wizard), use the following parameters:

View file

@ -98,16 +98,16 @@ rtmpAddress: :1935
hlsDisable: no
# address of the HLS listener.
hlsAddress: :8888
# whether to always start the HLS remuxer; otherwise, it is started only
# after an HLS stream is requested.
# by default, HLS is generated only when requested by a user;
# this option allows to generate it always, avoiding an initial delay.
hlsAlwaysRemux: no
# number of HLS segments to generate.
# increasing segments allows more buffering,
# decreasing segments decreases latency.
hlsSegmentCount: 3
# minimum duration of each segment.
# the real segment duration is also influenced by the interval between IDR frames,
# since the server changes the segment duration to include at least one IDR frame in each.
# the final segment duration is also influenced by the interval between IDR frames,
# since the server changes the segment duration to include at least a IDR frame in each one.
hlsSegmentDuration: 1s
# value of the Access-Control-Allow-Origin header provided in every HTTP response.
# This allows to play the HLS stream from an external website.