Skip to content

Commit

Permalink
chore: add section about ffmpeg to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Julusian authored Sep 4, 2023
1 parent 7f4b3b5 commit d22490f
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@ Usage

This project is designed to be used via the AMCP protocol in CasparCG server. However, there are some endpoints for additional data which can only be access directly over http.

### Requirements

The scanner needs a copy of `ffmpeg` to be able to scan any media files. On windows, a copy of `ffmpeg.exe` should be placed in the same folder as the scanner executable. On linux, `ffmpeg` should be made available on the path.
You can override these locations in the scanner configuration.

### Configuration
There are various options that can be changed for the scanner. These can all be set by environment variables or as arguments.
Some features are disabled by default and should be enabled in this way.
Expand Down

0 comments on commit d22490f

Please sign in to comment.