Source Docs

Source Extensions

Contract for catalog providers

Sources expose discovery lists and item metadata, then return children and mirrors for playback.

`SOURCE` object

Required core: `id`, `name`, `baseUrl`, `language`, `version`. Optional: `iconUrl`, `contentKind`.

Discovery functions

Implement `fetchPopular(page)`, `fetchLatest(page)` and `fetchSearch(query, page, filters)` when available.

Playback chain

`fetchItemDetails(id)` -> `fetchChildren(itemId)` -> `fetchVideoList(itemId, childId)`.

const SOURCE = {
  id: "my-source",
  name: "My Source",
  baseUrl: "https://example.com",
  language: "en",
  version: "1.0.0",
  iconUrl: "https://example.com/favicon.ico",
  contentKind: "personal-media"
};

async function fetchItemDetails(id) {
  return {
    id,
    title: "Family Trip 2024",
    description: "Catalog item description",
    imageUrl: "https://example.com/cover.jpg",
    genres: ["Travel"],
    status: "unknown",
    type: "video"
  };
}

async function fetchChildren(itemId) {
  return [{ id: itemId + ":clip-1", number: 1, title: "Clip 1" }];
}

async function fetchVideoList(itemId, childId) {
  return [{ url: "https://host.example/embed/abc", quality: "default" }];
}