Skip to main content

Client & Auth

AuthClient​

Pluggable interface for the platform's authentication flow. An implementation supplies fresh tokens, parses tokens from manifests, and attaches the appropriate headers to outbound requests.

interface AuthClient {
abilities: Set<refresh>;
}

VideoClientAPI​

Entry point for the @video/video-client-core SDK. A single instance manages the platform's options, capability checks, call creation, and player construction.

interface VideoClientAPI {
}

VideoClientConstructor​

Constructor signature for VideoClientAPI. Implementations accept the platform's options shape and return a ready-to-use client.

interface VideoClientConstructor {
}

AuthClientOptions​

Options carried with every authentication operation.

type AuthClientOptions = {
context?: AuthContext;
forceRefresh?: boolean;
hint?: string | literal;
scopes?: string[];
}

AuthContext​

Identifier for the surface a token is being applied to. The implementation uses this to pick the right header or query-string convention.

type AuthContext = call-join-websocket | call-join-param | call-join-headers | manifest | manifest-headers | hlsjs-headers | native-hls-headers | mp4-http-headers | flvhttp-headers
unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown

TokenGetter​

Token input accepted by call APIs — either a literal string or a refresher callback. Inferred from TokenGetterSchema.

type TokenGetter = TypeOf<query>
TypeOf

TokenRefresher​

Async callback that returns a fresh authorisation token. Inferred from TokenRefresherSchema.

type TokenRefresher = TypeOf<query>
TypeOf

VideoClientOptions​

Input shape accepted by videoClientOptionsSchema before parsing. Used by every public API that accepts video-client options.

type VideoClientOptions = input<query>
input