Contents

Embedding Video and Clips

Introduction

You can embed live streams, VODs, and clips in your website. Embedded video windows must be at least 400x300 pixels.

VOD is Video on Demand. There are three types of VODs:

This guide discusses three video embed techniques:

Also see the Clips Discovery API.

Non-Interactive Inline Frames for Live Streams and VODs

<iframe
    src="https://player.twitch.tv/?<channel, video, or collection>"
    height="<height>"
    width="<width>"
    frameborder="<frameborder>"
    scrolling="<scrolling>"
    allowfullscreen="<allowfullscreen>">
</iframe>

Iframe Attributes

These attributes are defined in https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe. The Twitch player exists in the iframe with no ability to set the attributes on the iframe.

NameTypeDescription
allowfullscreenbooleanIf true, the player can go full screen.
heightintegerHeight of the embedded window, in pixels. Recommended minimum: 300
scrollingbooleanIndicates when the browser should provide a scroll bar (or other scrolling device) for the frame. Recommended: no.
srcstringThe iframe src URL string should be https://player.twitch.tv/ with one of these required query string parameters:
  • channel – (string) Name of the channel, for a live stream.
  • video – (string) Video ID (for past broadcasts, highlights, and video uploads). In this context (the video player), the video ID must have a “v” prefix.
  • collection - (string) Collection ID, for a collection of videos.
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.

If channel is specified along with video and/or collection, only channel is used.
widthintegerWidth of the embedded window, in pixels. Recommended minimum: 400

Optional Query String Parameters on Iframe src

Name Type Description
autoplay boolean 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.
muted boolean Specifies whether the initial state of the video is muted. Default: false.
time 1h2m3s Time in the video where playback starts. Specifies hours, minutes, and seconds. Default: 0h0m0s (the start of the video).

Video Metadata

Information on video channels, lengths, descriptions, and viewcounts is available through the Videos endpoints.

Examples

Using a channel name:

<iframe
    src="https://player.twitch.tv/?channel=dallas&muted=true"
    height="720"
    width="1280"
    frameborder="0"
    scrolling="no"
    allowfullscreen="true">
</iframe>

Using a video ID:

<iframe
    src="https://player.twitch.tv/?video=v40464143&autoplay=false"
    height="720"
    width="1280"
    frameborder="0"
    scrolling="no"
    allowfullscreen="true">
</iframe>

Using a collection ID:

<iframe
    src="https://player.twitch.tv/?collection=abcDeF1ghIJ2kL"
    height="720"
    width="1280"
    frameborder="0"
    scrolling="no"
    allowfullscreen="true">
</iframe>

Interactive Frames for Live Streams and VODs

<script src= "https://player.twitch.tv/js/embed/v1.js"></script>
<div id="<player div ID>"></div>
<script type="text/javascript">
  var options = {
    width: <width>,
    height: <height>,
    channel: "<channel ID>",
    video: "<video ID>",
    collection: "<collection ID>",
  };
  var player = new Twitch.Player("<player div ID>", options);
  player.setVolume(0.5);
</script>

Required Parameters

Name Type Description
channel
– OR –
video
– OR –
collection
string Channel name (for a live stream), video ID, or collection ID. (To change the channel or video later, use setChannel, setVideo, or setCollection; see Synchronous Playback Controls.)

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.

If channel is specified along with video and/or collection, only channel is used.
height integer Height of the embedded window, in pixels. Recommended minimum: 300.
player div ID string Any value you like, as long as it is the same in both locations within the example.
width integer Width of the embedded window, in pixels. Recommended minimum: 400.

Optional Parameter

Name Type Description
playsinline boolean If true, the embedded player plays inline for mobile iOS apps. Default: true.

Synchronous Playback Controls

Call Description
pause():void Pauses the player.
play():void Begins playing the specified video.
seek(timestamp:Float):void Seeks to the specified timestamp (in seconds) in the video and resumes playing if paused. Does not work for live streams.
setChannel(channel:String):void Sets the channel to be played.
setCollection(collection ID:String, video ID:String):void Sets the collection to be played.

