Skip to content
Television Simulator

Startup Options

The optional startup section in the configuration file allows you to define the way the TV behaves when the page loads or when the TV is powered on via the remote.

Example

Section titled “Example”
startup:
  powerOnChannel: 1
  content:
    video: placeholders/hypercom-boot.mp4
  duration: 3
  displayOnPageLoad: true
  displayOnPowerOn: true

Properties

Section titled “Properties”

powerOnChannel

Section titled “powerOnChannel”

Type: number

Channel to tune to after startup playback ends when the TV is powered on. If not set, the TV will resume the last channel that was tuned to before the TV was powered off.

content required

Section titled “content ”

Content to display during startup. This accepts a content engine object (for example video, image, color, iframe, and more).

duration

Section titled “duration”

Type: number

How long to show startup content in seconds before switching to channels.

If the selected content engine supports end detection, this can be omitted. If the engine does not support end detection, duration is required or TVS will throw a Startup Duration Not Set error.

Set duration: 0 to keep startup content on screen indefinitely until the user changes channel or powers off.

displayOnPageLoad

Section titled “displayOnPageLoad”

Type: boolean

Default: true

Whether startup content should display when the page first loads.

displayOnPowerOn

Section titled “displayOnPowerOn”

Type: boolean

Default: true

Whether startup content should display when the TV is powered on from standby.