Skip to content

More options

Option Type Default Purpose
peerId string auto-generated Stable identifier for this peer. Generated per session if omitted.
rendition string "" Rendition label for the stream, used to scope peer matching by quality level.
regionTag string "" Optional region label for the session, used to group peers.
videoElement HTMLVideoElement | null null Video element to read buffer health from. Defaults to the first <video> in the DOM.
Option Type Default Purpose
p2pTimeoutMs number 3000 Base peer-delivery timeout before reaching for the CDN. Adapts per segment internally.
maxInFlightChunksPerPeer number 2 Max concurrent chunk requests to a single peer.
chunkRetryPeerLimit number 2 How many peers a failed chunk is retried across before falling back to the CDN.
Option Type Default Purpose
manifestPublicKey CryptoKey | JsonWebKey | string | null null Pin the verification key instead of auto-fetching it.
manifestSignatureEncoding ManifestSignatureEncoding "base64url" Encoding of the manifest signature (matches the control plane’s r||s base64url).
requireMerkleValidation boolean false Require Merkle-proof validation of chunks in addition to the segment signature.
manifestSigningUrl string "" Override the origin manifest signing endpoint. Defaults to the signaling host’s /manifest/sign.
Option Type Default Purpose
iceDirectTimeoutMs number 45000 STUN-only ICE setup timeout before abandoning direct P2P.
natDetection boolean true When false, skip client-side connectivity probing.
Option Type Default Purpose
remoteConfigUrl string "" URL to fetch remote routing config from.
remoteConfigRefreshMs number 0 Refresh interval for remote config; 0 disables periodic refresh.
Option Type Default Purpose
maxCacheBytes number 1073741824 (1 GB; capped to 200 MB on mobile) Max bytes for the in-memory segment cache used for P2P sharing.
Option Type Default Purpose
telemetryEndpoint string "" (derived from signalingUrl) Explicit telemetry ingest endpoint. Derived from the signaling URL when unset.
telemetryUrl string "" Deprecated alias for telemetryEndpoint.
Option Type Default Purpose
segmentUrlNormalizer (url: string) => string undefined Function to normalize segment URLs to a stable cache key (e.g. strip signed query params).
segmentUrlQueryParams string[] undefined Query params to preserve/consider when keying segments.