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.

deepIntegration

Section titled “deepIntegration”

Type: object

Since: TVS 6.2.0

Description: Grants the embedded application access to selected TVS IFrame APIs. Access is disabled unless it is explicitly enabled. TVS sends these values in the capabilities property of the TVS.Options handshake message.

channelInfo sub-property

Section titled “channelInfo ”

Type: "current-channel" | "all-channels" | false

Default: false

Description: Controls which channel and guide APIs the application may use.

  • "current-channel" sends TVS.CurrentChannel messages and allows the application to request listings or upcoming programs for the channel in which the IFrame is embedded.
  • "all-channels" also allows the application to request listings for a range of channels or upcoming programs for a specific channel.
  • false does not expose channel or guide information.

canRequestTermination sub-property

Section titled “canRequestTermination ”

Type: boolean

Default: false

Description: Allows the embedded application to request the end of its scheduled content using TVS.RequestTermination. The request only takes effect when the IFrame is running in a context that can advance or dismiss content, such as a loop or startup effect.

iframe:
  src: "https://guide.example.com"
  deepIntegration:
    channelInfo: "all-channels"
    canRequestTermination: true

See the TVS IFrame API documentation for message formats and examples.

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.