Skip to content
Television Simulator

IFrame

The iframe engine allows you to embed external web content directly into your Television Simulator channels. This can be useful for displaying web pages, web apps, or other online content.

Properties

Section titled “Properties”

src shorthand required

Section titled “src ”

Type: string

The URL of the web page to embed in the iframe. This should be a fully qualified URL, including the http:// or https:// protocol.

title

Section titled “title”

Type: string

Description: The title of the iframe for accessibility purposes. The default value is Embedded content.

refreshIntervalSeconds

Section titled “refreshIntervalSeconds”

Type: number

Description: Number of seconds before automatically refreshing the iframe. Set to 0 to disable automatic refreshing. The default value is 0.

allowInteraction

Section titled “allowInteraction”

Type: boolean

Description: Whether to allow user interaction with the iframe content (clicking, scrolling, etc.). The default value is false.

options

Section titled “options”

Type: object

Since: TVS 5.6.0

Description: An optional object containing key-value pairs that can be passed to the embedded application via the TVS IFrame API. See the TVS IFrame API documentation for more details on how to use this feature.