Manifests & Streaming Formats
Encoding
Encoding descriptor inferred from Encoding.
type Encoding = TypeOf<query>FormatFlvHttp
FLV-over-HTTP format descriptor inferred from FormatFlvHttp.
type FormatFlvHttp = TypeOf<query>FormatJpeg
JPEG format descriptor inferred from FormatJpeg.
type FormatJpeg = TypeOf<query>FormatMp4Hls
MP4-over-HLS format descriptor inferred from FormatMp4Hls.
type FormatMp4Hls = TypeOf<query>FormatMp4Http
MP4-over-HTTP format descriptor inferred from FormatMp4Http.
type FormatMp4Http = TypeOf<query>FormatMp4Rtmp
MP4-over-RTMP format descriptor inferred from FormatMp4Rtmp.
type FormatMp4Rtmp = TypeOf<query>FormatState
Format-state value inferred from FormatState.
type FormatState = TypeOf<query>FormatWebp
WebP format descriptor inferred from FormatWebp.
type FormatWebp = TypeOf<query>FormatWebRtc
WebRTC format descriptor inferred from FormatWebRtc.
type FormatWebRtc = TypeOf<query>Manifest
Manifest value inferred from Manifest.
type Manifest = TypeOf<query>ManifestFormats
Manifest-formats descriptor inferred from ManifestFormats.
type ManifestFormats = TypeOf<query>ManifestJson
Parsed manifest document inferred from ManifestJson.
type ManifestJson = TypeOf<query>ManifestUri
Manifest URI inferred from ManifestUri.
type ManifestUri = TypeOf<query>State
Publish-state value inferred from State.
type State = TypeOf<query>Encoding
Zod schema describing a single encoded media variant — its location, codec identifiers, dimensions, bitrate, and channel layout. Used as a building block for the per-format schemas below.
const Encoding: ZodObject<object, strip, ZodTypeAny, object, object>FormatFlvHttp
Zod schema for the FLV-over-HTTP format entry in a manifest.
const FormatFlvHttp: ZodObject<object, strip, ZodTypeAny, object, object>FormatJpeg
Zod schema for the JPEG poster/thumbnail format entry in a manifest.
const FormatJpeg: ZodObject<object, strip, ZodTypeAny, object, object>FormatMp4Hls
Zod schema for the MP4-over-HLS format entry in a manifest, including the
optional livedvr window used for live DVR playback.
const FormatMp4Hls: ZodObject<object, strip, ZodTypeAny, object, object>FormatMp4Http
Zod schema for the MP4-over-HTTP format entry, including preview and preview-images metadata used for VOD scrubbing UI.
const FormatMp4Http: ZodObject<object, strip, ZodTypeAny, object, object>FormatMp4Rtmp
Zod schema for the MP4-over-RTMP format entry in a manifest.
const FormatMp4Rtmp: ZodObject<object, strip, ZodTypeAny, object, object>FormatState
Zod schema for the runtime state of a single format — its current encodings, the driver that owns it, and its publish state.
const FormatState: ZodObject<object, strip, ZodTypeAny, object, object>FormatWebp
Zod schema for the WebP poster/thumbnail format entry in a manifest.
const FormatWebp: ZodObject<object, strip, ZodTypeAny, object, object>FormatWebRtc
Zod schema for the WebRTC format entry in a manifest. Wraps a FormatWebRtcOrigin.
const FormatWebRtc: ZodObject<object, strip, ZodTypeAny, object, object>Manifest
Zod schema for either form of manifest the player accepts — a URI string or a fully-parsed ManifestJson.
const Manifest: ZodUnion<tuple>ManifestFormats
Zod schema for the union of all format entries available within a manifest. Each key corresponds to a delivery method; the value, when present, is the format-specific descriptor.
const ManifestFormats: ZodObject<object, strip, ZodTypeAny, object, object>ManifestJson
Zod schema for a parsed manifest document — self-URL, ping endpoint, content
type (live/vod/recorded), available formats, and VOD-specific
thumbnail and spritesheet metadata.
const ManifestJson: ZodObject<object, strip, ZodTypeAny, object, object>ManifestUri
Zod schema for a manifest URI string. Used when the manifest is referenced by URL rather than supplied inline as JSON.
const ManifestUri: ZodStringState
Zod schema for the publish-state of a single format within a manifest —
online, offline, or forbidden.
const State: ZodEnum<tuple>