Media Server 25.2
Media Server Help

# 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 the `AdditionalData` and `AdditionalDataLabels` action parameters to upload the Lua script file as part of the Process action).

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: |

Copyright 2025 Open Text
Version 25.2 | Last updated April 2025

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: Knowledge Discovery Media Server 25.2

Topic Title: LuaScript