Launch template settings

The launch template settings are defined in the settings block of the launch template file.

Through this settings block you can customize the application and edit particular areas to suit your workflow. In this document you can find all available launch template settings.

{
  "data": [
    ...
  ],
  "settings": [
    {
      "$ref": "https://example.com/remote/settings.json"
    },
    {
      ...
    }
  ]
}

Overlays

The overlays setting defines the overlays that should be available in the poster application.

{
  "overlays": [
    {
      "name": "16:9 Overlay",
      "url": "https://example.com/16-9.png",
      "aspectRatio": "16:9"
    },
    ...
  ]
}

Key	Required	Type	Description
name	Yes	string	The name of the overlay to be shown in the poster application.
url	Yes	string	URL to the overlay image file.
aspectRatio	Yes	string	Aspect ratio of the image.

Poster resolutions

The posterResolutions setting is a list of strings in the format [width]x[height]. It defines the resolutions that can be selected when editing a poster snapshot.

{
  "posterResolutions": ["3840x2160", "2560x1440", "1920x1080"]
}

Poster formats

The posterFormats setting defines the formats that can be selected when creating a poster. The format value is passed along when publishing a poster.

{
  "posterFormats": [
    {
      "label": "PNG",
      "value": "png"
    }
  ]
}

Key	Required	Type	Description
label	Yes	string	The name of the format to be shown in the poster application.
value	Yes	string	The value to pass along when publishing the poster.

Poster presets

The posterPresets setting provides a way to define preconfigured presets to use when editing a poster snapshot. The resolution and format values must match values defined in posterResolutions and posterFormats respectively.

{
  "posterPresets": [
    {
      "name": "Preset 1 (16:9, 1920x1080, PNG)",
      "resolution": "1920x1080",
      "format": "png"
    }
  ]
}

Key	Required	Type	Description
name	Yes	string	The name of the preset to be shown in the poster application.
resolution	Yes	string	The value to pass along when publishing the poster.
format	Yes	string	The value to pass along when publishing the poster.

Session retention

The retention of a session can be configured using the retention key.

{
  "retention": "P2W"
}

Key	Default	Required	Type	Description
retention	"P2W"	No	string	Sets the retention of the created session. Specified using ISO 8601 durations format. After the duration have expired since the session was created, the session will be deleted the next time Accurate.Video gets loaded into the browser.