@videojs/html 10.0.0-beta.30 → 10.0.0-beta.31

package/docs/reference/twitch-video.md

@@ -0,0 +1,447 @@
+# twitch-video
+
+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](https://dev.twitch.tv/docs/embed/video-and-clips/). Twitch’s own chrome stays hidden by default, so it drops into a [player skin](../concepts/skins.md) 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.
+
+html
+
+```
+<twitch-video src="https://www.twitch.tv/videos/106400740"></twitch-video>
+```
+
+## 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`:
+
+ts
+
+```
+const video = document.querySelector('twitch-video');
+video.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
+
+index.html
+
+index.css
+
+index.ts
+
+```
+<twitch-video
+    class="twitch-video"
+    src="https://www.twitch.tv/videos/106400740"
+    controls
+></twitch-video>
+```
+```
+.twitch-video {
+  width: 100%;
+  aspect-ratio: 16 / 9;
+}
+```
+```
+import '@videojs/html/media/twitch-video';
+```
+
+## API Reference
+
+### Attributes
+
+These attributes configure the embedded media adapter:
+
+Attribute
+
+Type
+
+Default
+
+Details
+
+`autoplay`
+
+`boolean`
+
+`—`
+
+`controls`
+
+`boolean`
+
+`—`
+
+`loop`
+
+`boolean`
+
+`—`
+
+`muted`
+
+`boolean`
+
+`—`
+
+`playsinline`
+
+`boolean`
+
+`—`
+
+`poster`
+
+`string`
+
+`—`
+
+`preload`
+
+`MediaPreloadType`
+
+`—`
+
+`src`
+
+`string`
+
+`—`
+
+### Properties
+
+Property
+
+Type
+
+Default
+
+Details
+
+`autoplay`
+
+`boolean`
+
+`—`
+
+`buffered`
+
+`TimeRangeLike`
+
+`—`
+
+▸
+
+Description
+
+Read-only.
+
+`controls`
+
+`boolean`
+
+`—`
+
+`currentSrc`
+
+`string`
+
+`—`
+
+▸
+
+Description
+
+Read-only.
+
+`currentTime`
+
+`number`
+
+`—`
+
+`defaultMuted`
+
+`boolean`
+
+`—`
+
+`duration`
+
+`number`
+
+`—`
+
+▸
+
+Description
+
+Read-only.
+
+`ended`
+
+`boolean`
+
+`—`
+
+▸
+
+Description
+
+Read-only.
+
+`engine`
+
+`Window | null`
+
+`—`
+
+▸
+
+Description
+
+Read-only. The embed's own window, which every command is posted to. Null until an embed is bound and in a document.
+
+`error`
+
+`MediaError | null`
+
+`—`
+
+▸
+
+Description
+
+Read-only.
+
+`isFullscreen`
+
+`boolean`
+
+`—`
+
+▸
+
+Description
+
+Read-only.
+
+`loop`
+
+`boolean`
+
+`—`
+
+`muted`
+
+`boolean`
+
+`—`
+
+`paused`
+
+`boolean`
+
+`—`
+
+▸
+
+Description
+
+Read-only.
+
+`playbackRate`
+
+`number`
+
+`—`
+
+`playsInline`
+
+`boolean`
+
+`—`
+
+`poster`
+
+`string`
+
+`—`
+
+`preload`
+
+`MediaPreloadType`
+
+`—`
+
+`readyState`
+
+`number`
+
+`—`
+
+▸
+
+Description
+
+Read-only.
+
+`seekable`
+
+`TimeRangeLike`
+
+`—`
+
+▸
+
+Description
+
+Read-only.
+
+`seeking`
+
+`boolean`
+
+`—`
+
+▸
+
+Description
+
+Read-only.
+
+`source`
+
+`TwitchSource | null`
+
+`—`
+
+▸
+
+Description
+
+Twitch VOD or channel URL in `src`, plus embed parameters under `engine.twitch`. Replacing it re-derives `src`.
+
+`src`
+
+`string`
+
+`—`
+
+`textTracks`
+
+`TextTrackListLike`
+
+`—`
+
+▸
+
+Description
+
+Read-only.
+
+`volume`
+
+`number`
+
+`—`
+
+### Engine options
+
+#### `source.engine.twitch`
+
+Pass [Twitch embed parameters](https://dev.twitch.tv/docs/embed/video-and-clips/) under `source.engine.twitch`, spelled exactly as Twitch spells them, plus anything Twitch adds next. [Media Sources](../concepts/media-sources.md) 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.
+
+Option
+
+Type
+
+Details
+
+`collection`
+
+`string`
+
+▸
+
+Description
+
+Collection to play through, starting from the video named by `src`.
+
+`parent`
+
+`string | readonly string[]`
+
+▸
+
+Description
+
+Every hostname the embed may be framed by. Twitch checks the frame's ancestors against it and refuses to play when the current page is missing, which is why the page's own hostname is always included on top of this.
+
+`referrerPolicy`
+
+`ReferrerPolicy`
+
+▸
+
+Description
+
+`referrerpolicy` for the embed iframe. Not a Twitch embed parameter, so it never reaches the URL: the React player applies it to the iframe it renders, and the HTML player reads its own `referrerpolicy` attribute instead.
+
+`time`
+
+`string`
+
+▸
+
+Description
+
+Start position, spelled the way Twitch spells timestamps: `1h30m10s`.
+
+### Methods
+
+Supports these media methods: `exitFullscreen``load``pause``play``requestFullscreen`
+
+### Events
+
+Implements these standard media events through the embedded player: `durationchange``emptied``ended``error``loadedmetadata``loadstart``playing``progress``seeked``seeking``timeupdate``volumechange``waiting`
+
+Also emits these Video.js-specific events:
+
+Event
+
+Description
+
+`loadcomplete`
+
+`sourcechange`
+
+Fired when \`source\` changes, either directly or by resolving a new \`src\`. Read \`source\` for the new value.