@vindral/web-sdk 2.1.3 → 2.2.0

package/index.d.ts

@@ -14,6 +14,7 @@ interface CodedAudioSample extends BaseCodedSample {
 	codec: AudioCodec;
 	channels: number;
 	sampleRate: number;
+	language?: string;
 }
 interface CodedVideoSample extends BaseCodedSample {
 	type: "video";
@@ -443,6 +444,7 @@ declare class BufferTimeModule {
 }
 interface VindralErrorProps {
 	isFatal: boolean;
+	type?: ErrorType;
 	code: string;
 	source?: Error | MediaError;
 }
@@ -456,6 +458,8 @@ export declare const INACTIVITY_CODE = "connection_inactivity";
 export declare const MISSING_INIT_SEGMENT = "missing_init_segment";
 export declare const NO_TRACK_CONTEXT = "no_track_context";
 export declare const DISCONNECTED_BY_EDGE = "disconnected_by_edge";
+export declare const DECODER_ERROR = "decoder_error";
+export declare type ErrorType = "internal" | "external";
 export declare class VindralError extends Error {
 	private props;
 	private extra;
@@ -463,17 +467,19 @@ export declare class VindralError extends Error {
 	code: () => string;
 	isFatal: () => boolean;
 	source: () => Error | MediaError | undefined;
+	type: () => ErrorType;
 	toStringifiable: () => Record<string, unknown>;
 }
 export declare const mediaElementError: (isFatal: boolean, source: MediaError) => VindralError;
+export declare const decoderError: (isFatal: boolean, source: Error) => VindralError;
 export declare const missingInitSegmentError: (renditionId: number, channelId: string) => VindralError;
 export declare const noTrackContextError: (type: "audio" | "video", renditionId: number, channelId: string) => VindralError;
 export declare const audioContextTimeoutError: () => VindralError;
 export declare const disconnectedFromEdgeServerError: (source?: VindralError | undefined) => VindralError;
 export declare const authenticationError: (source?: Error | undefined) => VindralError;
 export declare const authenticationExpiredError: (source?: Error | undefined) => VindralError;
-export declare const inactivityError: (source?: Error | undefined) => VindralError;
-export declare const channelNotFoundError: (source?: Error | undefined) => VindralError;
+export declare const inactivityError: (type: ErrorType, source?: Error | undefined) => VindralError;
+export declare const channelNotFoundError: (type: ErrorType, source?: Error | undefined) => VindralError;
 export declare const noIncomingDataError: (source?: Error | undefined) => VindralError;
 export declare const unableToConnectError: (source?: Error | undefined) => VindralError;
 export declare const unableToConnectAfterRetriesError: () => VindralError;
@@ -698,11 +704,13 @@ interface DecoderContext<Type extends "audio" | "video"> {
 	initSegment(initSegment: Readonly<InitSegment>): void;
 	enqueue(sample: Readonly<DecoderParamType<Type>>): void;
 	take(): DecoderReturnType<Type> | undefined;
+	error?: () => Error | undefined;
 }
 interface DecoderModuleEvents {
 	["video decode rate"]: number;
 	["decoded frame"]: Readonly<DecodedSample>;
 	["buffer state"]: Readonly<BufferState>;
+	["error"]: Readonly<VindralError>;
 }
 interface DecoderModuleListeners {
 	["init segment"]: Readonly<InitSegment>;
@@ -793,6 +801,50 @@ declare class DocumentStateModule implements DocumentState {
 	private onVisibilityChanged;
 	private setIsActive;
 }
+interface EventModuleEvents {
+	["event"]: Readonly<StoredEvent>;
+}
+interface TimeSource {
+	readonly drift: number | undefined;
+	readonly serverCurrentTime: number;
+}
+interface BaseEvent {
+	timestamp: number;
+}
+declare type TimestampAdded = {
+	timestampAdded: number;
+};
+interface Metadata extends BaseEvent {
+	type: "metadata";
+	content: string;
+}
+interface ChannelSwitch extends BaseEvent {
+	type: "channel switch";
+	channelId: string;
+}
+interface LanguageSwitch extends BaseEvent {
+	type: "language switch";
+	language: string;
+}
+declare type Event = Metadata | ChannelSwitch | LanguageSwitch;
+declare type StoredEvent = TimestampAdded & Event;
+declare class EventModule {
+	private static EVENT_TIMEOUT;
+	private static EVENT_CHECK_INTERVAL;
+	private logger;
+	private emitter;
+	private waitingEvents;
+	private isTriggered;
+	private timeSource;
+	private timers;
+	constructor(emitter: Emitter<unknown, EventModuleEvents>, logger: Logger, timeSource: TimeSource);
+	load: () => void;
+	unload: () => void;
+	static create: (emitter: Emitter<unknown, EventModuleEvents>, logger: Logger, timeSource: TimeSource) => EventModule;
+	addEvent: (event: Event) => void;
+	extractEvent: (previousSample: CodedSample, sample: CodedSample) => void;
+	private onBufferedStateChanged;
+}
 interface IncomingDataModuleListeners {
 	["connection state"]: Readonly<State>;
 }
@@ -836,29 +888,6 @@ declare class LoggerModule {
 	unload: () => void;
 	private onLog;
 }
-interface MetadataModuleEvents {
-	["metadata"]: Readonly<Metadata>;
-}
-interface TimeSource {
-	readonly drift: number | undefined;
-	readonly serverCurrentTime: number;
-}
-declare class MetadataModule {
-	private static METADATA_TIMEOUT;
-	private static METADATA_CHECK_INTERVAL;
-	private logger;
-	private emitter;
-	private waitingMetadata;
-	private isTriggered;
-	private timeSource;
-	private timers;
-	constructor(emitter: Emitter<unknown, MetadataModuleEvents>, logger: Logger, timeSource: TimeSource);
-	load: () => void;
-	unload: () => void;
-	static create: (emitter: Emitter<unknown, MetadataModuleEvents>, logger: Logger, timeSource: TimeSource) => MetadataModule;
-	addMetadata: (metadata: Metadata) => void;
-	private onBufferedStateChanged;
-}
 interface MseModuleEvents {
 	["error"]: Readonly<VindralError>;
 }
@@ -1391,7 +1420,7 @@ export interface Modules {
 	subscription: SubscriptionModule;
 	renditions: RenditionsModule;
 	qualityOfService: QualityOfServiceModule;
-	metadata: MetadataModule;
+	event: EventModule;
 	sync: SyncModule;
 	telemetry?: TelemetryModule;
 	documentState: DocumentStateModule;
@@ -1421,6 +1450,7 @@ export interface Options {
 	burstEnabled?: boolean;
 	mseEnabled?: boolean;
 	mseOpusEnabled?: boolean;
+	iosBackgroundPlayEnabled?: boolean;
 	abrEnabled?: boolean;
 	maxSize?: Size;
 	maxAudioBitRate?: number;
@@ -1437,6 +1467,12 @@ export interface Options {
 	advanced?: AdvancedOptions;
 	media?: Media;
 }
+export interface LanguageSwitchContext {
+	language: string;
+}
+export interface ChannelSwitchContext {
+	channelId: string;
+}
 export interface PublicVindralEvents {
 	["error"]: Readonly<VindralError>;
 	["needs user input"]: NeedsUserInputContext;
@@ -1450,6 +1486,8 @@ export interface PublicVindralEvents {
 	["context switch"]: Readonly<ContextSwitchState>;
 	["server wallclock time"]: Readonly<number>;
 	["is live"]: boolean;
+	["channel switch"]: Readonly<ChannelSwitchContext>;
+	["language switch"]: Readonly<LanguageSwitchContext>;
 	["buffer state event"]: Readonly<BufferStateEvent>;
 	["initialized media"]: void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vindral/web-sdk",
-  "version": "2.1.3",
+  "version": "2.2.0",
   "homepage": "https://vindral.com",
   "description": "Web SDK for viewing Vindral streams",
   "license": "SEE LICENSE IN https://www.vindral.com/terms-conditions",