aboutsummaryrefslogtreecommitdiff
path: root/doc/api.md
diff options
context:
space:
mode:
authormetamuffin <metamuffin@disroot.org>2025-02-28 13:52:41 +0100
committermetamuffin <metamuffin@disroot.org>2025-02-28 13:52:41 +0100
commitf0dbf139d8708194d1ff7e887b1dff48ccc166fa (patch)
treec88a1ae37f404a243ded8a9548fe260d2cc26832 /doc/api.md
parent26d3a70b0be2809177076e155f987e18e2b2ceb2 (diff)
downloadjellything-f0dbf139d8708194d1ff7e887b1dff48ccc166fa.tar
jellything-f0dbf139d8708194d1ff7e887b1dff48ccc166fa.tar.bz2
jellything-f0dbf139d8708194d1ff7e887b1dff48ccc166fa.tar.zst
spec + break things
Diffstat (limited to 'doc/api.md')
-rw-r--r--doc/api.md13
1 files changed, 8 insertions, 5 deletions
diff --git a/doc/api.md b/doc/api.md
index 5713df7..b24fd46 100644
--- a/doc/api.md
+++ b/doc/api.md
@@ -111,19 +111,19 @@ federation.
by the server.
- `?whepcontrol&<token>`
- WebSocket endpoint for controlling WHEP playback. TODO schema
-- `?remux&<track...>&<webm>`
-- `?hlssupermultivariant&<webm>`
+- `?remux&<track...>&<container>`
+- `?hlssupermultivariant&<container>`
- Returns m3u8/HLS playlist of all known multi-variant playlists, one for each
segment. The plylist is updated for live media.
-- `?hlsmultivariant&<segment>&<webm>`
+- `?hlsmultivariant&<segment>&<container>`
- Returns m3u8/HLS playlist of all track formats' variant playlists.
-- `?hlsvariant&<segment>&<track>&<webm>&<format>`
+- `?hlsvariant&<segment>&<track>&<container>&<format>`
- Returns m3u8/HLS playlist of all known fragments of this track format. The
playlist is updated for live media.
- `?info&<segment?>`
- Returns JSON `SegmentInfo` if a segment index is provided, else `MediaInfo`
- `?fragmentindex&<segment>&<track>`
-- `?fragment&<segment>&<track>&<index>&<webm>&<format>`
+- `?fragment&<segment>&<track>&<index>&<container>&<format>`
```ts
interface MediaInfo {
@@ -147,10 +147,13 @@ interface TrackFormat {
bandwidth: number;
remux: bool;
title?: string;
+ containers: StreamContainer[];
a_sampling_frequency?: number;
a_channels?: number;
v_resolution_width?: number;
av_bit_depth?: number;
}
+type FragmentIndex = number[];
+type StreamContainer = "webm" | "matroska" | "webvtt" | "jvtt";
```