Skip to main content

Graphics Engine

warning

This feature is under active development and is only available on develop builds and tags.

The ErsatzTV graphics engine is used to overlay custom graphics elements (images and text) on top of the primary content with a high degree of control and customization.

Graphics Element Definitions​

Graphics elements are defined in YAML files located in the ErsatzTV config folder / templates / graphics-elements subfolder. Image graphics elements definitions should be placed in the image subfolder, and text graphics element definitions should be placed in the text subfolder. ErsatzTV will automatically create these (empty) folders on startup.

Image Elements​

Image elements are used to draw images, similar to watermarks but without the need to configure using the UI.

opacity_percent: 100

location: "BottomLeft"
horizontal_margin_percent: 5
vertical_margin_percent: 5

z_index: 1

scale: true
scale_width_percent: 15

image: "/home/user/Pictures/watermark.gif"

Text Elements​

Text elements are used to draw text, and support dynamic text using Scriban templates and variables.

opacity_percent: 100

location: "BottomLeft"
horizontal_margin_percent: 5
vertical_margin_percent: 5

z_index: 2

styles:
  - name: "style1"
    font_family: "OPTIKabel-Heavy"
    font_size: 48
    text_color: "#FFFFFF"
    #font_weight: 800
    #font_italic: true
    #letter_spacing: 20

base_style: "style1"

# optionally include fonts from a specific folder
include_fonts_from: "/home/user/fonts"

# optionally include data from epg entries for text replacement
epg_entries: 0

text: |
  One Line Of Text
  Two Lines Of Text

Subtitle Elements​

Subtitle elements are used to draw subtitles, and support dynamic subtitles using Scriban templates and variables.

z_index: 3

# optionally include data from epg entries for text replacement
epg_entries: 0

template: "/home/user/subtitles.ass"

Using Graphics Elements​

YAML Playouts​

Graphics elements can be turned on and off using the YAML Playout Instructions Graphics On and Graphics Off.

Troubleshooting​

Multiple graphics elements can be selected for immediate testing in the playback troubleshooting tool.