@daydreamlive/browser 0.1.0 → 0.2.0

package/dist/index.d.cts

@@ -8,12 +8,17 @@ interface BroadcastOptions {
     stream: MediaStream;
     reconnect?: ReconnectConfig;
     video?: VideoConfig;
+    audio?: AudioConfig;
+    iceServers?: RTCIceServer[];
+    connectionTimeout?: number;
     onStats?: (report: RTCStatsReport) => void;
     statsIntervalMs?: number;
     onResponse?: (response: Response) => WHIPResponseResult | void;
 }
 interface PlayerOptions {
     reconnect?: ReconnectConfig;
+    iceServers?: RTCIceServer[];
+    connectionTimeout?: number;
     onStats?: (report: RTCStatsReport) => void;
     statsIntervalMs?: number;
 }
@@ -22,17 +27,27 @@ interface ReconnectConfig {
     maxAttempts?: number;
     baseDelayMs?: number;
 }
+interface ReconnectInfo {
+    attempt: number;
+    maxAttempts: number;
+    delayMs: number;
+}
 interface VideoConfig {
     bitrate?: number;
     maxFramerate?: number;
 }
+interface AudioConfig {
+    bitrate?: number;
+}
 interface BroadcastEventMap {
     stateChange: (state: BroadcastState) => void;
     error: (error: DaydreamError) => void;
+    reconnect: (info: ReconnectInfo) => void;
 }
 interface PlayerEventMap {
     stateChange: (state: PlayerState) => void;
     error: (error: DaydreamError) => void;
+    reconnect: (info: ReconnectInfo) => void;
 }
 interface DaydreamError extends Error {
     code: DaydreamErrorCode;
@@ -40,8 +55,78 @@ interface DaydreamError extends Error {
 }
 type DaydreamErrorCode = "NETWORK_ERROR" | "CONNECTION_FAILED" | "STREAM_NOT_FOUND" | "UNAUTHORIZED" | "UNKNOWN";
 declare const DEFAULT_ICE_SERVERS: RTCIceServer[];
-declare const DEFAULT_VIDEO_BITRATE = 2000000;
+declare const DEFAULT_VIDEO_BITRATE = 300000;
 declare const DEFAULT_AUDIO_BITRATE = 64000;
+type Ctx2D = CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D;
+type FitMode = "contain" | "cover";
+type ContentHint = "detail" | "motion" | "";
+type VideoSource = {
+    kind: "video";
+    element: HTMLVideoElement;
+    fit?: FitMode;
+    contentHint?: ContentHint;
+};
+type CanvasSource = {
+    kind: "canvas";
+    element: HTMLCanvasElement;
+    fit?: FitMode;
+    contentHint?: ContentHint;
+};
+type CustomSource = {
+    kind: "custom";
+    onStart?: (ctx: Ctx2D) => void | (() => void);
+    onFrame?: (ctx: Ctx2D, timestamp: number) => void;
+};
+type Source = VideoSource | CanvasSource | CustomSource;
+type Size = {
+    width: number;
+    height: number;
+    dpr: number;
+};
+interface CompositorOptions {
+    width?: number;
+    height?: number;
+    fps?: number;
+    dpr?: number;
+    crossfadeMs?: number;
+    sendFps?: number;
+    keepalive?: boolean;
+    autoUnlockAudio?: boolean;
+    unlockEvents?: string[];
+    disableSilentAudio?: boolean;
+    onSendFpsChange?: (fps: number) => void;
+}
+type CompositorEvent = "activated" | "registered" | "unregistered";
+interface CompositorEventMap {
+    activated: (id: string | null, source: Source | undefined) => void;
+    registered: (id: string, source: Source) => void;
+    unregistered: (id: string) => void;
+}
+interface Compositor$1 {
+    register(id: string, source: Source): void;
+    unregister(id: string): void;
+    get(id: string): Source | undefined;
+    has(id: string): boolean;
+    list(): Array<{
+        id: string;
+        source: Source;
+    }>;
+    activate(id: string): void;
+    deactivate(): void;
+    readonly activeId: string | null;
+    readonly stream: MediaStream;
+    resize(width: number, height: number, dpr?: number): void;
+    readonly size: Size;
+    setFps(fps: number): void;
+    readonly fps: number;
+    setSendFps(fps: number): void;
+    readonly sendFps: number;
+    addAudioTrack(track: MediaStreamTrack): void;
+    removeAudioTrack(trackId: string): void;
+    unlockAudio(): Promise<boolean>;
+    destroy(): void;
+    on<E extends CompositorEvent>(event: E, cb: CompositorEventMap[E]): () => void;
+}
 
 interface PeerConnectionFactory {
     create(config: RTCConfiguration): RTCPeerConnection;
@@ -69,6 +154,7 @@ interface WHIPClientConfig {
     videoBitrate?: number;
     audioBitrate?: number;
     maxFramerate?: number;
+    connectionTimeout?: number;
     skipIceGathering?: boolean;
     onStats?: (report: RTCStatsReport) => void;
     statsIntervalMs?: number;
@@ -108,8 +194,10 @@ declare class Broadcast extends TypedEventEmitter<BroadcastEventMap> {
     get state(): BroadcastState;
     get whepUrl(): string | null;
     get stream(): MediaStream;
+    get reconnectInfo(): ReconnectInfo | null;
     connect(): Promise<void>;
     stop(): Promise<void>;
+    setMaxFramerate(fps?: number): void;
     replaceStream(newStream: MediaStream): Promise<void>;
     private setupConnectionMonitoring;
     private clearGraceTimeout;
@@ -121,6 +209,7 @@ declare class Broadcast extends TypedEventEmitter<BroadcastEventMap> {
 interface WHEPClientConfig {
     url: string;
     iceServers?: RTCIceServer[];
+    connectionTimeout?: number;
     onStats?: (report: RTCStatsReport) => void;
     statsIntervalMs?: number;
     peerConnectionFactory?: PeerConnectionFactory;
@@ -147,6 +236,7 @@ declare class Player extends TypedEventEmitter<PlayerEventMap> {
     constructor(config: PlayerConfig);
     get state(): PlayerState;
     get stream(): MediaStream | null;
+    get reconnectInfo(): ReconnectInfo | null;
     connect(): Promise<void>;
     attachTo(video: HTMLVideoElement): void;
     stop(): Promise<void>;
@@ -176,9 +266,58 @@ declare class UnauthorizedError extends BaseDaydreamError {
     constructor(message: string, cause?: unknown);
 }
 
+declare class CompositorEventEmitter {
+    private listeners;
+    on<E extends CompositorEvent>(event: E, handler: CompositorEventMap[E]): () => void;
+    off<E extends CompositorEvent>(event: E, handler: CompositorEventMap[E]): void;
+    protected emit<E extends CompositorEvent>(event: E, ...args: Parameters<CompositorEventMap[E]>): void;
+    protected clearListeners(): void;
+}
+declare class Compositor extends CompositorEventEmitter implements Compositor$1 {
+    private readonly registry;
+    private readonly renderer;
+    private readonly scheduler;
+    private readonly audioManager;
+    private readonly visibilityHandler;
+    private _activeId;
+    private _fps;
+    private _sendFps;
+    private lastVisibleSendFps;
+    private outputStream;
+    private destroyed;
+    constructor(options?: CompositorOptions);
+    register(id: string, source: Source): void;
+    unregister(id: string): void;
+    get(id: string): Source | undefined;
+    has(id: string): boolean;
+    list(): Array<{
+        id: string;
+        source: Source;
+    }>;
+    activate(id: string): void;
+    deactivate(): void;
+    get activeId(): string | null;
+    get stream(): MediaStream;
+    resize(width: number, height: number, dpr?: number): void;
+    get size(): Size;
+    setFps(fps: number): void;
+    get fps(): number;
+    setSendFps(fps: number): void;
+    get sendFps(): number;
+    addAudioTrack(track: MediaStreamTrack): void;
+    removeAudioTrack(trackId: string): void;
+    unlockAudio(): Promise<boolean>;
+    destroy(): void;
+    private createOutputStream;
+    private recreateStream;
+    private applyVideoTrackConstraints;
+    private requestVideoTrackFrame;
+}
+declare function createCompositor(options?: CompositorOptions): Compositor;
+
 declare const livepeerResponseHandler: (response: Response) => WHIPResponseResult;
 type LivepeerBroadcastOptions = Omit<BroadcastOptions, "onResponse">;
 declare function createBroadcast(options: LivepeerBroadcastOptions): Broadcast;
 declare function createPlayer(whepUrl: string, options?: PlayerOptions): Player;
 
-export { BaseDaydreamError, Broadcast, type BroadcastConfig, type BroadcastEventMap, type BroadcastOptions, type BroadcastState, ConnectionError, DEFAULT_AUDIO_BITRATE, DEFAULT_ICE_SERVERS, DEFAULT_VIDEO_BITRATE, type DaydreamError, type DaydreamErrorCode, type LivepeerBroadcastOptions, NetworkError, Player, type PlayerConfig, type PlayerEventMap, type PlayerOptions, type PlayerState, type ReconnectConfig, StreamNotFoundError, UnauthorizedError, type VideoConfig, type WHIPResponseResult, createBroadcast, createPlayer, livepeerResponseHandler };
+export { type AudioConfig, BaseDaydreamError, Broadcast, type BroadcastConfig, type BroadcastEventMap, type BroadcastOptions, type BroadcastState, type CanvasSource, type Compositor$1 as Compositor, type CompositorEvent, type CompositorEventMap, type CompositorOptions, ConnectionError, type ContentHint, type Ctx2D, type CustomSource, DEFAULT_AUDIO_BITRATE, DEFAULT_ICE_SERVERS, DEFAULT_VIDEO_BITRATE, type DaydreamError, type DaydreamErrorCode, type FitMode, type LivepeerBroadcastOptions, NetworkError, Player, type PlayerConfig, type PlayerEventMap, type PlayerOptions, type PlayerState, type ReconnectConfig, type ReconnectInfo, type Size, type Source, StreamNotFoundError, UnauthorizedError, type VideoConfig, type VideoSource, type WHIPResponseResult, createBroadcast, createCompositor, createPlayer, livepeerResponseHandler };

package/dist/index.d.ts

@@ -8,12 +8,17 @@ interface BroadcastOptions {
     stream: MediaStream;
     reconnect?: ReconnectConfig;
     video?: VideoConfig;
+    audio?: AudioConfig;
+    iceServers?: RTCIceServer[];
+    connectionTimeout?: number;
     onStats?: (report: RTCStatsReport) => void;
     statsIntervalMs?: number;
     onResponse?: (response: Response) => WHIPResponseResult | void;
 }
 interface PlayerOptions {
     reconnect?: ReconnectConfig;
+    iceServers?: RTCIceServer[];
+    connectionTimeout?: number;
     onStats?: (report: RTCStatsReport) => void;
     statsIntervalMs?: number;
 }
@@ -22,17 +27,27 @@ interface ReconnectConfig {
     maxAttempts?: number;
     baseDelayMs?: number;
 }
+interface ReconnectInfo {
+    attempt: number;
+    maxAttempts: number;
+    delayMs: number;
+}
 interface VideoConfig {
     bitrate?: number;
     maxFramerate?: number;
 }
+interface AudioConfig {
+    bitrate?: number;
+}
 interface BroadcastEventMap {
     stateChange: (state: BroadcastState) => void;
     error: (error: DaydreamError) => void;
+    reconnect: (info: ReconnectInfo) => void;
 }
 interface PlayerEventMap {
     stateChange: (state: PlayerState) => void;
     error: (error: DaydreamError) => void;
+    reconnect: (info: ReconnectInfo) => void;
 }
 interface DaydreamError extends Error {
     code: DaydreamErrorCode;
@@ -40,8 +55,78 @@ interface DaydreamError extends Error {
 }
 type DaydreamErrorCode = "NETWORK_ERROR" | "CONNECTION_FAILED" | "STREAM_NOT_FOUND" | "UNAUTHORIZED" | "UNKNOWN";
 declare const DEFAULT_ICE_SERVERS: RTCIceServer[];
-declare const DEFAULT_VIDEO_BITRATE = 2000000;
+declare const DEFAULT_VIDEO_BITRATE = 300000;
 declare const DEFAULT_AUDIO_BITRATE = 64000;
+type Ctx2D = CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D;
+type FitMode = "contain" | "cover";
+type ContentHint = "detail" | "motion" | "";
+type VideoSource = {
+    kind: "video";
+    element: HTMLVideoElement;
+    fit?: FitMode;
+    contentHint?: ContentHint;
+};
+type CanvasSource = {
+    kind: "canvas";
+    element: HTMLCanvasElement;
+    fit?: FitMode;
+    contentHint?: ContentHint;
+};
+type CustomSource = {
+    kind: "custom";
+    onStart?: (ctx: Ctx2D) => void | (() => void);
+    onFrame?: (ctx: Ctx2D, timestamp: number) => void;
+};
+type Source = VideoSource | CanvasSource | CustomSource;
+type Size = {
+    width: number;
+    height: number;
+    dpr: number;
+};
+interface CompositorOptions {
+    width?: number;
+    height?: number;
+    fps?: number;
+    dpr?: number;
+    crossfadeMs?: number;
+    sendFps?: number;
+    keepalive?: boolean;
+    autoUnlockAudio?: boolean;
+    unlockEvents?: string[];
+    disableSilentAudio?: boolean;
+    onSendFpsChange?: (fps: number) => void;
+}
+type CompositorEvent = "activated" | "registered" | "unregistered";
+interface CompositorEventMap {
+    activated: (id: string | null, source: Source | undefined) => void;
+    registered: (id: string, source: Source) => void;
+    unregistered: (id: string) => void;
+}
+interface Compositor$1 {
+    register(id: string, source: Source): void;
+    unregister(id: string): void;
+    get(id: string): Source | undefined;
+    has(id: string): boolean;
+    list(): Array<{
+        id: string;
+        source: Source;
+    }>;
+    activate(id: string): void;
+    deactivate(): void;
+    readonly activeId: string | null;
+    readonly stream: MediaStream;
+    resize(width: number, height: number, dpr?: number): void;
+    readonly size: Size;
+    setFps(fps: number): void;
+    readonly fps: number;
+    setSendFps(fps: number): void;
+    readonly sendFps: number;
+    addAudioTrack(track: MediaStreamTrack): void;
+    removeAudioTrack(trackId: string): void;
+    unlockAudio(): Promise<boolean>;
+    destroy(): void;
+    on<E extends CompositorEvent>(event: E, cb: CompositorEventMap[E]): () => void;
+}
 
 interface PeerConnectionFactory {
     create(config: RTCConfiguration): RTCPeerConnection;
@@ -69,6 +154,7 @@ interface WHIPClientConfig {
     videoBitrate?: number;
     audioBitrate?: number;
     maxFramerate?: number;
+    connectionTimeout?: number;
     skipIceGathering?: boolean;
     onStats?: (report: RTCStatsReport) => void;
     statsIntervalMs?: number;
@@ -108,8 +194,10 @@ declare class Broadcast extends TypedEventEmitter<BroadcastEventMap> {
     get state(): BroadcastState;
     get whepUrl(): string | null;
     get stream(): MediaStream;
+    get reconnectInfo(): ReconnectInfo | null;
     connect(): Promise<void>;
     stop(): Promise<void>;
+    setMaxFramerate(fps?: number): void;
     replaceStream(newStream: MediaStream): Promise<void>;
     private setupConnectionMonitoring;
     private clearGraceTimeout;
@@ -121,6 +209,7 @@ declare class Broadcast extends TypedEventEmitter<BroadcastEventMap> {
 interface WHEPClientConfig {
     url: string;
     iceServers?: RTCIceServer[];
+    connectionTimeout?: number;
     onStats?: (report: RTCStatsReport) => void;
     statsIntervalMs?: number;
     peerConnectionFactory?: PeerConnectionFactory;
@@ -147,6 +236,7 @@ declare class Player extends TypedEventEmitter<PlayerEventMap> {
     constructor(config: PlayerConfig);
     get state(): PlayerState;
     get stream(): MediaStream | null;
+    get reconnectInfo(): ReconnectInfo | null;
     connect(): Promise<void>;
     attachTo(video: HTMLVideoElement): void;
     stop(): Promise<void>;
@@ -176,9 +266,58 @@ declare class UnauthorizedError extends BaseDaydreamError {
     constructor(message: string, cause?: unknown);
 }
 
+declare class CompositorEventEmitter {
+    private listeners;
+    on<E extends CompositorEvent>(event: E, handler: CompositorEventMap[E]): () => void;
+    off<E extends CompositorEvent>(event: E, handler: CompositorEventMap[E]): void;
+    protected emit<E extends CompositorEvent>(event: E, ...args: Parameters<CompositorEventMap[E]>): void;
+    protected clearListeners(): void;
+}
+declare class Compositor extends CompositorEventEmitter implements Compositor$1 {
+    private readonly registry;
+    private readonly renderer;
+    private readonly scheduler;
+    private readonly audioManager;
+    private readonly visibilityHandler;
+    private _activeId;
+    private _fps;
+    private _sendFps;
+    private lastVisibleSendFps;
+    private outputStream;
+    private destroyed;
+    constructor(options?: CompositorOptions);
+    register(id: string, source: Source): void;
+    unregister(id: string): void;
+    get(id: string): Source | undefined;
+    has(id: string): boolean;
+    list(): Array<{
+        id: string;
+        source: Source;
+    }>;
+    activate(id: string): void;
+    deactivate(): void;
+    get activeId(): string | null;
+    get stream(): MediaStream;
+    resize(width: number, height: number, dpr?: number): void;
+    get size(): Size;
+    setFps(fps: number): void;
+    get fps(): number;
+    setSendFps(fps: number): void;
+    get sendFps(): number;
+    addAudioTrack(track: MediaStreamTrack): void;
+    removeAudioTrack(trackId: string): void;
+    unlockAudio(): Promise<boolean>;
+    destroy(): void;
+    private createOutputStream;
+    private recreateStream;
+    private applyVideoTrackConstraints;
+    private requestVideoTrackFrame;
+}
+declare function createCompositor(options?: CompositorOptions): Compositor;
+
 declare const livepeerResponseHandler: (response: Response) => WHIPResponseResult;
 type LivepeerBroadcastOptions = Omit<BroadcastOptions, "onResponse">;
 declare function createBroadcast(options: LivepeerBroadcastOptions): Broadcast;
 declare function createPlayer(whepUrl: string, options?: PlayerOptions): Player;
 
-export { BaseDaydreamError, Broadcast, type BroadcastConfig, type BroadcastEventMap, type BroadcastOptions, type BroadcastState, ConnectionError, DEFAULT_AUDIO_BITRATE, DEFAULT_ICE_SERVERS, DEFAULT_VIDEO_BITRATE, type DaydreamError, type DaydreamErrorCode, type LivepeerBroadcastOptions, NetworkError, Player, type PlayerConfig, type PlayerEventMap, type PlayerOptions, type PlayerState, type ReconnectConfig, StreamNotFoundError, UnauthorizedError, type VideoConfig, type WHIPResponseResult, createBroadcast, createPlayer, livepeerResponseHandler };
+export { type AudioConfig, BaseDaydreamError, Broadcast, type BroadcastConfig, type BroadcastEventMap, type BroadcastOptions, type BroadcastState, type CanvasSource, type Compositor$1 as Compositor, type CompositorEvent, type CompositorEventMap, type CompositorOptions, ConnectionError, type ContentHint, type Ctx2D, type CustomSource, DEFAULT_AUDIO_BITRATE, DEFAULT_ICE_SERVERS, DEFAULT_VIDEO_BITRATE, type DaydreamError, type DaydreamErrorCode, type FitMode, type LivepeerBroadcastOptions, NetworkError, Player, type PlayerConfig, type PlayerEventMap, type PlayerOptions, type PlayerState, type ReconnectConfig, type ReconnectInfo, type Size, type Source, StreamNotFoundError, UnauthorizedError, type VideoConfig, type VideoSource, type WHIPResponseResult, createBroadcast, createCompositor, createPlayer, livepeerResponseHandler };