回放的起始时间(Unix 时间戳,单位为毫秒)。
回调函数。你可以通过如下方式设置回调函数:
该客户端的设备类型,决定 SDK 如何处理鼠标事件和触碰事件。
是否禁止用户通过触屏手势或鼠标滚轮调整视角(即移动或缩放视角):
true
:禁止用户调整视角。false
:(默认)允许用户调整视角。Note
该属性不影响 setCameraBound
、moveCamera
、moveCameraToContain
方法的使用。
是否隐藏其他人的鼠标移动到白板组件上时显示的高亮框。
用户当前是否有写的权限:
回放的总帧数。
报告抓手工具是否启用:
true
:启用抓手工具。false
:不启用抓手工具。抓手工具的快捷键。用户可以使用抓手工具拖动页面。如果设为 undefined
,表示不启用快捷键功能。
是否能立即播放(可能会缓冲)。
用户 ID。
ObserverMode
为 Directory
时,observerId
为被跟随的用户的用户 ID。ObserverMode
为 Freedom
时,为 AdminObserverId
。回放的阶段,详见 PlayerPhase。
回放的播放倍速。取值必须大于 0
,设为 1
表示按原速播放。
回放的进度,单位为毫秒。录像开始时为 0
。
数据中心。支持传入以下值:
region |
数据中心 | 服务区 |
---|---|---|
us-sv |
美国硅谷 | 北美洲、南美洲 |
sg |
新加坡 | 新加坡、东亚、东南亚 |
in-mum |
印度孟买 | 印度 |
eu |
欧洲(法兰克福) | 欧洲 |
cn-hz |
中国杭州 | 其他数据中心服务区未覆盖的地区 |
回放录像所属房间的 UUID。
用户的屏幕类型,用于调整手势识别参数。
当前录像所属分片的 UUID。
回放的状态,详见 PlayerState。
回放的总时长,单位为毫秒。
当前 SDK 的版本。
注册自定义事件监听。
成功注册后,你可以接收到对应的自定义事件通知。
Note
对于同名的自定义事件,SDK 仅支持触发一个回调。
想要监听的自定义事件名称。
自定义事件回调,详见 EventListener。如果添加多个同名的事件回调,则之前添加的回调会被覆盖。
自从 v2.15.2。 自定义事件监听设置选项。详见 MagixEventListenerOptions。
注册高频自定义事件监听。
成功注册后,你可以接收到对应的自定义事件通知。
Note
对于同名的自定义事件,SDK 仅支持触发一个回调。
想要监听的自定义事件名称。
自定义事件回调,详见 EventsListener。如果添加多个同名的事件回调,则之前添加的回调会被覆盖。
SDK 触发回调的频率,单位为毫秒。该参数最小值为 500 ms,如果设置为低于该值会被重置为 500 ms。
将白板绑定到 HTML 元素上。
用于容纳白板的 HTML 元素容器。若为 null
,表示解除对白板的绑定。
转换白板上点的坐标。
该方法可以将屏幕坐标系(以屏幕左上角为原点,横轴为 X 轴,正方向向右,纵轴为 Y 轴,正方向向下) 中的坐标转换为世界坐标系(以白板初始化时的中点为原点,横轴为 X 轴,正方向向右,纵轴为 Y 轴,正方向向下) 中的坐标。
点在屏幕坐标系中的坐标。
点在屏幕坐标系上的 X 轴坐标。
点在屏幕坐标系上的 Y 轴坐标。
点在世界坐标系中的坐标。
点在世界坐标系上的 X 轴坐标。
点在世界坐标系上的 Y 轴坐标。
创建场景目录的监听器对象。
成功创建监听器对象后,当指定场景目录下的场景、子场景目录发生变化时,SDK 会触发你在 ScenesCallbacks 中实现的回调。 当不再需要使用已创建的监听器时,需要调用 dispose 来释放该监听器对象。
场景目录的路径。如果你传入的是场景路径,SDK 会将监听对象设置为其父场景目录。
需要监听的回调。详见 ScenesCallbacks
。
null
。方法调用失败可能是因为指定的场景目录不存在。获取当前房间内所有场景的信息。
当前房间内所有场景的信息。
生成特定场景的屏幕快照。
特定场景的路径。
用于显示屏幕快照的 div。
屏幕快照的宽度。自 2.3.8 起,该参数为可选参数,如果不填,则默认为展示屏幕快照的 div 的宽度。
屏幕快照的高度。自 2.3.8 起,该参数为可选参数,如果不填,则默认为展示屏幕快照的 div 的高度。
生成特定场景的截图。
特定场景的路径。
截图的宽度。
截图的高度
截图的 URL 地址。
Note
如果场景中展示了图片或动态 PPT 幻灯片,请确保该图片或 PPT 幻灯片的存储服务器支持跨域资源共享;否则,生成的截图中可能不会显示该图片或 PPT 幻灯片。
获取指定的不可见插件。
不可见插件的类型。
指定的不可见插件。
获取指定场景的信息。
场景的路径。请确保场景路径以 /
开头,并且由场景目录和场景名构成,例如,/math/classA
。
场景信息。详见 WhiteScene。
获取房间内指定用户的白板工具状态。
指定用户的 ID。
指定用户的白板工具状态。
调整视角。
视角的参数配置,详见 Camera。
调整视角,以保证完整显示视觉矩形。
视觉矩形的参数设置,详见 Rectangle。
暂停白板回放。
开始白板回放。
暂停回放后,可以调用该方法继续回放。
刷新白板的界面。
当白板的 view 发生改变时,需要手动调用该方法刷新白板的界面。
该方法仅在 autoResize
为 false
时生效。
移除自定义事件监听。
想要移除监听的自定义事件名称。
要移除的监听。若不传,该自定义事件之下的所有监听器将全部注销。
根据指定的动画模式调整视角,以保证完整显示 PPT 的内容。
视角调整时的动画模式,详见 AnimationMode。
查询场景路径类型。
场景的路径。请确保场景路径以 /
开头,并且由场景目录和场景名构成,例如,/math/classA
。
场景路径的类型。
生成特定场景的预览图。
特定场景的路径。
用于显示预览内容的 div。
预览图的宽度。自 2.3.8 起,该参数为可选参数,如果不填,则默认为展示预览内容的 div 的宽度。
预览图的高度。自 2.3.8 起,该参数为可选参数,如果不填,则默认为展示预览内容的 div 的高度。
生成屏幕快照,并写入指定的 CanvasRenderingContext2D 对象中。
CanvasRenderingContext2D 对象。
场景的路径。
屏幕快照的宽度。
屏幕快照的高度。
视角的描述。
设备像素比。该参数为可选参数,如果不填,则默认值为 1。
跳转到指定回放位置。
指定的回放位置,单位为毫秒。
定位回放的结果。详见 PlayerSeekingResult。
设置用户的视角边界。
视角边界。
设置白板回放的观看模式。
白板回放的观看模式,详见 ObserverMode。
停止白板回放。
白板回放停止后,Player
资源会被释放。如果想要重新播放,需要重新初始化 Player
对象。
等待特定的自定义事件发生。
事件过滤器。
当特定自定义事件发生时,返回该事件。
Player
接口继承Displayer
接口,并且增加用于操作白板回放的属性。