diff --git a/client/src/main/resources/html/docs/ConfigurationFile.md b/client/src/main/resources/html/docs/ConfigurationFile.md index 24269c91..57d96ccc 100644 --- a/client/src/main/resources/html/docs/ConfigurationFile.md +++ b/client/src/main/resources/html/docs/ConfigurationFile.md @@ -55,4 +55,4 @@ the port ctbrec tries to connect to, if it is run in remote mode. - **recordingsDir** - Where ctbrec saves the recordings. - **splitRecordings** (app only) - [0 - 2147483647] in seconds. Split recordings after this amount of seconds. The recordings are split up into several individual recordings, -which have the defined length (roughly). 0 means no splitting. +which have the defined length (roughly). 0 means no splitting. The server does not support splitRecordings. diff --git a/client/src/main/resources/html/docs/PostProcessing.md b/client/src/main/resources/html/docs/PostProcessing.md index 7846af15..693d00ef 100644 --- a/client/src/main/resources/html/docs/PostProcessing.md +++ b/client/src/main/resources/html/docs/PostProcessing.md @@ -1 +1,23 @@ -#### Post-Processing \ No newline at end of file +#### Post-Processing +The post-processing gives you the possibility to run any script / program after a recording has finished. You can use that to convert +the files to another format, create preview images, rename / move the file etc. +There are example scripts included in the distribution zip (`pp.bat`, `pp.ps1`, `pp.sh`). See also the comments in those files. + +##### Local Recording +If you are using the local recording mode, you can set the post-processing script / program on the settings tab under *Recorder* -> *Post-Processing*. +ctbrec will call the selected script after the recording has finished with the following parameters: + +1. directory (absolute path) +2. file (absolute path) +3. model name +4. site name +5. unixtime (seconds since 1/1/1970 00:00) + +##### Remote Recording (server) +If you are running the server and want to run a post-processing script, you have to edit the [configuration file](/docs/ConfigurationFile.md). Just set the absolute path to an executable script / program for the setting **postProcessing**. Since the recordings look a bit different for the server, the parameters, which are passed to the script are a bit different, too: + +1. parent directory (absolute path) +2. directory of the recording (absolute path) - this directory contains the segments and the playlist +3. model name +4. site name +5. unixtime (seconds since 1/1/1970 00:00)