JSPM

@netless/window-manager

0.1.55
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1747
  • Score
    100M100P100Q115915F
  • License ISC

Package Exports

  • @netless/window-manager

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@netless/window-manager) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

WindowManager

MainView

MainView 也就是主白板, 是垫在所有窗口下面的主白板

因为多窗口的原因，所以抽象出来一个主白板, 并且把以前部分对 room 的操作, 迁移到对 mainView 操作

注意事项

多窗口模式必须开启白板的 useMultiViews 选项

会造成原本以下 room 上的一些方法和 state 失效

方法

  • room.bindHtmlElement() 用 WindowManager.mount() 代替
  • room.scalePptToFit() 暂无代替,不再推荐调用 scalePptToFit
  • room.setScenePath() 用 manager.setMainViewScenePath() 代替
  • room.setSceneIndex() 用 manager.setMainViewSceneIndex() 代替

为了方便使用 manager 替换了 room 上的一些方法可以直接对 mainView 生效

  • room.disableCameraTransform
  • room.moveCamera
  • room.moveCameraToContain
  • room.convertToPointInWorld
  • room.setCameraBound

camera

  • room.state.cameraState 用 manager.mainView.camera 和 manager.mainView.size 代替

想要监听主白板 camera 的变化, 请使用如下方式代替

manager.mainView.callbacks.on("onCameraUpdated", (camera) => {
  console.log(camera);
});

监听主白板 size 变化

manager.mainView.callbacks.on("onSizeUpdated", (size) => {
  console.log(size);
});

接入

import { WhiteWebSdk } from "white-web-sdk";
import { WindowManager, BuiltinApps } from "@netless/window-manager";
import "@netless/window-manager/dist/style.css";

const sdk = new WhiteWebSdk({
    appIdentifier: "appIdentifier"
});

sdk.joinRoom({
    uuid: "room uuid",
    roomToken: "room token",
    invisiblePlugins: [WindowManager],
    useMultiViews: true, // 多窗口必须用开启 useMultiViews
}).then(async room => {
    const manager = await WindowManager.mount(
        room,
        container,
        // 完整配置见下方
    );
});

mount

WindowManager.mount({
    room: room, // 房间实例
    container: container, // 挂载 dom 容器, 等同于 room.bindHtmlElement
    containerSizeRatio: 9 / 16, // 可选, 多窗口区域的高宽比，默认为  9 : 16
    chessboard: true, // 多窗口区域以外的空间显示 PS 棋盘背景，默认 true
    collectorContainer: collectorContainer, // 可选, 用于多窗口最小化图标挂载的 dom
    collectorStyles: { bottom: "100px", right: "50px" }, // 可选, 配置 collector 的样式
    overwriteStyles: `.title { color: black }`, // 可选, 用于覆盖窗口的样式
    cursor: true, // 可选, 开启光标同步
    debug: true, // 可选, 输出日志信息
})

containerSizeRatio 为了保证窗口在不同分辨率下显示效果, 白板在相同的比例区域才能进行同步

chessboard 当挂载的区域不完全符合比例时, 白板会在挂载的 dom 中划分一个符合比例的区域出来, 此时多出来的部分会默认显示为棋盘透明背景

collector

collector 就是窗口最小化时的图标, 默认大小 width: 40px; height: 40px;

manager 上的状态

manager.mainView; // 主白板
manager.apps; // 已经打开的所有 app 的属性
manager.boxState; // 当前的窗口状态: maximized | minimized | normal

光标同步

原本的 SDK 中的 cursorAdapter 在多窗口中不可用, 如需要光标同步功能需要在 manager 中开启 cursor 选项

sdk.joinRoom({
    userPayload: {
        userId: "用户 id",
        cursorName: "光标名称",
        avatar: "用户头像链接",
    }
})

WindowManager.mount({
    cursor: true
})

APP

静态和动态 PPT 是作为 App 插入到白板, 并持久化到白板中

App 或会在页面刷新时自动创建出来, 不需要重复插入

添加静态/动态 PPT 到白板上

const appId = await manager.addApp({
  kind: BuiltinApps.DocsViewer,
  options: {
    scenePath: "/docs-viewer",
    title: "docs1", // 可选
    scenes: [], // SceneDefinition[] 静态/动态 Scene 数据
  },
});

添加音视频到白板

const appId = await manager.addApp({
  kind: BuiltinApps.MediaPlayer,
  options: {
    title: "test.mp3", // 可选
  },
  attributes: {
    src: "xxxx", // 音视频 url
  },
});

设置跟随模式

只有广播端也就是老师需要设置跟随模式, 其他端的主白板都会跟随广播端的视角

注意, manager 的 setViewMode 不能和 room.setViewMode 同时使用

manager.setViewMode("broadcaster"); // 开启跟随模式
manager.setViewMode("freedom"); // 关闭跟随模式

设置所有 app 的 readonly

manager.setReadonly(true); // 所有窗口变成 readonly 状态
manager.setReadonly(false); // 解锁设置的 readonly, 注意如果当前白板的 isWritable 为 false 以白板的状态为最高优先级

切换 mainView 为可写状态

manager.switchMainViewToWriter();

切换 mainView scenePath

切换主白板的 ScenePath 并把主白板设置为可写状态

manager.setMainViewScenePath(scenePath);

切换 mainView sceneIndex

切换主白板的 SceneIndex 并把主白板设置为可写状态

manager.setMainViewSceneIndex(sceneIndex);

获取 mainView scenePath

manager.getMainViewScenePath();

获取 mainView sceneIndex

manager.getMainViewSceneIndex();

监听 mainView 的 mode

manager.emitter.on("mainViewModeChange", (mode) => {
  // mode 类型为 ViewVisionMode
});

监听窗口最大化最小化

manager.emitter.on("boxStateChange", (state) => {
  if (state === "maximized") {
    // 最大化
  }
  if (state === "minimized") {
    // 最小化
  }
  if (state === "normal") {
    // 恢复正常
  }
});

关闭 App

manager.closeApp(appId);

手动销毁 WindowManager

manager.destroy();

开发流程

yarn build:lib

cd test

yarn dev