Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TwitchPlayerOptions

Interface that holds all the TwitchPlayer initialization options.

Hierarchy

  • TwitchPlayerOptions

Index

Properties

Optional Readonly autoplay

autoplay: undefined | false | true

If true, the video starts playing automatically, without the user clicking play. The exception is mobile devices, on which video cannot be played without user interaction. Default: true.

Optional Readonly channel

channel: undefined | string

Channel name, for a live stream. If channel is specified along with video and/or collection, only channel is used.

Optional Readonly collection

collection: undefined | string

Collection ID for a specified collection. If both video and collection are specified, the specified collection starts playing from the specified video. If the video is not in the collection, collection is ignored and the specified video is played.

Readonly height

height: number | string

Height of the embedded window, in pixels. Can be expressed as a percentage, by passing a string like 100%. Recommended minimum: 300.

Optional Readonly muted

muted: undefined | false | true

Specifies whether the initial state of the video is muted. Default: false.

Optional Readonly parent

parent: string[]

Only required if your site is embedded on any domain(s) other than the one that instantiates the Twitch embed. Example parent parameter: ["streamernews.example.com", "embed.example.com"]

Optional Readonly time

time: undefined | string

Only valid for Video on Demand content. Time in the video where playback starts. Specifies hours, minutes, and seconds. Default: 0h0m0s (the start of the video).

Optional Readonly video

video: undefined | string

Video ID for a specified video.

Readonly width

width: number | string

Width of the embedded window, in pixels. Can be expressed as a percentage, by passing a string like 50%. Recommended minimum: 400.

Generated using TypeDoc