Content Engine Primer

Tip

Read this first to understand how to use the reference documentation effectively!

Examples

Each content engine has its own page, and they are structured similarly. We begin with a brief summary and a screenshot followed by YAML code that shows how to use the engine in a channel.

For instance, you might see something like this:

image: /content/images/my-image.jpg

To use it, put it in a channel:

channels:

- number: 123
  name: My channel
  abbr: EXAMPLE
  image: /content/image/my-image.jpg # <-- the content engine goes here

Or in a layout:

channels:

- number: 123
  name: My channel
  abbr: EXAMPLE
  loop:
  - image: /content/images/my-image.jpg # <-- here
    duration: 10
  - image: /content/images/my-image-2.jpg
    duration: 5

Or even in a reference:

refs:
  ad1:
    image: /content/images/my-image.jpg # <-- here

channels:

- number: 123
  name: My channel
  abbr: EXAMPLE
  ref: ad1

Properties

After the examples you’ll get an exhaustive list of unique properties for each content engine. These properties can be used to customize the behavior and appearance of the engine in your channels and layouts.

Common Properties

Properties that can apply to any engine won’t be displayed on every page but instead are available below:

interruptsBackgroundAudio

Type:: true | false

Whether the component takes precedence over the channel’s background audio and mutes it while being displayed.

Shorthand Properties

shorthand properties are marked in blue and are properties that can be set using shorthand syntax; instead of saying:

image:
  src: /content/images/my-image.jpg

you can simply write:

image: /content/images/my-image.jpg

You can’t provide any other options with this shorthand syntax, but it is useful for simple cases such as when you just want to display an image or a video without any additional configuration.

Default Values

If there are multiple options for an optional property the default value will be labeled like this. Other available values will be in gray.