白板操作 · Netless

禁止操作

2.2.0 开始，该 API 可以由以下两个 API 代替:

2.9.0 该 API 已被移除

/// room.d.ts
// 禁止响应用户手势
room.disableOperations = true;
// 恢复响应用户手势
room.disableOperations = false;

2.6.0 及其更高版本支持

只读模式进入房间后，仅仅只能接收其他人同步的信息，不能操作教具、修改房间状态。以只读模式进入房间的人无法被其他人察觉，也无法出现在房间成员列表中。

想要以只读模式加入房间，可以在加入房间时添加如下参数：

whiteWebSdk.joinRoom({
    uuid: "room-uuid",
    roomToken: "room-token",
    isWritable: false, // 以只读模式加入房间
});

加入房间后，可以通过如下方法切换到只读模式：

room.setWritable(false).then(function() {
    // 成功
}).catch(function (error) {
    // 失败
});

加入房间后，可以通过如下方法切换到可写模式：

room.setWritable(true).then(function() {
    // 成功
}).catch(function (error) {
    // 失败
});

globalState目前为一个Object，开发者可以在globalState插入自己的字段，从而在整个房间中共享自己业务所需要的状态信息。

//只需要传入需要更新的字段即可，返回完整的新 GlobalState
const newGlobalState = room.setGlobalState({key: "newValue"});

globalState仅限轻量级使用，存储内容尽可能小（建议100KB以内），更新时，只传入GlobalState中需要更新的字段。

globalState中的字段不支持设置为 null，以及 undefined，如果需要设置这些，请使用空Object {} 进行替代。

2.2.0 开始，该 API 不再推荐使用。新 API 提供动画选项，详情请参考视角操作-调整视角

用户可以通过手势，放缩白板。另一方面 sdk 也支持通过 zoomChange 来缩放。

///displayer.d.ts
// room player 通用

// 与原始白板大小的比例
room.zoomChange(3);
// 获取当前缩放比例
let scale = room.state.zoomScale;

//room.d.ts
//延时 1 秒播放
room.timeDelay = 1000;
//获取白板主动延时时间
let delay = room.timeDelay;

使用 room.timeDelay 方法，可以快速设置白板延时，可以人为给白板增加一部分延时，延迟播放。

参数单位为毫秒。

该方法只对本地客户端有效。

该方法会同时影响自定义事件。

用户本地绘制，仍然会实时出现。

///room.d.ts
/**
 * 清除当前屏幕内容
 * @param retainPPT 是否保留 ppt
 */
let retainPpt = true;
room.cleanCurrentScene(retainPpt);

///room.d.ts
await room.disconnect();
//... 成功断连