Overlay options #

Introduced in Nimbra Edge R3.25

This article lists the recommended usage of overlays and supported options in Nimbra Edge.

Usage #

Overlays are added as part of a Transcoding transformation with Video Transcoding enabled. The overlay is applied during the encoding stage of the transcoding process.

Warning: When saving overlays which are in use, the stream will be momentarily interrupted as the changes are applied.

Overlay components #

Overlays are comprised of image and text components.

Image components #

Options #

• X and Y Alignment: Left, Right, Top, Bottom
• X and Y Offset: Distance in pixels from the edge of the canvas in the direction of the selected alignment
• Opacity: 0-1 (0 is fully transparent, 1 is fully opaque)
• Bounding box: The image size is automatically adjusted to fit within the specified bounding box. The aspect ratio is maintained.

Limitations #

Images must be:

• Less than 1 MB
• In PNG format

Text components #

Text components support either custom text or presets useful for displaying debug information.

Options #

• X and Y Alignment: Left, Right, Top, Bottom
• X and Y Offset: Distance in pixels from the edge of the canvas in the direction of the selected alignment
• Font size: Font size, in pixels
• Font color: Hex color code (e.g. #FF0000 for red)
• Background color: Hex color and transparency code (e.g. #FF0000CC for red, semi-transparent)
• Border width: Width of the border around the text, in pixels

Presets #

• Datetime: Displays the current date and time in ISO 8601 format
• Timecode: Displays a timecode in HH:MM:SS:FF format.
• Codec: Displays the chosen output codec
• Encoder: Displays the encoder used in the transformation pipeline

Limitations #

• Text components support either custom text or presets, but not both in the same component. However, you can add multiple text components to the overlay, mixing and matching custom text and presets.
• Datetime preset is based on the selected timezone region on the video node.
• Timecode preset counts the time from the start of the encode process, unrelated to any upstream timecodes.
• Timecode preset is not supported on Netint accelerators.
• Timecode preset requires framerate to be set in the Transcode transformation.
• Codec and Encoder presets require Video Transcoding to be set in the Transcode transformation.