Encoding Templates for Live Standby Pools

Creating and Testing a valid Encoding Template

The Live Standby Pools require an Encoding Template to be assigned to them as the basis for all Live Encodings that they will create.

Creating the Template

In Live Encoding -> Encoding Templates, we have some examples to get started, or they can be created from scratch.

Either by using a template to get started or creating from scratch, you can use your own text editor program or the Editor in the Dashboard.

As this Encoding Template will be used to create multiple Live Encodings placeholder names with regular expressions for certain settings are required to ensure certain values are unique, such as:

  • Authentication for inputs such as RTMP Input streamkeys = for now give this a real value such as abc123 shown above.
  • Encoding name = "{poolName}_%number%" # will be replaced pool name
  • Encoding labels = "standby-pool-id:{poolId}" # will be replaced with poolId
  • Segment names = "seg%number%" or "seg%number%_{segment_rand_chars:10}.ts" # will add a number with or without random characters to the suffice of the segment file name.

Once you're happy with the Encoding Template, give it a temporary name for now, for example add TESTING as a suffix. Save It.

It will then be visible in the Custom template tab, where all customers can store up to 24 templates at a time.

❗️

Templates are imutable

Once saved, a template can not be edited. If changes are required then another copy needs to be made, saved and run.

Testing the template

Open the template in the editor and press Run the Encoding

Once running, you'll notice that certain names for pools appear in the formula - such as the Encoding Name.
This is expected when they are Run "manually".

Providing that the Live Encoding starts correctly, connect to the ingest point and confirm video and audio playback is as expected either using the Player in our Dashboard or your own via your CDN endpoint.

If you are happy, go back to Encoding Templates and edit the file, changing any input authentication to one compatible with a pool.

  • Authentication for inputs such as RTMP Input streamkey = "{uuid}"# will be replaced with a UUID

You can now delete the previous template used for testing. Your production ready template is now ready to use with a new Live Standby Pool.