Media Server 25.4
Media Server Help

# Create an Overlay

The `Overlay` transformation task creates an overlay for a video. The task draws regions (such as rectangles, polygons, and ellipses) that are present in the input records.

To create an overlay for a video

1. Create a new configuration to send to Media Server with the `process` action, or open an existing configuration that you want to modify.

2. In the `[Session]` section, add a new task by setting the `EngineN` parameter. You can give the task any name, for example:

       [Session]
       Engine0=Ingest
       ...
       Engine2=Overlay

3. Create a new configuration section to contain the task settings and set the following parameters:

   `Type` | The transformation engine to use. Set this parameter to `Overlay`.
   `Input` | The name of the track that contains the metadata to use to draw the overlay. This track does not need to include the video frames.
   `Color` | (Optional) The line color to use when drawing.
   `Thickness` | (Optional) The line thickness to use when drawing. Specify the thickness in pixels.

   For example:

       [Overlay]
       Type=Overlay
       Input=FaceDetection.Result
       Color=Red
       Thickness=1

4. When you define your encoding task, use the parameter `OverlayInput` to specify the name of the output track from the overlay transformation task. In this example the track is named `Overlay.Output`.

5. Save and close the configuration file. OpenText recommends that you save your configuration files in the location specified by the `ConfigDirectory` parameter.

Example configuration to ingest video and create an overlay

The following example configuration ingests a video file or stream and encodes a video with an overlay that shows detected faces.

    [Ingest]
    IngestEngine=AV

    [AV]
    Type=Video

    [Analysis]
    AnalysisEngine0=FaceDetect

    [FaceDetect]
    Type=FaceDetect
    NumParallel=6
    MinSize=10%

    [Transform]
    TransformEngine0=Overlay

    [Overlay]
    Type=Overlay
    Input=FaceDetect.Result
    Color=Orange
    Thickness=1

    [Encoding]
    EncodingEngine0=RollingBuffer

    [RollingBuffer]
    Type=RollingBuffer
    ImageInput=Default_Image
    AudioInput=None
    OverlayInput=Overlay.Output
    Stream=stream1

Copyright 2025 Open Text
Version 25.4 | Last updated October 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.4

Topic Title: Create an Overlay