@vindral/web-sdk 2.1.5 → 2.2.2

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";
@@ -21,7 +22,7 @@ interface CodedVideoSample extends BaseCodedSample {
 }
 declare type CodedSample = CodedAudioSample | CodedVideoSample;
 declare type AudioCodec = "aac" | "opus" | "mp3";
-declare type VideoCodec = "h264";
+declare type VideoCodec = "h264" | "av1";
 declare type Codec = VideoCodec | AudioCodec;
 interface DecodedSampleStatistics {
 	decodeTime: number;
@@ -756,7 +757,6 @@ declare class DecoderModule {
 	private emitDecodeRate;
 	private updateBufferState;
 }
-type ConnectionType = "bluetooth" | "cellular" | "ethernet" | "mixed" | "none" | "other" | "unknown" | "wifi" | "wimax";
 type EffectiveConnectionType = "2g" | "3g" | "4g" | "slow-2g";
 interface DocumentState {
 	readonly isVisible: boolean;
@@ -800,6 +800,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>;
 }
@@ -843,29 +887,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>;
 }
@@ -1138,6 +1159,7 @@ declare const defaultOptions: {
 	poster: string | boolean;
 	reconnectHandler: (state: ReconnectState) => Promise<boolean> | boolean;
 	iosWakeLockEnabled: boolean;
+	telemetryEnabled: boolean;
 	advanced: {
 		wasmDecodingConstraint: Partial<VideoConstraint>;
 	};
@@ -1272,6 +1294,7 @@ export declare class Vindral extends Emitter<PublicVindralEvents> {
 }
 interface TelemetryModuleOptions {
 	url: string;
+	enabled?: boolean;
 	interval?: number;
 	includeErrors?: boolean;
 	includeEvents?: boolean;
@@ -1398,7 +1421,7 @@ export interface Modules {
 	subscription: SubscriptionModule;
 	renditions: RenditionsModule;
 	qualityOfService: QualityOfServiceModule;
-	metadata: MetadataModule;
+	event: EventModule;
 	sync: SyncModule;
 	telemetry?: TelemetryModule;
 	documentState: DocumentStateModule;
@@ -1430,6 +1453,7 @@ export interface Options {
 	mseOpusEnabled?: boolean;
 	iosBackgroundPlayEnabled?: boolean;
 	abrEnabled?: boolean;
+	telemetryEnabled?: boolean;
 	maxSize?: Size;
 	maxAudioBitRate?: number;
 	maxVideoBitRate?: number;
@@ -1445,6 +1469,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;
@@ -1458,6 +1488,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.5",
+  "version": "2.2.2",
   "homepage": "https://vindral.com",
   "description": "Web SDK for viewing Vindral streams",
   "license": "SEE LICENSE IN https://www.vindral.com/terms-conditions",