djsundog/ffplayout
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
jb-alvarado 2021-02-04 16:26:07 +01:00
parent 2c4297861c
commit e28e38453a
1 changed files with 5 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -37,6 +37,8 @@ The purpose with ffplayout is to provide a 24/7 broadcasting solution that plays
- **aevalsrc** (if video have no audio) - **aevalsrc** (if video have no audio)
- **apad** (add silence if audio duration is to short) - **apad** (add silence if audio duration is to short)
- **tpad** (add black frames if video duration is to short) - **tpad** (add black frames if video duration is to short)
- add custom [filters](https://github.com/ffplayout/ffplayout-engine/tree/master/ffplayout/filters)
- add custom [arguments](https://github.com/ffplayout/ffplayout-engine/tree/master/ffplayout/config)
- different types of [output](https://github.com/ffplayout/ffplayout-engine/wiki/Outputs): - different types of [output](https://github.com/ffplayout/ffplayout-engine/wiki/Outputs):
- **stream** - **stream**
- **desktop** - **desktop**
@ -49,6 +51,7 @@ Requirements
- python version 3.6+ - python version 3.6+
- python module **watchdog** (only when `playlist_mode: False`) - python module **watchdog** (only when `playlist_mode: False`)
- python module **colorama** if you are on windows - python module **colorama** if you are on windows
- python modules **PyYAML**, **requests**, **supervisor**
- **ffmpeg v4.2+** and **ffprobe** (**ffplay** if you want to play on desktop) - **ffmpeg v4.2+** and **ffprobe** (**ffplay** if you want to play on desktop)
- if you want to overlay text, ffmpeg needs to have **libzmq** - if you want to overlay text, ffmpeg needs to have **libzmq**
- RAM and CPU depends on video resolution, minimum 4 threads and 3GB RAM for 720p are recommend - RAM and CPU depends on video resolution, minimum 4 threads and 3GB RAM for 720p are recommend
@ -122,10 +125,10 @@ Start with Arguments
ffplayout also allows the passing of parameters: ffplayout also allows the passing of parameters:
- `-c, --config` use given config file - `-c, --config` use given config file
- `-d, --desktop` preview on desktop
- `-f, --folder` use folder for playing - `-f, --folder` use folder for playing
- `-l, --log` for user-defined log path, *none* for console output - `-l, --log` for user-defined log path, *none* for console output
- `-i, --loop` loop playlist infinitely - `-i, --loop` loop playlist infinitely
- `-m, --mode` set output mode: desktop, hls, stream, ...
- `-p, --playlist` for playlist file - `-p, --playlist` for playlist file
- `-s, --start` set start time in *hh:mm:ss*, *now* for start with first' - `-s, --start` set start time in *hh:mm:ss*, *now* for start with first'
- `-t, --length` set length in *hh:mm:ss*, *none* for no length check - `-t, --length` set length in *hh:mm:ss*, *none* for no length check
@ -133,10 +136,5 @@ ffplayout also allows the passing of parameters:
You can run the command like: You can run the command like:
```SHELL ```SHELL
./ffplayout.py -l none -p ~/playlist.json -d -s now -t none ./ffplayout.py -l none -p ~/playlist.json -d -s now -t none -m desktop
``` ```
Play on Desktop
-----
For playing on desktop use `-d` argument or set `mode: 'desktop'` in config under `out:`.