typo and update description

This commit is contained in:
jb-alvarado 2022-08-12 10:32:00 +02:00
parent f2fc5a5263
commit e5840f2ff8

View File

@ -8,8 +8,8 @@ general:
stop_threshold: 11 stop_threshold: 11
rpc_server: rpc_server:
help_text: Run a JSON RPC server, for getting infos about current playing, and help_text: Run a JSON RPC server, for getting infos about current playing and
control for some functions. for some control functions.
enable: true enable: true
address: 127.0.0.1:7070 address: 127.0.0.1:7070
authorization: av2Kx8g67lF9qj5wEH3ym1bI4cCs authorization: av2Kx8g67lF9qj5wEH3ym1bI4cCs
@ -17,7 +17,8 @@ rpc_server:
mail: mail:
help_text: Send error messages to email address, like missing playlist; invalid help_text: Send error messages to email address, like missing playlist; invalid
json format; missing clip path. Leave recipient blank, if you don't need this. json format; missing clip path. Leave recipient blank, if you don't need this.
'mail_level' can be INFO, WARNING or ERROR. 'interval' means seconds until a new mail will be sended. 'mail_level' can be INFO, WARNING or ERROR. 'interval' means seconds until
a new mail will be sended.
subject: Playout Error subject: Playout Error
smtp_server: mail.example.org smtp_server: mail.example.org
starttls: true starttls: true
@ -28,11 +29,11 @@ mail:
interval: 30 interval: 30
logging: logging:
help_text: Logging to file, if 'log_to_file' false log to console. 'backup_count' help_text: If 'log_to_file' is true, log to file, when is false log to console.
says how long log files will be saved in days. 'local_time' to false will set 'backup_count' says how long log files will be saved in days. 'local_time' to
log timestamps to UTC. Path to /var/log/ only if you run this program as daemon. false will set log timestamps to UTC. Path to /var/log/ only if you run this
'log_level' can be DEBUG, INFO, WARNING, ERROR. 'ffmpeg_level' can be info, program as daemon. 'log_level' can be DEBUG, INFO, WARNING, ERROR.
warning, error. 'ffmpeg_level' can be info, warning, error.
log_to_file: true log_to_file: true
backup_count: 7 backup_count: 7
local_time: true local_time: true
@ -42,15 +43,14 @@ logging:
ffmpeg_level: error ffmpeg_level: error
processing: processing:
help_text: Default processing, for all clips that they get prepared in that way, help_text: Default processing for all clips, to have them unique. Mode can be playlist
so the output is unique. Set playing mode, like playlist, or folder. or folder. 'aspect' must be a float number. 'logo' is only used if the path exist.
'aspect' must be a float number. 'logo' is only used if the path exist.
'logo_scale' scale the logo to target size, leave it blank when no scaling 'logo_scale' scale the logo to target size, leave it blank when no scaling
is needed, format is 'number:number', for example '100:-1' for proportional is needed, format is 'number:number', for example '100:-1' for proportional
scaling. With 'logo_opacity' logo can become transparent. With 'logo_filter' scaling. With 'logo_opacity' logo can become transparent. With 'logo_filter'
'overlay=W-w-12:12' you can modify the logo position. With 'use_loudnorm' 'overlay=W-w-12:12' you can modify the logo position. With 'use_loudnorm'
you can activate single pass EBU R128 loudness normalization. you can activate single pass EBU R128 loudness normalization. 'loud_*' can
'loud_*' can adjust the loudnorm filter. adjust the loudnorm filter.
mode: playlist mode: playlist
width: 1024 width: 1024
height: 576 height: 576
@ -69,10 +69,9 @@ processing:
volume: 1 volume: 1
ingest: ingest:
help_text: Works not with direct hls output, it always needs full processing! Run a server help_text: Run a server for a ingest stream. This stream will override the normal streaming
for a ingest stream. This stream will override the normal streaming until is done. until is done. There is only a very simple authentication mechanism, which check if the
There is no authentication, this is up to you. The recommend way is to set address to stream name is correct.
localhost, stream to a local server with authentication and from there stream to this app.
enable: false enable: false
input_param: -f live_flv -listen 1 -i rtmp://localhost:1936/live/stream input_param: -f live_flv -listen 1 -i rtmp://localhost:1936/live/stream
@ -83,7 +82,7 @@ playlist:
script. Subdirectories needs this structure '/playlists/2018/01'. 'day_start' script. Subdirectories needs this structure '/playlists/2018/01'. 'day_start'
means at which time the playlist should start, leave day_start blank when playlist means at which time the playlist should start, leave day_start blank when playlist
should always start at the begin. 'length' represent the target length from should always start at the begin. 'length' represent the target length from
playlist, when is blank real length will not consider. 'infinit true' works with playlist, when is blank real length will not consider. 'infinit: true' works with
single playlist file and loops it infinitely. single playlist file and loops it infinitely.
path: /var/lib/ffplayout/playlists path: /var/lib/ffplayout/playlists
day_start: "5:59:25" day_start: "5:59:25"
@ -93,7 +92,7 @@ playlist:
storage: storage:
help_text: Play ordered or randomly files from path. 'filler_clip' is for fill help_text: Play ordered or randomly files from path. 'filler_clip' is for fill
the end to reach 24 hours, it will loop when is necessary. 'extensions' search the end to reach 24 hours, it will loop when is necessary. 'extensions' search
only files with this extension. Set 'shuffle' to 'True' to pick files randomly. only files with this extension. Set 'shuffle' to 'true' to pick files randomly.
path: "/var/lib/ffplayout/tv-media" path: "/var/lib/ffplayout/tv-media"
filler_clip: "/var/lib/ffplayout/tv-media/filler/filler.mp4" filler_clip: "/var/lib/ffplayout/tv-media/filler/filler.mp4"
extensions: extensions:
@ -104,7 +103,6 @@ storage:
text: text:
help_text: Overlay text in combination with libzmq for remote text manipulation. help_text: Overlay text in combination with libzmq for remote text manipulation.
On windows fontfile path need to be like this 'C\:/WINDOWS/fonts/DejaVuSans.ttf'. On windows fontfile path need to be like this 'C\:/WINDOWS/fonts/DejaVuSans.ttf'.
In a standard environment the filter drawtext node is Parsed_drawtext_2.
'text_from_filename' activate the extraction from text of a filename. With 'style' 'text_from_filename' activate the extraction from text of a filename. With 'style'
you can define the drawtext parameters like position, color, etc. Post Text over you can define the drawtext parameters like position, color, etc. Post Text over
API will override this. With 'regex' you can format file names, to get a title from it. API will override this. With 'regex' you can format file names, to get a title from it.
@ -117,8 +115,8 @@ text:
out: out:
help_text: The final playout compression. Set the settings to your needs. 'mode' help_text: The final playout compression. Set the settings to your needs. 'mode'
has the options 'desktop', 'hls', 'null', 'stream'. Use 'stream' and adjust has the options 'desktop', 'hls', 'null', 'stream'. Use 'stream' and adjust
'output_param:' settings, when you want to stream to a rtmp/rtsp/srt/... server. 'output_param:' settings when you want to stream to a rtmp/rtsp/srt/... server.
In production don't server hls playlist with ffpapi, use nginx or another web server! In production don't serve hls playlist with ffpapi, use nginx or another web server!
mode: hls mode: hls
output_param: >- output_param: >-
-c:v libx264 -c:v libx264