与服务器时钟校准后的当前时间戳,单位为毫秒。
回调函数。你可以通过如下方式设置回调函数:
可重做次数。即此时此刻,还可以调用多少次 redo 方法。
可撤销次数。即此时此刻,还可以调用多少次 undo 方法。
该客户端的设备类型,决定 SDK 如何处理鼠标事件和触碰事件。
是否禁止用户通过触屏手势或鼠标滚轮调整视角(即移动或缩放视角):
true
:禁止用户调整视角。false
:(默认)允许用户调整视角。Note
该属性不影响 setCameraBound
、moveCamera
、moveCameraToContain
方法的使用。
是否禁止用户通过鼠标、键盘、触摸屏幕操作白板工具。
true
: 禁止用户操作白板工具。false
:允许用户操作白板工具。该方法与 isWritable
的区别详见《禁止设备操作|禁止操作》。
是否关闭橡皮擦擦除图片功能。
true
: 关闭橡皮擦擦除图片功能。false
:启用橡皮擦擦除图片功能。是否隐藏其他人的鼠标移动到白板组件上时显示的高亮框。
是否禁止本地序列化。
true
: 禁止本地序列化。false
:允许本地序列化。设置 disableSerialization(true)
后,以下方法将不生效:
redo
undo
duplicate
copy
paste
用户当前是否有写的权限:
报告抓手工具是否启用:
true
:启用抓手工具。false
:不启用抓手工具。抓手工具的快捷键。用户可以使用抓手工具拖动页面。如果设为 undefined
,表示不启用快捷键功能。
用户在当前房间是否为互动模式:
true
: 互动模式,即对白板具有读写权限。false
:订阅模式,即对白板具有只读权限。用户 ID。
ObserverMode
为 Directory
时,observerId
为被跟随的用户的用户 ID。ObserverMode
为 Freedom
时,为 AdminObserverId
。房间的连接状态,详见 RoomPhase。
数据中心。支持传入以下值:
region |
数据中心 | 服务区 |
---|---|---|
us-sv |
美国硅谷 | 北美洲、南美洲 |
sg |
新加坡 | 新加坡、东亚、东南亚 |
in-mum |
印度孟买 | 印度 |
eu |
欧洲(法兰克福) | 欧洲 |
cn-hz |
中国杭州 | 其他数据中心服务区未覆盖的地区 |
房间的 Room Token,用于加入房间时的用户鉴权。
用户的屏幕类型,用于调整手势识别参数。
房间当前 session 的 UUID。如果开启了自动日志上报功能,日志中会上报该参数。如果上报时尚未与服务器建立连接,则为 undefined
。
当前所处分片的 UUID。
房间的业务状态,详见《房间业务状态管理》。
设置本地显示远端白板内容的延时,单位为毫秒,默认值为 0。取值大于等于 0。
设置该参数后,当本地用户接收到远端白板内容后,SDK 会根据你设置的 timeDelay
的值延迟显示白板内容。
在音视频传输延时较大的场景中,如使用 CDN 推送音视频流时,你可以使用该参数延迟显示接收到的远端白板内容,以确保白板内容与音视频同步。
房间内用户的唯一标识符,字符串格式。
房间的 UUID,即房间的唯一标识符。
当前 SDK 的版本。
注册自定义事件监听。
成功注册后,你可以接收到对应的自定义事件通知。
Note
对于同名的自定义事件,SDK 仅支持触发一个回调。
想要监听的自定义事件名称。
自定义事件回调,详见 EventListener。如果添加多个同名的事件回调,则之前添加的回调会被覆盖。
自从 v2.15.2。 自定义事件监听设置选项。详见 MagixEventListenerOptions。
注册高频自定义事件监听。
成功注册后,你可以接收到对应的自定义事件通知。
Note
对于同名的自定义事件,SDK 仅支持触发一个回调。
想要监听的自定义事件名称。
自定义事件回调,详见 EventsListener。如果添加多个同名的事件回调,则之前添加的回调会被覆盖。
SDK 触发回调的频率,单位为毫秒。该参数最小值为 500 ms,如果设置为低于该值会被重置为 500 ms。
将白板绑定到 HTML 元素上。
用于容纳白板的 HTML 元素容器。若为 null
,表示解除对白板的绑定。
清理当前场景的所有内容。
是否保留 PPT 页面:
true
:(默认)保留 PPT 页面。false
:连 PPT 页面一起清空。指定图片的 UUID, 即在 insertImage 方法的 ImageInformation 中传入的图片 UUID。
图片的 URL 地址。请确保 app 客户端能够访问该 URL,否则图片无法正常展示。
转换白板上点的坐标。
该方法可以将屏幕坐标系(以屏幕左上角为原点,横轴为 X 轴,正方向向右,纵轴为 Y 轴,正方向向下) 中的坐标转换为世界坐标系(以白板初始化时的中点为原点,横轴为 X 轴,正方向向右,纵轴为 Y 轴,正方向向下) 中的坐标。
点在屏幕坐标系中的坐标。
点在屏幕坐标系上的 X 轴坐标。
点在屏幕坐标系上的 Y 轴坐标。
点在世界坐标系中的坐标。
点在世界坐标系上的 X 轴坐标。
点在世界坐标系上的 Y 轴坐标。
创建不可见插件对象。
不可见插件的类。
不可见插件的属性。
创建的不可见插件对象。
创建场景目录的监听器对象。
成功创建监听器对象后,当指定场景目录下的场景、子场景目录发生变化时,SDK 会触发你在 ScenesCallbacks 中实现的回调。 当不再需要使用已创建的监听器时,需要调用 dispose 来释放该监听器对象。
场景目录的路径。如果你传入的是场景路径,SDK 会将监听对象设置为其父场景目录。
需要监听的回调。详见 ScenesCallbacks
。
null
。方法调用失败可能是因为指定的场景目录不存在。删除选中的内容。
断开与互动白板实时房间对象的连接。
该方法会让用户离开房间,并且把与当前房间对象相关的所有资源释放掉。如果要再次加入房间,需要重新调用 joinRoom。
发送自定义事件。
Note
所有注册监听该事件的用户都会收到通知。
自定义事件的名称。
自定义事件的内容。
复制选中的内容并粘贴到白板上(用户当前视角的中心)。
Note
false
时生效。获取当前房间内所有场景的信息。
当前房间内所有场景的信息。
导出场景。
需要导出的场景路径。
导出场景内容的 Blob 对象。
生成特定场景的屏幕快照。
特定场景的路径。
用于显示屏幕快照的 div。
屏幕快照的宽度。自 2.3.8 起,该参数为可选参数,如果不填,则默认为展示屏幕快照的 div 的宽度。
屏幕快照的高度。自 2.3.8 起,该参数为可选参数,如果不填,则默认为展示屏幕快照的 div 的高度。
生成特定场景的截图。
特定场景的路径。
截图的宽度。
截图的高度
截图的 URL 地址。
Note
如果场景中展示了图片或动态 PPT 幻灯片,请确保该图片或 PPT 幻灯片的存储服务器支持跨域资源共享;否则,生成的截图中可能不会显示该图片或 PPT 幻灯片。
获取指定的不可见插件。
不可见插件的类型。
指定的不可见插件。
获取组件插件对象的属性。
组件插件对象在房间内的唯一标识符。
获取组件插件对象在白板上的位置信息。
组件插件对象在房间内的唯一标识符。
组件插件对象的矩形。
获取指定场景的信息。
场景的路径。请确保场景路径以 /
开头,并且由场景目录和场景名构成,例如,/math/classA
。
场景信息。详见 WhiteScene。
导入场景。
场景要导入的场景目录。确保该场景目录的 ScenePathType 不为 conflict
;否则,场景将无法导入。
你可以通过 scenePathType 查询路径类型。
场景内容的 Blob 对象。
方法调用成功后,返回 SceneDefinition 对象,其中包含导入场景的 name
。导入场景的路径即为 dir
+ name
。
如果需要修改场景路径,可以调用 moveScene。
插入图片占位符。
SDK 会根据你传入的 imageInfo
在白板上设置并插入图片占位符。
调用该方法后,还需要调用 completeImageUpload 传入图片的 URL 地址,以在该占位符插入并展示图片。
图片信息,详见 ImageInformation。
在白板中插入组件插件对象。
组件插件的类型,是组件的唯一标识符。
组件插件的描述。
组件插件对象在房间内的唯一标识符。
在指定位置插入文字。
第一个文字左侧边的中点在世界坐标系中的 X 轴坐标。
第一个文字左侧边的中点在世界坐标系中的 Y 轴坐标。
初始的文字内容,不传则为空。
文字的标识符,字符串格式。
锁定图片。
图片被锁定后,用户无法移动或缩放图片。
指定图片的 UUID。
是否锁定图片:
true
: 锁定。false
: 不锁定。锁定选中图片。
是否锁定图片:
获取房间内指定用户的白板工具状态。
指定用户的 ID。
指定用户的白板工具状态。
调整视角。
视角的参数配置,详见 Camera。
调整视角,以保证完整显示视觉矩形。
视觉矩形的参数设置,详见 Rectangle。
移动场景。
成功移动场景后,场景路径也会改变。
需要移动的场景的原路径。必须为场景路径,不能是场景目录的路径。
目标场景目录的路径或目标场景的路径:
targetPath
设置为目标场景目录时,表示将指定场景移至其他场景目录中,场景路径会发生改变,但是场景名称不变。targetPath
设置为目标场景路径时,表示改变指定场景在当前场景目录的位置,场景路径和场景名都会发生改变。移动选中的组件到底层。
移动选中的组件到顶层。
粘贴复制的内容。
Note
false
时生效。播放动态 PPT 下一页。
当前 PPT 页面的动画已全部执行完成时,SDK 会将场景切换至下一页 PPT。
返回动态 PPT 上一页。
当前 PPT 页面的动画全部回退完成时,SDK 会将场景切回至上一页 PPT。
指定场景目录的地址,必须以 /
开头,不能为场景路径。
由多个场景构成的数组。单个场景的字段详见 SceneDefinition。
待插入的多个场景中,第一个场景在该场景目录的索引号。场景的索引号从 0 开始。
剩余的可重做次数。
刷新白板的界面。
当白板的 view 发生改变时,需要手动调用该方法刷新白板的界面。
该方法仅在 autoResize
为 false
时生效。
移除自定义事件监听。
想要移除监听的自定义事件名称。
要移除的监听。若不传,该自定义事件之下的所有监听器将全部注销。
删除组件插件对象。
组件插件对象在房间内的唯一标识符。
删除场景或者场景目录。
Note
/init
初始场景(房间初始化时的默认场景)。dirA
,SDK 会执行向上递归逻辑选择新的场景作为当前场景,规则如下:dirB
,排在被删除的场景目录 dirA
后面,则将场景切换至
dirB
中的第一个场景(index 为 0)。dirA
后不存在场景目录,则查看当前场景目录路径下是否存在场景;
如果存在,则将场景切换至当前场景目录路径下的第一个场景(index 为 0)。dirA
后没有场景目录,也不存在任何场景,则查看 dirA
前面是否存在场景目录 dirC
;如果存在,则选择 dirC
中的第一个场景(index 为 0)。场景路径或场景目录路径。如果传入的是场景目录,则会删除该场景目录下的所有场景。
根据指定的动画模式调整视角,以保证完整显示 PPT 的内容。
视角调整时的动画模式,详见 AnimationMode。
查询场景路径类型。
场景的路径。请确保场景路径以 /
开头,并且由场景目录和场景名构成,例如,/math/classA
。
场景路径的类型。
生成特定场景的预览图。
特定场景的路径。
用于显示预览内容的 div。
预览图的宽度。自 2.3.8 起,该参数为可选参数,如果不填,则默认为展示预览内容的 div 的宽度。
预览图的高度。自 2.3.8 起,该参数为可选参数,如果不填,则默认为展示预览内容的 div 的高度。
生成屏幕快照,并写入指定的 CanvasRenderingContext2D 对象中。
CanvasRenderingContext2D 对象。
场景的路径。
屏幕快照的宽度。
屏幕快照的高度。
视角的描述。
设备像素比。该参数为可选参数,如果不填,则默认值为 1。
设置用户的视角边界。
视角边界。
修改互动白板实时房间的公共全局状态(globalState
属性)。
实时房间的 globalState
属性为公共全局变量,房间内所有用户看到的都是相同的 globalState
,所有互动模式用户都可以读写。修改 globalState
属性会立即生效并同步给所有用户。
你可以通过如下方法修改该属性:
房间公共全局状态。
修改后的房间公共全局状态。
需要修改的白板工具状态,详见 MemberState。
修改后的白板工具状态,
切换至当前场景目录下的指定场景。
方法调用成功后,房间内的所有用户看到的白板都会切换到指定场景。
Note
指定的场景必须在当前场景目录中,否则方法调用会失败。
目标场景在当前场景目录下的索引号。
切换至指定的场景。
该方法调用成功后,房间内的所有用户看到的白板都会切换到指定场景。
Note
该方法为同步调用。
场景切换失败可能有以下原因:
想要切换到的场景路径。请确保场景路径以 "/" 开头并且由场景目录和场景名构成,如 /math/classA
。
设置用户在房间中是否为互动模式。
用户在房间中是否为互动模式:
true
:互动模式,即具有读写权限。false
:订阅模式,即具有只读权限。取消 syncBlockTimestamp 方法设置的本地显示远端白板内容的时间。
设置本地显示远端白板内容的 Unix 时间戳(ms)。
远端白板内容在本地显示的 Unix 时间戳,单位为毫秒。
剩余的可撤销次数。
修改组件插件对象的描述。
组件插件对象在房间内的唯一标识符。
组件插件对象的新描述。
修改当前被选中文字的字体样式。
选中文字后,你可以调用该方法修改字体大小、颜色、是否加粗、是否斜体等样式。
修改后的字体样式。详见 TextFormat。
修改指定文字的内容。
调用 insertText 方法后,你可以调用该方法并传入 insertText
方法返回的 Identifier
,修改指定文字的内容。
文字的标识符,为 insertText 的返回值。
修改后的文字内容。
等待特定的自定义事件发生。
事件过滤器。
当特定自定义事件发生时,返回该事件。
Room
接口继承了Displayer
接口,并且增加了用于操作互动白板实时房间的属性。