@vindral/web-sdk 2.0.6 → 2.0.7

package/README.md

@@ -115,7 +115,7 @@ instance.on("playback state", (state) => (playbackState.textContent = state))
 // This event is emitted when timed metadata events occur
 instance.on("metadata", (metadata) => console.log("metadata: ", metadata.content))
 
-// This event is emitted when the vindral detects that the browser requires a user initiated click event to start audio
+// This event is emitted when the vindral detects that the browser requires a user initiated click event to start media playback
 instance.on("needs user input", () => (button.style.display = "block"))
 
 // Starts connecting to the channel

package/index.d.ts

@@ -267,11 +267,15 @@ declare class AdaptivityModule {
 	private tooMuchTimeBuffering;
 	private tooManyBufferingEvents;
 }
+interface NeedsUserInputContext {
+	forAudio: boolean;
+	forVideo: boolean;
+}
 interface AudioPlayerModuleListeners {
 	["decoded frame"]: Readonly<DecodedSample>;
 }
 interface AudioPlayerModuleEvents {
-	["needs user input"]: void;
+	["needs user input"]: NeedsUserInputContext;
 }
 interface ClockSource {
 	readonly currentTime: number;
@@ -283,6 +287,8 @@ declare class AudioPlayerModule {
 	private audio?;
 	private gainNode?;
 	private _volume;
+	private _userProvidedMuted;
+	private _muted;
 	private startTime;
 	private samples;
 	private sampleRate;
@@ -299,11 +305,11 @@ declare class AudioPlayerModule {
 	set muted(muted: boolean);
 	get currentTime(): number;
 	set currentTime(currentTime: number);
-	constructor(emitter: Emitter<AudioPlayerModuleListeners, AudioPlayerModuleEvents>, logger: Logger, clockSource: ClockSource);
+	constructor(emitter: Emitter<AudioPlayerModuleListeners, AudioPlayerModuleEvents>, logger: Logger, clockSource: ClockSource, muted: boolean);
 	unload: () => Promise<void>;
 	suspend: () => void;
 	unsuspend: () => void;
-	static create: (emitter: Emitter<AudioPlayerModuleListeners, AudioPlayerModuleEvents>, logger: Logger, clockSource: ClockSource) => AudioPlayerModule;
+	static create: (emitter: Emitter<AudioPlayerModuleListeners, AudioPlayerModuleEvents>, logger: Logger, clockSource: ClockSource, muted: boolean) => AudioPlayerModule;
 	private flush;
 	private onDecodedFrame;
 	play: () => Promise<void>;
@@ -341,8 +347,6 @@ export declare const channelNotFoundError: () => VindralError;
 export declare const noIncomingDataError: () => VindralError;
 export declare const unableToConnectError: () => VindralError;
 export declare const unableToConnectAfterRetriesError: () => VindralError;
-export declare const isValidOptions: (options: unknown) => options is Options;
-export declare const validateOptions: (options: Options) => Options;
 declare type State = "connected" | "disconnected" | "connecting";
 interface ConnectionModuleListeners {
 	["send signal"]: Readonly<string>;
@@ -403,6 +407,13 @@ declare class ConnectionModule {
 	reconnect: (reason: string) => void;
 	private sendPing;
 }
+interface Size {
+	width: number;
+	height: number;
+}
+interface PictureInPictureSizeSource {
+	getPictureInPictureSize(): Size | undefined;
+}
 export interface RenditionLevel {
 	audio?: AudioRendition;
 	video?: VideoRendition;
@@ -477,192 +488,6 @@ declare class RenditionsModule {
 	private createRenditionLevels;
 	private getCurrentSubscription;
 }
-interface Size {
-	width: number;
-	height: number;
-}
-interface SubscriptionModuleListeners {
-	["subscription changed"]: Readonly<SubscriptionChange>;
-}
-declare class SubscriptionModule {
-	private logger;
-	private timers;
-	private emitter;
-	private targetSubscription;
-	private currentSubscription;
-	private _isSwitchingSubscription;
-	private pendingSubscriptionTimeoutId?;
-	private constructor();
-	unload: () => void;
-	static create: (logger: Logger, emitter: Emitter<SubscriptionModuleListeners>, subscription: Subscription) => SubscriptionModule;
-	isSwitchingSubscription: () => boolean;
-	getTargetSubscription: () => Subscription;
-	getCurrentSubscription: () => Subscription;
-	setSize: (size: Readonly<Size>) => void;
-	setVideoConstraint: (constraint: VideoConstraint) => void;
-	setAudioConstraint: (constraint: AudioConstraint) => void;
-	setVideoBitRate: (bitRate: number) => void;
-	setAudioBitRate: (bitRate: number) => void;
-	setChannelId: (channelId: string) => void;
-	setLanguage: (language: string | undefined) => void;
-	setVideoCodec: (videoCodec: VideoCodec | undefined) => void;
-	setAudioCodec: (audioCodec: AudioCodec | undefined) => void;
-	private onSubscriptionChanged;
-	private scheduleSubscriptionChange;
-}
-interface UserAgentInformation {
-	userAgent: string;
-	locationOrigin: string;
-	locationPath: string;
-	ancestorOrigins?: string[];
-}
-declare type StatisticsType<K> = K extends {
-	getStatistics: () => unknown;
-} ? ReturnType<K["getStatistics"]> : never;
-declare type StatisticsTypes = {
-	[Property in keyof Modules]: StatisticsType<Modules[Property]>;
-};
-export declare type ModuleStatistics = Flatten<StatisticsTypes>;
-export declare type Statistics = ModuleStatistics & UserAgentInformation & {
-	version: string;
-	ip?: string;
-	url: string;
-	sessionId: string;
-	uptime: number;
-	videoBitRate?: number;
-	audioBitRate?: number;
-	bytesReceived: number;
-	channelId: string;
-	channelGroupId?: string;
-	timeToFirstFrame?: number;
-};
-export declare class Vindral extends Emitter<PublicVindralEvents> {
-	private static INITIAL_MAX_BIT_RATE;
-	readonly pictureInPicture: {
-		enter: () => Promise<void>;
-		exit: () => Promise<void>;
-		isActive: () => boolean;
-		isSupported: () => boolean;
-	};
-	readonly cast: {
-		init: () => Promise<void>;
-		start: () => void;
-		stop: () => void;
-	};
-	private browser;
-	private options;
-	private element;
-	private playbackSource;
-	private emitter;
-	private logger;
-	private modules;
-	private clientIp?;
-	private sessionId;
-	private _channels;
-	private createdAt;
-	private hasCalledConnect;
-	private apiClient;
-	private durationSessions;
-	constructor(options: Options);
-	attach: (container: HTMLElement) => void;
-	set volume(volume: number);
-	get volume(): number;
-	get videoBitRate(): number;
-	get audioBitRate(): number;
-	get connectionState(): Readonly<State>;
-	get playbackState(): Readonly<PlaybackState>;
-	get bufferFullness(): number;
-	get abrEnabled(): boolean;
-	set abrEnabled(enabled: boolean);
-	get serverEdgeTime(): number | undefined;
-	get serverWallclockTime(): number | undefined;
-	get currentTime(): number;
-	get targetBufferTime(): number;
-	set targetBufferTime(bufferTimeMs: number);
-	get playbackLatency(): number | undefined;
-	get playbackWallclockTime(): number | undefined;
-	get channels(): ReadonlyArray<Channel>;
-	get languages(): ReadonlyArray<string>;
-	get language(): string | undefined;
-	set language(language: string | undefined);
-	get channelId(): string;
-	set channelId(channelId: string);
-	get maxSize(): Size;
-	set maxSize(size: Size);
-	get maxBitRate(): number;
-	set maxBitRate(bitRate: number);
-	get maxVideoBitrate(): number;
-	set maxVideoBitrate(bitRate: number);
-	get maxAudioBitrate(): number;
-	set maxAudioBitrate(bitRate: number);
-	get renditionLevels(): ReadonlyArray<RenditionLevel>;
-	get currentRenditionLevel(): Readonly<RenditionLevel> | undefined;
-	get targetRenditionLevel(): Readonly<RenditionLevel> | undefined;
-	get isSwitchingRenditionLevel(): boolean;
-	get videoBufferedRanges(): ReadonlyArray<TimeRange>;
-	get audioBufferedRanges(): ReadonlyArray<TimeRange>;
-	get lastBufferEvent(): Readonly<BufferStateEvent>;
-	get activeRatios(): Map<string, number>;
-	get bufferingRatios(): Map<string, number>;
-	get timeSpentBuffering(): number;
-	get timeActive(): number;
-	updateAuthenticationToken: (token: string) => void;
-	connect: () => void;
-	private connectionInfo;
-	private connectHandler;
-	private filterRenditions;
-	private patchSubscription;
-	private isSupportedVideoCodecProfile;
-	private supportedAudioCodecs;
-	private initializeDecodingModule;
-	unload: () => Promise<void>;
-	userInput: () => void;
-	private play;
-	get uptime(): number;
-	getStatistics: () => Statistics;
-	private onBufferEvent;
-	private alignSizeAndBitRate;
-	private get currentSubscription();
-	private get targetSubscription();
-	private timeToFirstFrame;
-	private willUseMediaSource;
-}
-interface CastModuleListeners {
-	["cast"]: void;
-}
-interface CastModuleEvents {
-	["cast started"]: void;
-	["cast resumed"]: void;
-	["cast stopped"]: void;
-	["cast failed"]: void;
-}
-interface CastConfig {
-	options: Options;
-	background?: string;
-	receiverApplicationId?: string;
-}
-declare class CastModule {
-	private emitter;
-	private logger;
-	private state;
-	get volume(): number;
-	set volume(volume: number);
-	constructor(emitter: Emitter<CastModuleListeners, CastModuleEvents>, logger: Logger);
-	static create: (emitter: Emitter<CastModuleListeners, CastModuleEvents>, logger: Logger) => CastModule;
-	unload: () => void;
-	start: (config: CastConfig) => Promise<void>;
-	stop: () => void;
-	private onGCastApiAvailable;
-	private onSessionStateChanged;
-	private getInstance;
-}
-interface Size {
-	width: number;
-	height: number;
-}
-interface PictureInPictureSizeSource {
-	getPictureInPictureSize(): Size | undefined;
-}
 declare type DeepPartial<T> = {
 	[P in keyof T]?: DeepPartial<T[P]>;
 };
@@ -996,6 +821,39 @@ declare class QualityOfServiceModule {
 	private setActive;
 	private unsetActive;
 }
+interface Size {
+	width: number;
+	height: number;
+}
+interface SubscriptionModuleListeners {
+	["subscription changed"]: Readonly<SubscriptionChange>;
+}
+declare class SubscriptionModule {
+	private logger;
+	private timers;
+	private emitter;
+	private targetSubscription;
+	private currentSubscription;
+	private _isSwitchingSubscription;
+	private pendingSubscriptionTimeoutId?;
+	private constructor();
+	unload: () => void;
+	static create: (logger: Logger, emitter: Emitter<SubscriptionModuleListeners>, subscription: Subscription) => SubscriptionModule;
+	isSwitchingSubscription: () => boolean;
+	getTargetSubscription: () => Subscription;
+	getCurrentSubscription: () => Subscription;
+	setSize: (size: Readonly<Size>) => void;
+	setVideoConstraint: (constraint: VideoConstraint) => void;
+	setAudioConstraint: (constraint: AudioConstraint) => void;
+	setVideoBitRate: (bitRate: number) => void;
+	setAudioBitRate: (bitRate: number) => void;
+	setChannelId: (channelId: string) => void;
+	setLanguage: (language: string | undefined) => void;
+	setVideoCodec: (videoCodec: VideoCodec | undefined) => void;
+	setAudioCodec: (audioCodec: AudioCodec | undefined) => void;
+	private onSubscriptionChanged;
+	private scheduleSubscriptionChange;
+}
 interface SyncSample {
 	type: Type;
 	isSync: boolean;
@@ -1081,6 +939,143 @@ declare class SyncModule {
 		number
 	];
 }
+declare const defaultOptions: {
+	sizeBasedResolutionCapEnabled: boolean;
+	pictureInPictureEnabled: boolean;
+	abrEnabled: boolean;
+	mseEnabled: boolean;
+	mseOpusEnabled: boolean;
+	muted: boolean;
+	minBufferTime: number;
+	maxBufferTime: number;
+	logLevel: Level;
+	maxSize: Size;
+	maxVideoBitRate: number;
+	maxAudioBitRate: number;
+	tags: string[];
+	media: Media;
+	reconnectHandler: (state: ReconnectState) => Promise<boolean> | boolean;
+	advanced: {
+		wasmDecodingConstraint: Partial<VideoConstraint>;
+	};
+};
+interface UserAgentInformation {
+	userAgent: string;
+	locationOrigin: string;
+	locationPath: string;
+	ancestorOrigins?: string[];
+}
+declare type StatisticsType<K> = K extends {
+	getStatistics: () => unknown;
+} ? ReturnType<K["getStatistics"]> : never;
+declare type StatisticsTypes = {
+	[Property in keyof Modules]: StatisticsType<Modules[Property]>;
+};
+export declare type ModuleStatistics = Flatten<StatisticsTypes>;
+export declare type Statistics = ModuleStatistics & UserAgentInformation & {
+	version: string;
+	ip?: string;
+	url: string;
+	sessionId: string;
+	uptime: number;
+	videoBitRate?: number;
+	audioBitRate?: number;
+	bytesReceived: number;
+	channelId: string;
+	channelGroupId?: string;
+	timeToFirstFrame?: number;
+};
+export declare class Vindral extends Emitter<PublicVindralEvents> {
+	private static INITIAL_MAX_BIT_RATE;
+	readonly pictureInPicture: {
+		enter: () => Promise<void>;
+		exit: () => Promise<void>;
+		isActive: () => boolean;
+		isSupported: () => boolean;
+	};
+	private browser;
+	private options;
+	private element;
+	private playbackSource;
+	private emitter;
+	private logger;
+	private modules;
+	private clientIp?;
+	private sessionId;
+	private _channels;
+	private createdAt;
+	private hasCalledConnect;
+	private apiClient;
+	private durationSessions;
+	constructor(options: Options);
+	attach: (container: HTMLElement) => void;
+	set volume(volume: number);
+	get volume(): number;
+	set muted(muted: boolean);
+	get muted(): boolean;
+	get media(): Media;
+	get videoBitRate(): number;
+	get audioBitRate(): number;
+	get connectionState(): Readonly<State>;
+	get playbackState(): Readonly<PlaybackState>;
+	get bufferFullness(): number;
+	get abrEnabled(): boolean;
+	set abrEnabled(enabled: boolean);
+	get serverEdgeTime(): number | undefined;
+	get serverWallclockTime(): number | undefined;
+	get currentTime(): number;
+	get targetBufferTime(): number;
+	set targetBufferTime(bufferTimeMs: number);
+	get playbackLatency(): number | undefined;
+	get playbackWallclockTime(): number | undefined;
+	get channels(): ReadonlyArray<Channel>;
+	get languages(): ReadonlyArray<string>;
+	get language(): string | undefined;
+	set language(language: string | undefined);
+	get channelId(): string;
+	set channelId(channelId: string);
+	get maxSize(): Size;
+	set maxSize(size: Size);
+	get maxBitRate(): number;
+	set maxBitRate(bitRate: number);
+	get maxVideoBitrate(): number;
+	set maxVideoBitrate(bitRate: number);
+	get maxAudioBitrate(): number;
+	set maxAudioBitrate(bitRate: number);
+	get renditionLevels(): ReadonlyArray<RenditionLevel>;
+	get currentRenditionLevel(): Readonly<RenditionLevel> | undefined;
+	get targetRenditionLevel(): Readonly<RenditionLevel> | undefined;
+	get isSwitchingRenditionLevel(): boolean;
+	get videoBufferedRanges(): ReadonlyArray<TimeRange>;
+	get audioBufferedRanges(): ReadonlyArray<TimeRange>;
+	get lastBufferEvent(): Readonly<BufferStateEvent>;
+	get activeRatios(): Map<string, number>;
+	get bufferingRatios(): Map<string, number>;
+	get timeSpentBuffering(): number;
+	get timeActive(): number;
+	getOptions: () => Options & typeof defaultOptions;
+	updateAuthenticationToken: (token: string) => void;
+	connect: () => void;
+	getCastOptions: () => Options;
+	private connectionInfo;
+	private connectHandler;
+	private filterRenditions;
+	private patchSubscription;
+	private isSupportedVideoCodecProfile;
+	private supportedAudioCodecs;
+	private initializeDecodingModule;
+	unload: () => Promise<void>;
+	userInput: () => void;
+	private play;
+	get uptime(): number;
+	getStatistics: () => Statistics;
+	private onBufferEvent;
+	private alignSizeAndBitRate;
+	private get currentSubscription();
+	private get targetSubscription();
+	private timeToFirstFrame;
+	private willUseMediaSource;
+}
 interface TelemetryModuleOptions {
 	url: string;
 	interval?: number;
@@ -1184,7 +1179,6 @@ export interface Modules {
 	qualityOfService: QualityOfServiceModule;
 	metadata: MetadataModule;
 	sync: SyncModule;
-	cast: CastModule;
 	telemetry?: TelemetryModule;
 	documentState: DocumentStateModule;
 	incomingData: IncomingDataModule;
@@ -1235,7 +1229,7 @@ export interface PlaybackSource {
 }
 export interface PublicVindralEvents {
 	["error"]: Readonly<VindralError>;
-	["needs user input"]: void;
+	["needs user input"]: NeedsUserInputContext;
 	["metadata"]: Readonly<Metadata>;
 	["playback state"]: Readonly<PlaybackState>;
 	["connection state"]: Readonly<State>;
@@ -1400,6 +1394,60 @@ export declare class ApiClient {
 	private toChannels;
 	private toChannel;
 }
+export declare type CastState = "casting" | "not casting";
+export interface CastSenderEvents {
+	["connected"]: void;
+	["resumed"]: void;
+	["disconnected"]: void;
+	["failed"]: void;
+	["metadata"]: Metadata;
+	["server wallclock time"]: number;
+}
+export interface CastConfig {
+	options: Options;
+	background?: string;
+	receiverApplicationId?: string;
+}
+export declare type CustomCastMessageType = "stop" | "start" | "updateAuthToken" | "serverWallclockTime" | "metadata" | "setChannelId" | "setLanguage";
+export interface CastCustomMessage {
+	type: CustomCastMessageType;
+	channelId?: string;
+	language?: string;
+	config?: CastConfig;
+	token?: string;
+	serverWallclockTime?: number;
+	metadata?: Metadata;
+}
+export declare class CastSender extends Emitter<CastSenderEvents> {
+	private state;
+	private config;
+	private unloaded;
+	constructor(config: CastConfig);
+	get casting(): boolean;
+	get volume(): number;
+	set volume(volume: number);
+	get language(): string | undefined;
+	set language(language: string | undefined);
+	get channelId(): string;
+	set channelId(channelId: string);
+	updateAuthenticationToken: (token: string) => void;
+	unload: () => void;
+	init: () => Promise<void>;
+	start: () => Promise<void>;
+	stop: () => void;
+	private onGCastApiAvailable;
+	private send;
+	private onMessage;
+	private onSessionStarted;
+	private onSessionStateChanged;
+	private getInstance;
+	private getSession;
+	private getReceiverName;
+	private castLibrariesAdded;
+	private verifyCastLibraries;
+}
+export declare const isValidOptions: (options: unknown) => options is Options;
+export declare const validateOptions: (options: Options) => Options;
 interface FullscreenEvents {
 	["on fullscreen change"]: boolean;
 }
@@ -1417,6 +1465,7 @@ declare class Fullscreen extends Emitter<FullscreenEvents> {
 }
 export interface PlayerOptions {
 	controlsEnabled?: boolean;
+	castEnabled?: boolean;
 	fullscreenButtonEnabled?: boolean;
 	pipButtonEnabled?: boolean;
 	channelSelectionEnabled?: boolean;
@@ -1424,6 +1473,8 @@ export interface PlayerOptions {
 	languagesButtonEnabled?: boolean;
 	oneToOneButtonEnabled?: boolean;
 	hideTimeout?: number;
+	castBackground?: string;
+	castReceiverApplicationId?: string;
 }
 export interface PlayerState {
 	isBuffering: boolean;
@@ -1432,16 +1483,19 @@ export interface PlayerState {
 }
 export declare class Player {
 	readonly core: Vindral;
+	readonly castSender: CastSender;
 	private options;
 	private state;
 	private playerElement;
 	private bufferingOverlay;
+	private playOverlay;
 	private bar;
 	private stateInterval?;
 	private showBufferingTimeout?;
 	constructor(optionsOrInstance: Options | Vindral, playerOptions?: PlayerOptions);
 	unload: () => void;
 	attach: (container: HTMLElement) => void;
+	private setupCastSender;
 	private onMouseMove;
 	private onClick;
 	private togglePip;

package/package.json

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