LuaScript
The Lua script to run to draw the overlay.
Specify one of the following:
- the absolute path to the Lua script file. To strengthen security, Media Server can be configured to read files only from specified directories. For information about the directories that Media Server is permitted to read from, see the parameter AllowedInputDirectories.
- the path to the Lua script file, relative to the LuaDirectory.
- a string that matches one of your
AdditionalDataLabels
, (if you use theAdditionalData
andAdditionalDataLabels
action parameters to upload the Lua script file as part of the Process action).
TIP: If your script is relatively short, for example a single line, you can set the parameter LuaLine
instead of LuaScript
. The LuaLine
parameter allows you to specify a small amount of Lua code directly in the configuration file, removing the need for a separate script file.
The script must define a function with the name draw
. The function is passed a record
from the input track, for example:
function draw(record) drawEllipse(record.FaceResult.face.ellipse, 3, rgb(255,255,255)) end
For information about the Lua functions that you can use for drawing, see Drawing Functions.
Type: | String |
Default: | |
Required: | No |
Configuration Section: | TaskName |
Example: | LuaScript=./configurations/draw.lua
|
See Also: |