Optionally also specifies the video within the collection, from which to start playback. If a video ID is not provided here or the specified video is not part of the collection, playback starts with the first video in the collection.
setQuality(quality:String):void Sets the quality of the video. quality should be a string value returned by getQualities.
setVideo(video ID:String, timestamp:Number):void Sets the video to be played to be played and starts playback at timestamp (in seconds).

Synchronous Volume Controls

Call Description
getMuted():Boolean Returns true if the player is muted; otherwise, false.
setMuted(muted:Boolean):void If true, mutes the player; otherwise, unmutes it. This is independent of the volume setting.
getVolume():Float Returns the volume level, a value between 0.0 and 1.0.
setVolume(volumelevel:Float):void Sets the volume to the specified volume level, a value between 0.0 and 1.0.

Synchronous Player Status

Call Description
getChannel():String Returns the channel’s name. Works only for live streams, not VODs.
getCurrentTime():Float Returns the current video’s timestamp, in seconds. Works only for VODs, not live streams.
getDuration():Float Returns the duration of the video, in seconds. Works only for VODs,not live streams.
getEnded():Boolean Returns true if the live stream or VOD has ended; otherwise, false.
getPlaybackStats():Object (Deprecated) Returns an object with statistics on the embedded video player and the current live stream or VOD. The format of the returned object is undefined.
getQualities():String[] Returns the available video qualities. For example, chunked (pass-through of the original source).
getQuality():String Returns the current quality of video playback.
getVideo():String Returns the video ID. Works only for VODs, not live streams.
isPaused():Boolean Returns true if the video is paused; otherwise, false. Buffering or seeking is considered playing.

Events Emitted by and Defined by the Player

To listen to events, call addEventListener(event:String, callback:Function).

Event Emitted when …
Twitch.Player.ENDED Video or stream ends.
Twitch.Player.PAUSE Player is paused. Buffering and seeking is not considered paused.
Twitch.Player.PLAY Player just unpaused, will either start video playback or start buffering.
Twitch.Player.PLAYBACK_BLOCKED Player playback was blocked. Usually fired after an unmuted autoplay or unmuted programmatic call on play().
Twitch.Player.PLAYING Player started video playback.
Twitch.Player.OFFLINE Loaded channel goes offline.
Twitch.Player.ONLINE Loaded channel goes online.
Twitch.Player.READY Player is ready to accept function calls.

Example

<script src= "https://player.twitch.tv/js/embed/v1.js"></script>
<div id="SamplePlayerDivID"></div>
<script type="text/javascript">
  var options = {
    width: 854,
    height: 480,
    channel: "dallas",
  };
  var player = new Twitch.Player("SamplePlayerDivID", options);
  player.setVolume(0.5);
</script>

Non-Interactive Frames for Clips

Embedding a clip is different than embedding a live stream or VOD. The embedded clips player uses a different set of query parameters and does not support the JavaScript interactive embed.

<iframe
    src="https://clips.twitch.tv/embed?clip=<slug>"
    height="<height>"
    width="<width>"
    frameborder="<frameborder>"
    scrolling="<scrolling>"
    allowfullscreen="<allow full screen>">
</iframe>

Iframe Attributes

NameTypeDescription
allowfullscreenbooleanIf true, the player can go full screen.
clipstringA globally unique string called a slug, by which clips are referenced.
heightintegerHeight of the embedded window, in pixels. Recommended minimum: 300.
preloadenumA hint to the browser about what the developer thinks will lead to the best user experience. Valid values:
  • none - The video should not be preloaded.
  • metadata - Only video metadata (e.g., length) is fetched. This is the recommended value.
  • auto - The whole video file could be downloaded, even if the user is not expected to use it.
  • "" (empty string) - Same as auto.
Default: browser-defined.

The HTML specification does not force the browser to follow the value of this attribute; it is merely a hint.
scrollingbooleanIndicates when the browser should provide a scroll bar (or other scrolling device) for the frame. Recommended: no.
widthintegerWidth of the embedded window, in pixels. Recommended minimum: 400.

Optional Query String Parameters

Name Type Description
autoplay boolean 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.
muted boolean Specifies whether the initial state of the video is muted. Default: false.

Example

<iframe
   src="https://clips.twitch.tv/embed?clip=IncredulousAbstemiousFennelImGlitch"
   height="360"
   width="640"
   frameborder="0"
   scrolling="no"
   allowfullscreen="true">
</iframe>