diff --git a/README.md b/README.md index 9b3d2bae..c3cb1532 100644 --- a/README.md +++ b/README.md @@ -174,18 +174,27 @@ paths: After starting the server, the webcam is available on `rtsp://localhost:8554/cam`. -### On-demand publishing +### Output HLS Edit `rtsp-simple-server.yml` and replace everything inside section `paths` with the following content: ```yml paths: - ondemand: - runOnDemand: ffmpeg -re -stream_loop -1 -i file.ts -c copy -f rtsp rtsp://localhost:$RTSP_PORT/$RTSP_PATH - runOnDemandRestart: yes + all: + runOnPublish: ffmpeg -re -i rtsp://localhost:$RTSP_PORT/$RTSP_PATH -c copy -f hls -hls_time 1 -hls_list_size 3 -hls_flags delete_segments -hls_allow_cache 0 stream.m3u8 + runOnPublishRestart: yes ``` -The command inserted into `runOnDemand` will start only when a client requests the path `ondemand`, therefore the file will start streaming only when requested. +Every time someone publishes a stream, the server will produce HLS segments, that can be served by a web server. + +The example above makes the assumption that the incoming stream is encoded with H264 and AAC, since they are the only codecs supported by HLS; if the incoming stream is encoded with different codecs, it must be converted: + +```yml +paths: + all: + runOnPublish: ffmpeg -re -i rtsp://localhost:$RTSP_PORT/$RTSP_PATH -c:a aac -b:a 64k -c:v libx264 -preset ultrafast -b:v 500k -f hls -hls_time 1 -hls_list_size 3 -hls_flags delete_segments -hls_allow_cache 0 stream.m3u8 + runOnPublishRestart: yes +``` ### Remuxing, re-encoding, compression @@ -195,10 +204,23 @@ To change the format, codec or compression of a stream, use _FFmpeg_ or _Gstream paths: all: original: - runOnPublish: ffmpeg -i rtsp://localhost:$RTSP_PORT/$RTSP_PATH -b:a 64k -c:v libx264 -preset ultrafast -b:v 500k -max_muxing_queue_size 1024 -f rtsp rtsp://localhost:$RTSP_PORT/compressed + runOnPublish: ffmpeg -i rtsp://localhost:$RTSP_PORT/$RTSP_PATH -c:v libx264 -preset ultrafast -b:v 500k -max_muxing_queue_size 1024 -f rtsp rtsp://localhost:$RTSP_PORT/compressed runOnPublishRestart: yes ``` +### On-demand publishing + +Edit `rtsp-simple-server.yml` and replace everything inside section `paths` with the following content: + +```yml +paths: + ondemand: + runOnDemand: ffmpeg -re -stream_loop -1 -i file.ts -c copy -f rtsp rtsp://localhost:$RTSP_PORT/$RTSP_PATH + runOnDemandRestart: yes +``` + +The command inserted into `runOnDemand` will start only when a client requests the path `ondemand`, therefore the file will start streaming only when requested. + ### Redirect to another server To redirect to another server, use the `redirect` source: