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

add helptext, remove commands

Browse Source
This commit is contained in:
jb-alvarado 2020-04-14 10:50:44 +02:00
parent 3c03be8f95
commit 10d75fb9f7
1 changed files with 37 additions and 73 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

110
ffplayout.yml
View File

@ -1,39 +1,17 @@
# This file is part of ffplayout.
#
# ffplayout is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# ffplayout is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with ffplayout. If not, see <http://www.gnu.org/licenses/>.
# ------------------------------------------------------------------------------
# sometimes it can happen, that a file is corrupt but still playable,
# this can produce an streaming error over all following files
# the only way in this case is, to stop ffplayout and start it again
# here we only say it can stop, the starting process is in your hand
# best way is a systemd serivce on linux
# stop_threshold: stop ffplayout, if it is async in time above this value
general: general:
helptext: Sometimes it can happen, that a file is corrupt but still playable,
this can produce an streaming error over all following files. The only way
in this case is, to stop ffplayout and start it again here we only say it
can stop, the starting process is in your hand. Best way is a systemd serivce
on linux. 'stop_threshold' stop ffplayout, if it is async in time above this
value.
stop_on_error: True stop_on_error: True
stop_threshold: 11 stop_threshold: 11
# send error messages to email address, like:
# missing playlist
# unvalid json format
# missing clip path
# leave recipient blank, if you don't need this
# mail_level can be: WARNING, ERROR
mail: mail:
helptext: Send error messages to email address, like missing playlist; unvalid
json format; missing clip path. Leave recipient blank, if you don't need this.
'mail_level' can be WARNING or ERROR.
subject: "Playout Error" subject: "Playout Error"
smpt_server: "mail.example.org" smpt_server: "mail.example.org"
smpt_port: 587 smpt_port: 587
@ -42,30 +20,23 @@ mail:
recipient: recipient:
mail_level: "ERROR" mail_level: "ERROR"
# Logging to file
# if log_to_file: False > log to console
# path to /var/log/ only if you run this program as deamon
# log_level can be: DEBUG, INFO, WARNING, ERROR
# ffmpeg_level can be: INFO, WARNING, ERROR
logging: logging:
helptext: Logging to file, if 'log_to_file' False log to console. Path to /var/log/
only if you run this program as deamon. 'log_level' can be DEBUG, INFO, WARNING,
ERROR. 'ffmpeg_level' can be INFO, WARNING, ERROR.
log_to_file: True log_to_file: True
log_path: "/var/log/ffplayout/" log_path: "/var/log/ffplayout/"
log_level: "DEBUG" log_level: "DEBUG"
ffmpeg_level: "ERROR" ffmpeg_level: "ERROR"
# output settings for the pre-compression
# all clips get prepared in that way,
# so the input for the final compression is unique
# aspect mus be a float number
# logo is only used if the path exist
# with logo_opacity logo can make transparent
# with logo_filter: overlay=W-w-12:12 you can modify the logo position
# with use_loudnorm you can activate single pass EBU R128 loudness normalization
# loud_* can adjust the loudnorm filter
# INFO: output is progressive!
pre_compress: pre_compress:
helptext: Settings for the pre-compression. All clips get prepared in that way,
so the input for the final compression is unique. 'aspect' must be a float
number. 'logo' is only used if the path exist. With 'logo_opacity' logo can
become transparent. With 'logo_filter' 'overlay=W-w-12:12' you can modify
the logo position. With 'use_loudnorm' you can activate single pass EBU R128
loudness normalization. 'loud_*' can adjust the loudnorm filter. [Output is
always progressive!]
width: 1024 width: 1024
height: 576 height: 576
aspect: 1.778 aspect: 1.778
@ -79,29 +50,24 @@ pre_compress:
loud_TP: -1.5 loud_TP: -1.5
loud_LRA: 11 loud_LRA: 11
# playlist settings
# set playlist_mode to False if you want to play clips from the [STORAGE] section
# put only the root path here, for example: "/playlists"
# subfolders are readed by the script
# subfolders needs this structur:
# "/playlists/2018/01" (/playlists/year/month)
# day_start 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 playlist, when is blank real length will not consider
playlist: playlist:
helptext: Set 'playlist_mode' to 'False' if you want to play clips from the [STORAGE]
section. Put only the root path here, for example '/playlists' subfolders
are readed by the script. Subfolders needs this structur '/playlists/2018/01'
(/playlists/year/month). 'day_start' 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 playlist, when is blank real length
will not consider.
playlist_mode: True playlist_mode: True
path: "/playlists" path: "/playlists"
day_start: "5:59:25" day_start: "5:59:25"
length: "24:00:00" length: "24:00:00"
# play ordered or ramdomly files from path
# filler_path are for the GUI only at the moment
# filler_clip is for fill the end to reach 24 hours, it will loop when is necessary
# extensions: search only files with this extension, can be a list
# set shuffle to True to pick files randomly
storage: storage:
helptext: Play ordered or ramdomly files from path. 'filler_path' are for the
GUI only at the moment. 'filler_clip' is for fill the end to reach 24 hours,
it will loop when is necessary extensions search only files with this extension,
can be a list. Set 'shuffle' to 'True' to pick files randomly.
path: "/mediaStorage" path: "/mediaStorage"
filler_path: "/mediaStorage/filler/filler-clips" filler_path: "/mediaStorage/filler/filler-clips"
filler_clip: "/mediaStorage/filler/filler.mp4" filler_clip: "/mediaStorage/filler/filler.mp4"
@ -110,20 +76,18 @@ storage:
- ".mkv" - ".mkv"
shuffle: True shuffle: True
# overlay text in combination with messenger: https://github.com/ffplayout/messenger
# 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: text:
add_text: True helptext: Overlay text in combination with messenger 'https://github.com/ffplayout/messenger'.
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.
add_text: False
bind_address: "tcp://127.0.0.1:5555" bind_address: "tcp://127.0.0.1:5555"
fontfile: "/usr/share/fonts/truetype/dejavu/DejaVuSans.ttf" fontfile: "/usr/share/fonts/truetype/dejavu/DejaVuSans.ttf"
# the final playout post compression
# set the settings to your needs
# preview works only on a desktop system with ffplay!! Set it to True, if you need it
out: out:
helptext: The final playout post compression. Set the settings to your needs.
'preview' works only on a desktop system with ffplay!! Set it to 'True', if
you need it.
preview: False preview: False
service_name: "Live Stream" service_name: "Live Stream"
service_provider: "example.org" service_provider: "example.org"