Skip to content

Commit d50f45e

Browse files
authored
Merge pull request #5 from TypeType-Video/dev
docs: document TypeType 1.1 playback features
2 parents 4a34d74 + fe3e857 commit d50f45e

4 files changed

Lines changed: 92 additions & 2 deletions

File tree

‎docs/.vitepress/config.mts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ export default withMermaid({
2525
text: "Version",
2626
items: [
2727
{ text: "latest", link: "/" },
28-
{ text: "1.0", link: "/" },
28+
{ text: "1.1", link: "/" },
2929
],
3030
},
3131
{
@@ -81,6 +81,7 @@ export default withMermaid({
8181
items: [
8282
{ text: "Overview", link: "/guide/" },
8383
{ text: "Watching & the player", link: "/guide/watching" },
84+
{ text: "Embedded player", link: "/guide/embedding" },
8485
{ text: "Your library", link: "/guide/library" },
8586
{ text: "Finding content", link: "/guide/finding-content" },
8687
{ text: "Signing in", link: "/guide/accounts" },

‎docs/guide/embedding.md‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Embedded player
2+
3+
TypeType provides a dedicated player route for embedding YouTube videos without the
4+
rest of the watch page.
5+
6+
## URL format
7+
8+
Use the YouTube video identifier after `/embed/`:
9+
10+
```text
11+
https://your-instance.example/embed/VIDEO_ID
12+
```
13+
14+
The identifier is the 11-character value after `v=` in a regular YouTube watch URL.
15+
For example, `https://www.youtube.com/watch?v=dQw4w9WgXcQ` becomes
16+
`/embed/dQw4w9WgXcQ`.
17+
18+
## Start position and autoplay
19+
20+
| Parameter | Value | Behavior |
21+
| --- | --- | --- |
22+
| `t` | Seconds or a duration | Start position |
23+
| `start` | Seconds or a duration | Alias for `t` |
24+
| `time_continue` | Seconds or a duration | Invidious-compatible alias for `t` |
25+
| `autoplay` | `1` | Request autoplay |
26+
27+
Durations can combine hours, minutes, and seconds, such as `1h30m15s`. When several
28+
start parameters are present, TypeType uses `t`, then `start`, then `time_continue`.
29+
Invalid or negative values start from the beginning.
30+
31+
```text
32+
/embed/dQw4w9WgXcQ?t=90
33+
/embed/dQw4w9WgXcQ?start=1m30s
34+
/embed/dQw4w9WgXcQ?time_continue=45&autoplay=1
35+
```
36+
37+
Autoplay remains subject to the browser's media policy. A browser can require a user
38+
gesture before starting audio.
39+
40+
## Add an iframe
41+
42+
```html
43+
<iframe
44+
src="https://your-instance.example/embed/dQw4w9WgXcQ?autoplay=1"
45+
title="TypeType video player"
46+
allow="autoplay; fullscreen; picture-in-picture"
47+
allowfullscreen
48+
loading="lazy"
49+
></iframe>
50+
```
51+
52+
Give the iframe an explicit responsive size in the surrounding page. For example:
53+
54+
```css
55+
.video-embed {
56+
width: 100%;
57+
aspect-ratio: 16 / 9;
58+
border: 0;
59+
}
60+
```
61+
62+
Add `class="video-embed"` to the iframe when using this example.
63+
64+
## Accounts, settings, and guest access
65+
66+
Opening an embed URL directly in a browser tab can reuse the current TypeType account
67+
and player settings. Inside an iframe, playback is anonymous and does not read the
68+
embedding site's TypeType session or settings.
69+
70+
The instance must therefore allow guest access for iframe playback. An administrator
71+
can enable **Allow guest mode** from the TypeType administration settings. When guest
72+
access is disabled, the embed shows a dedicated message with a link to the normal
73+
watch page instead of attempting playback.
74+
75+
The embed also shows the same unavailable, scheduled, and members-only states as the
76+
watch page. Temporary loading failures provide a retry action when retrying is safe.

‎docs/guide/library.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@ You can clear it whenever you want, see [Privacy & blocking](./privacy#your-data
3636
## Watch later
3737

3838
Send a video to **Watch later** to come back to it, a simple queue separate from your
39-
playlists.
39+
playlists. Open a video's actions menu and select **Save to Watch later** to add it
40+
immediately; select **Remove from Watch later** from the same menu to remove it.
4041

4142
## Favorites
4243

‎docs/guide/watching.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,18 @@ On a touch screen:
7070
When enabled, the next video starts automatically when the current one ends. Toggle it
7171
in [Settings](./settings#playback).
7272

73+
## Livestreams
74+
75+
YouTube livestreams use TypeType's native SABR player. The player follows the live
76+
edge automatically, keeps buffering ahead during short network interruptions, and
77+
allows seeking within the DVR window when the stream provides one.
78+
79+
## Embedded player
80+
81+
TypeType provides a dedicated route for embedding YouTube videos. See
82+
[Embedded player](./embedding) for the URL format, parameters, iframe markup, and guest
83+
access requirements.
84+
7385
## Shorts
7486

7587
Shorts play in a dedicated vertical, swipeable player. You can turn the Shorts surface

0 commit comments

Comments
 (0)