Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Custom Overlays feature is a significant enhancement in just:in mac v.6.0, which essentially functions as a graphics engine within a Capture Preset. This new feature allows users to overlay recordings with different types of static and/or dynamic data. Here is a list of the available data fields:

  • Text

  • Images

  • Metadata values (just:in mac metadata values)

  • SMPTE Timecode

  • Date and Date-time values

All of these values can be combined into an Overlay Preset file, which can be fully customised according to individual values. Furthermore, it is possible to integrate external data sources, with the engine Just In Engine checking for updates at regular intervals of every xseconds.

General

Custom Overlays rely on custom ToolsOnAir JSON files, which must be written and formatted in a specific manner. The documentation and explanation for the required format can be found below. Additionally, external data sources can be seamlessly integrated and utilise the commonly used JSON format.

...

Below, you can find the file structure of these JSON files:

Info

Basically, the JSON file consists of two different parts:

  • data“data-adapters: for external data integrations

  • components“components”: actual data overlays

Code Block
languagejson
{
  "data-adapters" : [
    {
      "mappings" : {
        "d" : "d",
        "p" : "p",
        "t" : "t",
        "a" : "a",
        "h" : "h"
      },
      "update-interval" : 2,
      "name" : "Example",
      "type" : "json",
      "url" : "file:\/\/\/example.txt"
    },
    {
      "update-interval" : 0,
      "name" : "date-time",
      "type" : "date-time",
    }
  ],
  "components" : [
      {
        "insets" : {
          "bottom" : 0,
          "top" : 0,
          "left" : 0,
          "right" : 0
        },
        "w" : 480,
        "h" : 50,
        "font" : {
          "name" : ".AppleSystemUIFont",
          "size" : 40
        },
        "x" : 80,
        "outline-width" : -1,
        "y" : 980,
        "draws-background" : false,
        "hidden-when-empty" : false,
        "string-value": "ToolsOnAir Example",
        "background-colour" : {
          "r" : 0,
          "b" : 0,
          "g" : 0,
          "a" : 0.5
        },
        "type" : "text",
        "outline-colour" : {
          "r" : 0,
          "b" : 0,
          "g" : 0,
          "a" : 1
        },
        "alpha" : 1,
        "alignment" : 0,
        "hidden" : false,
        "text-colour" : {
          "r" : 1,
          "b" : 1,
          "g" : 1,
          "a" : 1
        }
      },
      {
        "insets" : {
          "bottom" : 0,
          "top" : 0,
          "left" : 0,
          "right" : 0
        },
        "w" : 480,
        "h" : 50,
        "font" : {
          "name" : ".AppleSystemUIFont",
          "size" : 40
        },
        "x" : 1360,
        "outline-width" : -1,
        "y" : 980,
        "draws-background" : false,
        "hidden-when-empty" : false,
        "metadata-value" : {
          "accepts-number" : false,
          "key" : "Just_In_Channel_Name",
          "type" : "datavalue",
          "accepts-string" : true,
          "retain-previous-on-empty" : true,
        },
        "background-colour" : {
          "r" : 0,
          "b" : 0,
          "g" : 0,
          "a" : 0.5
        },
        "type" : "text",
        "outline-colour" : {
          "r" : 0,
          "b" : 0,
          "g" : 0,
          "a" : 1
        },
        "alpha" : 1,
        "alignment" : 2,
        "hidden" : false,
        "text-colour" : {
          "r" : 1,
          "b" : 1,
          "g" : 1,
          "a" : 1
        }
      }
      ],
  "async-data-updates" : false
}