@netless/fastboard-core 0.3.6 → 1.0.0-canary.2

package/README.md

@@ -4,6 +4,67 @@ A tiny wrapper of white-web-sdk and @netless/window-manager.
 
 Used by [@netless/fastboard-ui](https://github.com/netless-io/fastboard/tree/main/packages/fastboard-ui).
 
+### Usage
+
+> **Warning**: This package is not intended to be used directly. You should use @netless/fastboard or @netless/fastboard-react instead.
+
+```ts
+import { FastboardApp } from "@netless/fastboard-core";
+
+let sdk = new WhiteWebSdk();
+let room = await sdk.joinRoom({ hotKeys });
+let manager = await WindowManager.mount(room);
+let syncedStore = await SyncedStorePlugin.init(room);
+
+let app = new FastboardApp(sdk, room, manager, syncedStore, hotKeys);
+
+// reactive values
+app.writable.subscribe(w => console.log(w ? "room is writable" : "room is readonly"));
+
+// methods
+await app.insertImage("https://url/to/image.png");
+
+// requires @netless/app-slide to be registered
+await app.insertDocs("filename.pptx", conversionResponse);
+
+// quit
+await app.destroy();
+```
+
+### Advanced Usage
+
+```ts
+import { addRoomListener } from "@netless/fastboard-core";
+
+const stopListen = addRoomListener(room, "onKeyDown", event => {
+  console.log("keydown", event.key);
+  stopListen();
+});
+
+import { createVal } from "@netless/fastboard-core";
+
+const writable = createVal(
+  // initial value
+  room.isWritable,
+  // setup listener, returns a cleanup function to stop listening
+  set => addRoomListener(room, "onEnableWriteNowChanged", () => set(room.isWritable)),
+  // optional setter
+  newValue => room.setWritable(newValue)
+);
+
+writable.value; // true
+writable.subscribe(w => console.log(w ? "room is writable" : "room is readonly"));
+// change the value and invoke subs,
+// if provided setter, this function will not change inner value directly, instead it calls the setter
+writable.set(true);
+writable.dispose(); // stop listening
+
+// hacking, should not be used
+writable.subs.forEach(f => f(writable.value)); // subs: Set<Subscriber>
+writable.subs.clear(); // remove all subs
+writable.value = false; // no trigger subs, but did change value
+```
+
 ### License
 
 MIT @ [netless](https://github.com/netless-io)

package/dist/index.d.ts

@@ -1,107 +1,70 @@
-import { Size, SceneDefinition, ConvertedFile, RoomPhase as RoomPhase$1, ApplianceNames, ShapeType, MemberState, RoomState, Camera, AnimationMode, Rectangle, Color, ConversionResponse, WhiteWebSdkConfiguration, JoinRoomParams, RoomCallbacks, WhiteWebSdk, Room, HotKeys, ViewCallbacks, PlayerPhase as PlayerPhase$1, PlayerState, PlayerSeekingResult, ReplayRoomParams, PlayerCallbacks, Player } from 'white-web-sdk';
-export { AnimationMode, ApplianceNames, Camera, Color, ConversionResponse, HotKey, HotKeys, JoinRoomParams, MemberState, PlayerSeekingResult, Rectangle, Room, RoomCallbacks, RoomState, SceneDefinition, ShapeType, ViewCallbacks, WhiteWebSdk, WhiteWebSdkConfiguration } from 'white-web-sdk';
-import { AddPageParams, MountParams, NetlessApp, WindowManager, PublicEvent, RegisterParams } from '@netless/window-manager';
+import { ApplianceNames, RoomCallbacks, Room, PlayerCallbacks, Player, ViewCallbacks, View, JoinRoomParams, ReplayRoomParams, WhiteWebSdk, HotKeys, RoomPhase, MemberState, CameraState, Camera, AnimationMode, ShapeType, Color, ConversionResponse, SceneDefinition, WhiteWebSdkConfiguration, PlayerPhase, PlayerState, PlayerSeekingResult } from 'white-web-sdk';
+export { AnimationMode, ApplianceNames, Camera, CameraState, Color, ConversionResponse, ConvertedFile, HotKey, HotKeys, JoinRoomParams, MemberState, Player, PlayerCallbacks, PlayerPhase, PlayerSeekingResult, PlayerState, Rectangle, ReplayRoomParams, Room, RoomCallbacks, RoomPhase, RoomState, SceneDefinition, ShapeType, View, ViewCallbacks, WhiteWebSdk, WhiteWebSdkConfiguration } from 'white-web-sdk';
+import { PublicEvent, WindowManager, AddPageParams, MountParams, NetlessApp } from '@netless/window-manager';
 export { AddPageParams, MountParams, NetlessApp, PublicEvent, WindowManager } from '@netless/window-manager';
 import { SyncedStore } from '@netless/synced-store';
 export { Diff, DiffOne, Storage, SyncedStore } from '@netless/synced-store';
-export { PreviewParams, default as SlideApp, Controller as SlideController, AppOptions as SlideOptions, SlidePreviewer, addHooks as addSlideHooks, previewSlide, apps as slideApps } from '@netless/app-slide';
+
+declare type Appliance = `${ApplianceNames}`;
+
+declare function addRoomListener<K extends keyof RoomCallbacks>(room: Room, name: K, listener: RoomCallbacks[K]): () => void;
+declare function addPlayerListener<K extends keyof PlayerCallbacks>(player: Player, name: K, listener: PlayerCallbacks[K]): () => void;
+declare function addViewListener<K extends keyof ViewCallbacks>(view: View, name: K, listener: (value: ViewCallbacks[K]) => void): () => void;
+declare function addManagerListener<K extends keyof PublicEvent>(manager: WindowManager, name: K, listener: (value: PublicEvent[K]) => void): () => void;
+declare function ensureOfficialPlugins<T extends JoinRoomParams | ReplayRoomParams>(joinRoom: T): T;
 
 declare type Subscriber<T> = (value: T) => void;
-declare type Unsubscriber = () => void;
 declare type Updater<T> = (value: T) => T;
-declare type StartStopNotifier<T> = (set: Subscriber<T>) => Unsubscriber | void;
+declare type Disposer = () => void;
+declare type StartStopNotifier<T> = (set: Subscriber<T>) => Disposer | void;
 interface Readable<T> {
     readonly value: T;
-    subscribe(this: void, run: Subscriber<T>): Unsubscriber;
-    reaction(this: void, run: Subscriber<T>): Unsubscriber;
+    readonly subs: Set<Subscriber<T>>;
+    subscribe(this: Readable<T>, run: Subscriber<T>): Disposer;
+    reaction(this: Readable<T>, run: Subscriber<T>): Disposer;
+    dispose(this: Readable<T>): void;
 }
 interface Writable<T> extends Readable<T> {
-    set(this: void, value: T): void;
-    update(this: void, updater: Updater<T>): void;
+    set(this: Writable<T>, value: T): void;
+    update(this: Writable<T>, updater: Updater<T>): void;
 }
-declare function readable<T>(value: T, start?: StartStopNotifier<T>): Readable<T>;
-declare function writable<T>(value: T, start: StartStopNotifier<T> | undefined, set: Subscriber<T>): Writable<T>;
-
-declare function getImageSize(url: string, fallback: Size): Promise<Size>;
-declare function makeSlideParams(scenes: SceneDefinition[]): {
-    scenes: SceneDefinition[];
-    taskId: string;
-    url: string;
-};
-declare function convertedFileToScene(f: ConvertedFile, i: number): SceneDefinition;
-
-declare function genUID(): string;
-
-declare const warnings: {
-    readonly "no-ppt-in-scenes": "You're probably inserting the slide app in a wrong way, there shouldn't exist `scenes[0].ppt`.";
-};
-declare function warn(id: keyof typeof warnings): void;
+/**
+ * ```js
+ * const mediaQuery = matchMedia("(prefers-color-scheme: dark)")
+ * const isDark = createVal(mediaQuery.matches, set => {
+ *   const update = () => set(mediaQuery.matches)
+ *   mediaQuery.addEventListener("change", update)
+ *   return () => mediaQuery.removeEventListener("change", update)
+ * });
+ * ```
+ */
+declare function createVal<T>(init: T, start: StartStopNotifier<T>): Readable<T>;
+declare function createVal<T>(init: T, start: StartStopNotifier<T>, setter: (value: T) => void): Writable<T>;
 
-declare class FastboardAppBase<TEventData = any> {
+declare class FastboardAppStruct<TEventData> {
     readonly sdk: WhiteWebSdk;
     readonly room: Room;
     readonly manager: WindowManager;
-    readonly hotKeys: Partial<HotKeys>;
     readonly syncedStore: SyncedStore<TEventData>;
-    constructor(sdk: WhiteWebSdk, room: Room, manager: WindowManager, hotKeys: Partial<HotKeys>, syncedStore: SyncedStore<TEventData>);
+    readonly hotKeys: Partial<HotKeys>;
+    protected _disposers: Disposer[];
     protected _destroyed: boolean;
     protected _assertNotDestroyed(): void;
-    protected _addRoomListener<K extends keyof RoomCallbacks>(name: K, listener: RoomCallbacks[K]): () => void;
-    protected _addManagerListener<K extends keyof PublicEvent>(name: K, listener: (value: PublicEvent[K]) => void): () => void;
-    protected _addMainViewListener<K extends keyof ViewCallbacks>(name: K, listener: ViewCallbacks[K]): () => void;
+    protected _flushAllDisposers(): void;
+    constructor(sdk: WhiteWebSdk, room: Room, manager: WindowManager, syncedStore: SyncedStore<TEventData>, hotKeys: Partial<HotKeys>);
+}
+declare class FastboardApp<TEventData = any> extends FastboardAppStruct<TEventData> {
+    constructor(sdk: WhiteWebSdk, room: Room, manager: WindowManager, syncedStore: SyncedStore<TEventData>, hotKeys: Partial<HotKeys>);
     /**
-     * Destroy fastboard (disconnect from the whiteboard room).
+     * Disconnect from whiteboard room.
      */
     destroy(): Promise<void>;
-}
-declare type RoomPhase = `${RoomPhase$1}`;
-
-/** pencil, eraser, rectangle... */
-declare type Appliance = `${ApplianceNames}`;
-/** triangle, star... */
-declare type Shape = `${ShapeType}`;
-/** Params for static docs, they are rendered as many images. */
-interface InsertDocsStatic {
-    readonly fileType: "pdf";
-    /** Unique string for binding whiteboard view to the doc. Must start with `/`. */
-    readonly scenePath: string;
-    /** @example [{ name: '1', ppt: { src: 'url/to/ppt/1.png' } }] */
-    readonly scenes: SceneDefinition[];
-    /** Window title. */
-    readonly title?: string;
-}
-/** Params for slides, they are rendered in @netless/app-slide with animations. */
-interface InsertDocsDynamic {
-    readonly fileType: "pptx";
-    /** Unique string for binding whiteboard view to the doc. Must start with `/`. */
-    readonly scenePath: string;
-    /** Conversion task id, see https://developer.netless.link/server-en/home/server-conversion#get-query-task-conversion-progress. */
-    readonly taskId: string;
-    /** Window title. */
-    readonly title?: string;
-    /** Where the slide resource placed. @default `https://convertcdn.netless.link/dynamicConvert` */
-    readonly url?: string;
-    /** @example [{ name: '1' }, { name: '2' }, { name: '3' }] */
-    readonly scenes?: SceneDefinition[];
-}
-declare type InsertDocsParams = InsertDocsStatic | InsertDocsDynamic;
-declare type SetMemberStateFn = (partialMemberState: Partial<MemberState>) => void;
-declare type RoomStateChanged = (diff: Partial<RoomState>) => void;
-/** App download progress. */
-interface AppsStatus {
-    [kind: string]: {
-        status: "idle" | "loading" | "failed";
-        /** Exist if status is `failed`. */
-        reason?: string;
-    };
-}
-declare class FastboardApp<TEventData = any> extends FastboardAppBase<TEventData> {
     /**
      * Render this app to some DOM.
      */
     bindContainer(container: HTMLElement): void;
     /**
-     * Move window-manager's collector to some place.
+     * Move window manager's collector to some place.
      */
     bindCollector(container: HTMLElement): void;
     /**
@@ -111,14 +74,19 @@ declare class FastboardApp<TEventData = any> extends FastboardAppBase<TEventData
     /**
      * Is current room online?
      */
-    readonly phase: Readable<"connecting" | "connected" | "reconnecting" | "disconnecting" | "disconnected">;
+    readonly phase: Readable<RoomPhase>;
+    /**
+     * Current user's state, including 'strokeColor', etc.
+     *
+     * To change the tool, use `app.setAppliance('pencil')`.
+     */
+    readonly memberState: Readable<MemberState>;
     /**
-     * Current window-manager's windows' state (is it maximized?).
+     * Window manager's windows' state (is it maximized).
      */
-    readonly boxState: Readable<"minimized" | "maximized" | "normal" | undefined>;
+    readonly boxState: Readable<"normal" | "minimized" | "maximized" | undefined>;
     /**
-     * Current window-manager's focused app's id.
-     * @example "HelloWorld-1A2b3C4d"
+     * Window manager's focused (at the top) app's id, like `HelloWorld-1A2b3C4d`.
      */
     readonly focusedApp: Readable<string | undefined>;
     /**
@@ -130,28 +98,30 @@ declare class FastboardApp<TEventData = any> extends FastboardAppBase<TEventData
      */
     readonly canUndoSteps: Readable<number>;
     /**
-     * Current camera information of main view.
-     *
-     * Change the camera position by `app.moveCamera()`.
+     * The synced camera state across all users.
      */
-    readonly camera: Readable<Camera>;
+    readonly baseCamera: Readable<{
+        id: string;
+        centerX: number | null;
+        centerY: number | null;
+        scale: number;
+    } | undefined>;
     /**
-     * Current tool's info, like "is using pencil?", "what color?".
+     * The local camera state of main view in window manager.
      *
-     * Change the tool by `app.setAppliance()`.
+     * Change the camera position by `app.moveCamera()`.
      */
-    readonly memberState: Readable<MemberState>;
+    readonly camera: Readable<CameraState>;
     /**
-     * 0..n-1, current index of main view scenes.
+     * 0..n-1, current index of pages.
      */
-    readonly sceneIndex: Writable<number>;
+    readonly pageIndex: Writable<number>;
     /**
-     * How many pages are in the main view?
+     * How many pages are there in the main view?
      */
-    readonly sceneLength: Readable<number>;
-    private _appsStatus;
+    readonly pageLength: Readable<number>;
     /**
-     * Apps status.
+     * Apps loading status.
      */
     readonly appsStatus: Readable<AppsStatus>;
     /**
@@ -163,15 +133,9 @@ declare class FastboardApp<TEventData = any> extends FastboardAppBase<TEventData
      */
     redo(): void;
     /**
-     * Move current main view's camera position.
+     * Move main view's camera.
      */
     moveCamera(camera: Partial<Camera> & {
-        animationMode?: AnimationMode | undefined;
-    }): void;
-    /**
-     * Move current main view's camera to include a rectangle.
-     */
-    moveCameraToContain(rectangle: Rectangle & {
         animationMode?: AnimationMode;
     }): void;
     /**
@@ -179,65 +143,67 @@ declare class FastboardApp<TEventData = any> extends FastboardAppBase<TEventData
      */
     cleanCurrentScene(): void;
     /**
-     * Set current tool, like "pencil".
+     * Set current tool, like `pencil`.
      */
-    setAppliance(appliance: ApplianceNames | Appliance, shape?: ShapeType | Shape): void;
+    setAppliance(appliance: ApplianceNames | `${ApplianceNames}`, shape?: ShapeType | `${ShapeType}`): void;
     /**
      * Set pencil and shape's thickness.
      */
-    setStrokeWidth(strokeWidth: number): void;
+    setStrokeWidth(width: number): void;
     /**
      * Set pencil and shape's color.
      */
-    setStrokeColor(strokeColor: Color): void;
+    setStrokeColor(color: Color): void;
     /**
      * Set text size. Default is 16.
      */
-    setTextSize(textSize: number): void;
+    setTextSize(size: number): void;
     /**
      * Set text color.
-     *
-     * @example
-     * setTextColor([0x66, 0xcc, 0xff])
      */
-    setTextColor(textColor: Color): void;
+    setTextColor(color: Color): void;
+    /**
+     * Toggle dotted line effect on pencil.
+     */
+    toggleDottedLine(force?: boolean): void;
     /**
-     * Goto previous page (the main whiteboard view).
+     * Goto previous page, returns true if success.
      */
     prevPage(): Promise<boolean>;
     /**
-     * Goto next page (the main whiteboard view).
+     * Goto next page, returns true if success.
      */
     nextPage(): Promise<boolean>;
     /**
      * Add one page to the main whiteboard view.
-     *
-     * @example
-     * addPage({ after: true }) // add one page right after current one.
-     * nextPage() // then, goto that page.
+     * ```js
+     * app.addPage({ after: true }) // add one page right after current page
+     * app.nextPage() // then, goto that page
+     * ```
      */
     addPage(params?: AddPageParams): Promise<void>;
     /**
      * Remove one page at given index or current page (by default).
-     *
-     * Requires `@netless/window-manager` >= 0.4.30.
-     *
-     * @example
-     * removePage() // remove current page
      */
     removePage(index?: number): Promise<boolean>;
     /**
      * Insert an image to the main view.
-     *
-     * @example
-     * insertImage("https://i.imgur.com/CzXTtJV.jpg")
      */
-    insertImage(url: string): Promise<void>;
+    insertImage(url: string, options?: InsertImageOptions): Promise<void>;
+    /**
+     * Insert the Media Player app.
+     */
+    insertMedia(title: string, src: string): Promise<string | undefined>;
     /**
      * Insert PDF/PPTX from conversion result.
      * @param status https://developer.netless.link/server-en/home/server-conversion#get-query-task-conversion-progress
      */
     insertDocs(filename: string, status: ConversionResponse): Promise<string | undefined>;
+    /**
+     * Insert PDF/PPTX from projector conversion result.
+     * @param response https://developer.netless.link/server-zh/home/server-projector#get-%E6%9F%A5%E8%AF%A2%E4%BB%BB%E5%8A%A1%E8%BD%AC%E6%8D%A2%E8%BF%9B%E5%BA%A6
+     */
+    insertDocs(filename: string, response: ProjectorResponse): Promise<string | undefined>;
     /**
      * Manual way.
      * @example
@@ -249,26 +215,68 @@ declare class FastboardApp<TEventData = any> extends FastboardAppBase<TEventData
      * })
      */
     insertDocs(params: InsertDocsParams): Promise<string | undefined>;
-    private _insertDocsImpl;
-    /**
-     * Insert the Media Player app.
-     */
-    insertMedia(title: string, src: string): Promise<string | undefined>;
-    /**
-     * Insert the Monaco Code Editor app.
-     * @deprecated Use `app.manager.addApp({ kind: 'Monaco' })` instead.
-     */
-    insertCodeEditor(): Promise<string | undefined>;
-    /**
-     * Insert the Countdown app.
-     * @deprecated Use `app.manager.addApp({ kind: 'Countdown' })` instead.
-     */
-    insertCountdown(): Promise<string | undefined>;
-    /**
-     * Insert the GeoGebra app.
-     * @deprecated Use `app.manager.addApp({ kind: 'GeoGebra' })` instead.
-     */
-    insertGeoGebra(): Promise<string | undefined>;
+}
+interface AppsStatus {
+    [kind: string]: {
+        status: "idle" | "loading" | "failed";
+        /** Exist if status is `failed` */
+        reason?: string;
+    };
+}
+interface InsertImageOptions {
+    /** Image width, in pixel */
+    width?: number;
+    /** Image height, in pixel */
+    height?: number;
+    /** Image position, in pixel, default as 0 */
+    centerX?: number;
+    /** Image position, in pixel, default as 0 */
+    centerY?: number;
+    /** Whether to disable moving, default is false */
+    locked?: boolean;
+    /** Whether to keep ratio */
+    uniformScale?: boolean;
+}
+/** Params for static docs, they are rendered as many images. */
+interface InsertDocsStatic {
+    readonly fileType: "pdf";
+    /** Unique string for binding whiteboard view to the doc. Must start with `/`. */
+    readonly scenePath: string;
+    /** @example [{ name: '1', ppt: { src: 'url/to/ppt/1.png' } }] */
+    readonly scenes: SceneDefinition[];
+    /** Window title. */
+    readonly title?: string;
+}
+/** Params for slides, they are rendered in @netless/app-slide with animations. */
+interface InsertDocsDynamic {
+    readonly fileType: "pptx";
+    /** Unique string for binding whiteboard view to the doc. Must start with `/`. */
+    readonly scenePath: string;
+    /** Conversion task id, see https://developer.netless.link/server-en/home/server-conversion#get-query-task-conversion-progress. */
+    readonly taskId: string;
+    /** Window title. */
+    readonly title?: string;
+    /** Where the slide resource placed. @default `https://convertcdn.netless.link/dynamicConvert` */
+    readonly url?: string;
+    /** @example [{ name: '1' }, { name: '2' }, { name: '3' }] */
+    readonly scenes?: SceneDefinition[];
+}
+declare type InsertDocsParams = InsertDocsStatic | InsertDocsDynamic;
+interface ProjectorResponse {
+    uuid: string;
+    status: "Waiting" | "Converting" | "Finished" | "Fail";
+    /** 0..100 */
+    convertedPercentage: number;
+    /** https://example.org/path/to/dynamicConvert */
+    prefix: string;
+    pageCount: number;
+    /** {1:"{prefix}/{taskId}/preview/1.png"} */
+    previews: Record<number, string>;
+    /** {prefix}/{taskId}/jsonOutput/note.json */
+    note: string;
+    /** 20xxxxx */
+    errorCode: `${number}`;
+    errorMessage: string;
 }
 interface FastboardOptions {
     sdkConfig: Omit<WhiteWebSdkConfiguration, "useMobXState"> & {
@@ -280,45 +288,31 @@ interface FastboardOptions {
     managerConfig?: Omit<MountParams, "room">;
     netlessApps?: NetlessApp[];
 }
-/**
- * Create a FastboardApp instance.
- * @example
- * let app = await createFastboard({
- *   sdkConfig: {
- *     appIdentifier: import.meta.env.VITE_APPID,
- *     region: 'cn-hz',
- *   },
- *   joinRoom: {
- *     uid: unique_id,
- *     uuid: import.meta.env.VITE_ROOM_UUID,
- *     roomToken: import.meta.env.VITE_ROOM_TOKEN,
- *   },
- * })
- */
-declare function createFastboard<TEventData = any>({ sdkConfig, joinRoom: { callbacks, ...joinRoomParams }, managerConfig, netlessApps, }: FastboardOptions): Promise<FastboardApp<TEventData>>;
+declare function createFastboardCore<TEventData = any>({ sdkConfig, joinRoom: { callbacks, ...joinRoomParams }, managerConfig, netlessApps, }: FastboardOptions): Promise<FastboardApp<TEventData>>;
 
-declare class FastboardPlayerBase<TEventData = any> {
+declare class FastboardPlayerStruct<TEventData> {
     readonly sdk: WhiteWebSdk;
     readonly player: Player;
     readonly manager: WindowManager;
     readonly syncedStore: SyncedStore<TEventData>;
-    constructor(sdk: WhiteWebSdk, player: Player, manager: WindowManager, syncedStore: SyncedStore<TEventData>);
+    protected _disposers: Disposer[];
     protected _destroyed: boolean;
     protected _assertNotDestroyed(): void;
-    protected _addPlayerListener<K extends keyof PlayerCallbacks>(name: K, listener: PlayerCallbacks[K]): () => void;
-    protected _addManagerListener<K extends keyof PublicEvent>(name: K, listener: (value: PublicEvent[K]) => void): () => void;
-    protected _addMainViewListener<K extends keyof ViewCallbacks>(name: K, listener: ViewCallbacks[K]): () => void;
-    destroy(): void;
+    protected _flushAllDisposers(): void;
+    constructor(sdk: WhiteWebSdk, player: Player, manager: WindowManager, syncedStore: SyncedStore<TEventData>);
 }
-declare type PlayerPhase = `${PlayerPhase$1}`;
-
-declare class FastboardPlayer<TEventData = any> extends FastboardPlayerBase<TEventData> {
+declare class FastboardPlayer<TEventData = any> extends FastboardPlayerStruct<TEventData> {
+    constructor(sdk: WhiteWebSdk, player: Player, manager: WindowManager, syncedStore: SyncedStore<TEventData>);
+    /**
+     * Disconnect from whiteboard room.
+     */
+    destroy(): void;
     /**
-     * Render this player to some DOM.
+     * Render this app to some DOM.
      */
     bindContainer(container: HTMLElement): void;
     /**
-     * Move window-manager's collector to some place.
+     * Move window manager's collector to some place.
      */
     bindCollector(container: HTMLElement): void;
     /**
@@ -328,12 +322,11 @@ declare class FastboardPlayer<TEventData = any> extends FastboardPlayerBase<TEve
     /**
      * Player state, like "is it playing?".
      */
-    readonly phase: Readable<"waitingFirstFrame" | "playing" | "pause" | "stop" | "ended" | "buffering">;
+    readonly phase: Readable<PlayerPhase>;
     /**
      * Will become true after buffering.
      */
     readonly canplay: Readable<boolean>;
-    private _setPlaybackRate;
     /**
      * Playback speed, default `1`.
      */
@@ -343,7 +336,7 @@ declare class FastboardPlayer<TEventData = any> extends FastboardPlayerBase<TEve
      */
     readonly duration: Readable<number>;
     /**
-     * Get state of room at that time, like "who was in the room?".
+     * Get state of room at current time.
      */
     readonly state: Readable<PlayerState>;
     /**
@@ -363,7 +356,7 @@ declare class FastboardPlayer<TEventData = any> extends FastboardPlayerBase<TEve
      */
     stop(): void;
     /**
-     * Set playback speed, a shortcut for `speed.set(x)`.
+     * Set playback speed, the same as `player.playbackRate.set(x)`.
      */
     setPlaybackRate(value: number): void;
 }
@@ -377,28 +370,9 @@ interface FastboardReplayOptions {
     managerConfig?: Omit<MountParams, "room">;
     netlessApps?: NetlessApp[];
 }
-/**
- * Create a FastboardPlayer instance.
- * @example
- * let player = await replayFastboard({
- *   sdkConfig: {
- *     appIdentifier: import.meta.env.VITE_APPID,
- *     region: 'cn-hz',
- *   },
- *   replayRoom: {
- *     room: "room uuid",
- *     roomToken: "NETLESSROOM_...",
- *     beginTimestamp: 1646619090394,
- *     duration: 70448,
- *   },
- * })
- */
-declare function replayFastboard<TEventData = any>({ sdkConfig, replayRoom: { callbacks, ...replayRoomParams }, managerConfig, netlessApps, }: FastboardReplayOptions): Promise<FastboardPlayer<TEventData>>;
+declare function replayFastboardCore<TEventData = any>({ sdkConfig, replayRoom: { callbacks, ...replayRoomParams }, managerConfig, netlessApps, }: FastboardReplayOptions): Promise<FastboardPlayer<TEventData>>;
 
-interface AppsConfig {
-    [kind: string]: Omit<RegisterParams, "kind">;
-}
-declare const register: typeof WindowManager.register;
+declare const name: string;
 declare const version: string;
 
-export { Appliance, AppsConfig, AppsStatus, FastboardApp, FastboardOptions, FastboardPlayer, FastboardReplayOptions, InsertDocsDynamic, InsertDocsParams, InsertDocsStatic, PlayerPhase, Readable, RoomPhase, RoomStateChanged, SetMemberStateFn, Shape, StartStopNotifier, Subscriber, Unsubscriber, Updater, Writable, convertedFileToScene, createFastboard, genUID, getImageSize, makeSlideParams, readable, register, replayFastboard, version, warn, writable };
+export { Appliance, AppsStatus, Disposer, FastboardApp, FastboardOptions, FastboardPlayer, FastboardReplayOptions, InsertDocsDynamic, InsertDocsParams, InsertDocsStatic, InsertImageOptions, ProjectorResponse, Readable, StartStopNotifier, Subscriber, Updater, Writable, addManagerListener, addPlayerListener, addRoomListener, addViewListener, createFastboardCore, createVal, ensureOfficialPlugins, name, replayFastboardCore, version };