Skip to content
FrameworkStyle

TwitchVideo

Video component that plays Twitch videos and live channels through the Twitch embed player

Video component that plays Twitch videos and live channels through the Twitch embed player. Twitch’s own chrome stays hidden by default, so it drops into a player skin like any other media component; set controls to use Twitch’s UI instead.

Load a source

src takes a video URL (twitch.tv/videos/<id>) or a channel URL (twitch.tv/<channel>), with or without the www. and go. hosts. A channel URL plays the channel’s live stream. Clips (clips.twitch.tv) are a different embed and aren’t supported.

<TwitchVideo src="https://www.twitch.tv/videos/106400740" />

Live channels

A channel embed behaves like a live media component:

  • duration reports Infinity while the stream is live.
  • Seeking is unavailable: the embed exposes no DVR window.
  • The stream going away and coming back dispatch offline and online events.
  • loop never repeats a channel; a live stream doesn’t end.

Parent hostnames

Twitch checks the embedding page’s ancestors against a parent allowlist and won’t play unless the current page is on it. The element always includes your page’s own hostname, so a plain embed needs no setup. When your player is itself framed by other hostnames, name each of them under engine.twitch.parent:

<TwitchVideo
  source={{
    src: 'https://www.twitch.tv/videos/106400740',
    engine: { twitch: { parent: ['embed.example.com'] } },
  }}
/>

Behavior

  • Volume and mute both work, like a native <video>.
  • playbackRate is reported but never applied: the embed has no rate command.
  • loop restarts a finished video from the top; the embed has no loop parameter.
  • controls is read when the embed is built; changing it later doesn’t take effect, since rebuilding the iframe would lose the playback session.
  • Fullscreen targets the iframe, so Twitch’s own chrome shows in fullscreen.

Examples

Basic Usage

import { TwitchVideo } from '@videojs/react/media/twitch-video';

export default function BasicUsage() {
  return (
    <div className="twitch-video">
      <TwitchVideo src="https://www.twitch.tv/videos/106400740" controls />
    </div>
  );
}

API Reference

Props

Accepts these Video.js-specific props:

PropTypeDefaultDetails
autoplaybooleanfalse
controlsbooleanfalse
defaultMutedbooleanfalse
loopbooleanfalse
mutedbooleanfalse
playsInlinebooleantrue
posterstring''
preloadMediaPreloadType'metadata'
sourceTwitchSource | nullnull
srcstring''

Engine options

source.engine.twitch

Pass Twitch embed parameters under source.engine.twitch, spelled exactly as Twitch spells them, plus anything Twitch adds next. Media Sources covers how engine options fit into a structured source.

controls, autoplay, and muted come from the props of the same name, and the video or channel comes from src, so none of those have an engine.twitch spelling.

OptionTypeDetails
collectionstring
parentstring | readonly string[]
referrerPolicyReferrerPolicy
timestring

Ref

Forwards its ref to the rendered <iframe>. The ref is an HTMLIFrameElement. Control playback with the component props and player APIs rather than the iframe ref.