History

jb-alvarado 449268dfe0 fix playlist switch, when total_delta < threshold - update packages - cleanup code with new clippy - add fake_time cmd arg for debugging - add ignore_chapters only to file source		2022-08-15 14:27:41 +02:00
..
src	fix playlist switch, when total_delta < threshold	2022-08-15 14:27:41 +02:00
Cargo.toml	fix playlist switch, when total_delta < threshold	2022-08-15 14:27:41 +02:00
README.md	Update README.md	2022-07-28 12:02:11 +02:00

README.md

ffplayout-api

ffplayout-api (ffpapi) is a non strict REST API for ffplayout. It makes it possible to control the engine, read and manipulate the config, save playlist, etc.

To be able to use the API it is necessary to initialize the settings database first. To do that, run:

ffpapi -i

Then add an admin user:

ffpapi -u <USERNAME> -p <PASSWORD> -m <MAIL ADDRESS>

Then run the API thru the systemd service, or like:

ffpapi -l 127.0.0.1:8787

Possible Arguments

OPTIONS:
    -a, --ask                    ask for user credentials
    -d, --domain <DOMAIN>        domain name for initialization
    -h, --help                   Print help information
    -i, --init                   Initialize Database
    -l, --listen <LISTEN>        Listen on IP:PORT, like: 127.0.0.1:8787
    -m, --mail <MAIL>            Admin mail address
    -p, --password <PASSWORD>    Admin password
    -u, --username <USERNAME>    Create admin user
    -V, --version                Print version information

If you plan to run ffpapi with systemd set permission from /usr/share/ffplayout and content to user ffpu:ffpu. User ffpu has to be created.

For possible endpoints read: api endpoints

ffpapi can also serve the browser based frontend, just run in your browser 127.0.0.1:8787.