主播模式用户的用户 ID。若没有主播模式的用户,则为 undefined
。
用户的视角模式。
视角的描述。
视角的中心点在世界坐标系(以白板初始化时的中心点为原点的坐标系)中的 X 轴坐标。
视角的中心点在世界坐标系(以白板初始化时的中心点为原点的坐标系)中的 Y 轴坐标。
视角的缩放比例。
CameraBound
类型用于设置视角边界。
视角边界是白板上用户可以看见的部分。在视角边界内,用户可以自由移动和缩放视角。视角如果超出了视角边界的范围,会被 SDK 拉回视角边界内。
视角边界的中心点在世界坐标系(以白板初始化时的中心点为原点的坐标系)中的 X 轴坐标,默认值是 0.0。
视角边界的中心点在世界坐标系(以白板初始化时的中心点为原点的坐标系)中的 Y 轴坐标,默认值是 0.0。
用户将视角移出视角边界时感受到的阻力大小。取值范围为 [0.0,1.0],默认值为 0.75。取值越大,用户感受到的阻力越大。
0.0
: 用户将视角移出视角边界时,完全感受不到阻力,但当其手指离开屏幕时,视角会恢复到原位。1.0
: 用户完全无法将视角移出视角边界。视角边界的高度,单位为像素。默认值是 Infinity
,表示没有限制。
视角边界的最大缩放比例。如果不填,则表示视角缩放没有上限。
视角边界的最小缩放比例。如果不填,则表示视角缩放没有下限。
视角边界的宽度,单位为像素。默认值是 Infinity
,表示没有限制。
颜色,RGB 格式。例如, [0, 0, 255]
代表蓝色。
设置视角边界,即用户可以自由移动视角的范围。默认值为 undefined
,表示视角没有任何限制。
设置鼠标的光标适配器,详见 《鼠标光标适配器》。
是否关闭自动适配尺寸功能。
true
:关闭自动适配尺寸功能。关闭后,如果视角的尺寸发生改变,必须主动调用 refreshViewSize
来保证适配。false
:(默认)启用自动适配尺寸功能。是否禁止用户通过触屏手势或鼠标滚轮移动或缩放调整视角。
true
:禁止用户调整视角。false
:(默认)允许用户调整视角。该属性不会影响 setCameraBound
、moveCamera
、moveCameraToContain
方法的使用。
是否隐藏其他人的鼠标移动到白板组件上时显示的高亮框。
不可见插件列表。
由 React.ComponentType
类型组成的数组,用于自定义包装白板的界面。默认值为 []。
实时缩放比例。
调用查询转换任务的进度接口时,服务端返回的 HTTP 响应内容。
转换失败的原因。
转换任务的进度详情。
转换任务的状态。
转换任务的类型。
转换任务的 UUID,即转换任务的唯一识别符。
转换后生成的图片或动态 PPT 页。
图片的 URL 地址或动态 PPT 页的 URI 地址。
图片或动态 PPT 页在白板中的高度,单位为像素。
图片或动态 PPT 预览图的 URL 地址。
图片或动态 PPT 页在白板中的宽度,单位为像素。
光标的描述。
光标图形的高。
光标图形的宽。
光标指示区域中心的 X 轴坐标(以光标图形的左上角为原点)。
光标指示区域中心的 Y 轴坐标(以光标图形的左上角为原点)。
Displayer
对象的回调。
同步用户行为发生错误的回调。
该用户的用户 ID。
错误信息。
渲染发生错误回调。
错误信息。
用户的可写权限发生改变的回调。
用户当前是否有写的权限:
true
:有写的权限。false
:没有写的权限。抓手工具的启用状态发生改变的回调。
抓手工具是否启用:
true
:启用。false
:不启用。暂停播放动态 PPT 中媒体文件的回调。
插入媒体文件的 shape 对象的 ID。
媒体文件的类型。
播放动态 PPT 中媒体文件的回调。
插入媒体文件的 shape 对象的 ID。
媒体文件的类型。
动态 PPT 中的媒体文件播放出错回调。
插入媒体文件的 shape 对象的 ID。
媒体文件的类型。
错误提示。
渲染时长回调。
渲染时长。
所处分片发生改变的回调。
所处分片的 UUID。
DisplayerState
是 Room
对象和 Player
对象共有的类型。
当前视角的状态。
房间的全局状态。详见 GlobalState。
房间内所有互动模式(具有读写权限)用户的状态。
当前场景的状态。
自定义事件。
事件触发者的用户 ID,若是系统事件,则为 AdminObserverId。
自定义事件的名称。
自定义事件的内容。
自定义事件的状态。
自定义事件的范围。
事件过滤器。
事件监听器。
事件组监听器。
悬浮条的配置参数。
悬浮条调色盘的颜色列表。
实时房间的公共全局变量。
房间内所有用户看到的都是相同的 globalState
,所有互动模式用户都可以读写。修改 globalState
属性会立即生效并同步给所有用户。
自定义快捷键。
快捷键检查器。
自定义快捷键的描述。
是否使用 Alt 键。
是否使用 Ctrl 键。 C
指定的键。
是否使用 Shift 键。
自定义快捷键的事件。
是否使用 Alt 键。
是否使用 Ctrl 键。
指定的键。
快捷键的事件类型。
KeyDown
:键被按下。KeyUp
:键被松开。浏览器的原生事件。
是否使用 Shift 键。
快捷键对应的效果。
切换到箭头工具(arrow
)。
切换到点选工具 (clicker
)。
切换到椭圆工具(ellipse
)。
切换到橡皮工具(eraser
)。
切换到抓手工具(hand
)。
切换到激光笔(laserPointer
)。
切换到铅笔工具(pencil
)。
切换到矩形工具(rectangle
)。
切换到选择工具(selector
)。
切换到直线工具(straight
)。
切换到文字工具(text
)。
复制。
删除。
复制并粘贴。
锁定缩放比例。
粘贴。
重做。
撤回。
组件插件的唯一标识符。
图片的描述。
图片的中心在世界坐标系(以白板初始化时的中心点为原点的坐标系)中的 X 轴坐标。
图片的中心在世界坐标系(以白板初始化时的中心点为原点的坐标系)中的 Y 轴坐标。
图片的高度,单位为像素。如果图片的高度超出视角的边界,用户将看不到超出部分。
图片是否被锁定。
true
: 图片被锁定。锁定一张图片后,用户无法移动或缩放该图片。false
: 图片没有被锁定。图片是否只能等比放缩。
图片的 UUID,即图片在互动白板实时房间中的唯一标识符。
图片的宽度,单位为像素。如果图片的宽度超出视角的边界,用户将看不到超出部分。
International
类,用于添加 PPT 预览菜单栏的界面文字。你可以直接传入要展示的文字,例如 “Next”。
“显示 PPT 备注”的界面文字。
“显示侧边栏”的界面文字。
“隐藏 PPT 备注”的界面文字。
“隐藏侧边栏”的界面文字。
“跳转到”的界面文字。
“下一页”的界面文字。
“下一步”的界面文字。
“页码”的界面文字。
“上一页”的界面文字。
“上一步”的界面文字。
“重置当前 PPT 文件的动画”的界面文字。
“重置当前 PPT 页的动画”的界面文字。
不可见插件的回调事件。
不可见插件属性更新的回调。
更新的插件属性。
删除不可见插件的回调。
不可见插件。
插件的类型。
创建插件对象的回调。
创建的插件对象。
删除插件对象的回调。
删除的插件对象。
不可见插件的上下文。
不可见插件的 Displayer
对象。
不可见插件的类型。
Room 对象的参数设置,用于加入互动白板实时房间。该类型继承 ConstructRoomParams 且包含以下属性:
uuid: string
房间的 UUID,即房间的唯一标识符。成功创建房间后会返回该属性。
uid: string
用户的 UID,即用户的唯一标识符,字符串格式,不能超过 1024 字节。请确保同一房间内每个用户 uid
的唯一性。
region?: string
连接的数据中心,支持传入以下值:
region |
数据中心 | 服务区 |
---|---|---|
us-sv |
美国硅谷 | 北美洲、南美洲 |
sg |
新加坡 | 新加坡、东亚、东南亚 |
in-mum |
印度孟买 | 印度 |
eu |
欧洲(法兰克福) | 欧洲 |
cn-hz |
中国杭州 | 其他数据中心服务区未覆盖的地区 |
Note
region
作用相同,二者只需要设置其中一个。如果同时设置,该属性会覆盖 WhiteWebSdkConfiguration
中的 region
。roomToken: string
房间的 Room Token,用于加入房间时的用户鉴权。详见互动白板 Token 概述。
userPayload?: {[key: string]: any;}
自定义用户信息。该属性可以是任意类型的数据结构。
房间内其他用户可以通过如下代码读取特定用户在加入房间时设置的 userPayload
:
日志等级。
日志的配置参数。
日志打印等级,详见 Level。默认等级为 info
。
SDK 上报 debug
等级日志的模式。
日志上报等级,详见 Level。
SDK 上报连接质量数据的模式。
自定义事件监听选项。
SDK 触发自定义事件回调的间隔,单位为毫秒,默认值为 500。取值必须 ≥ 500。
SDK 会根据该参数的值周期性触发自定义事件回调。
设置是否待服务器确认 dispatchMagixEvent 方法调用成功后再发送事件回调:
空白区域的设置。
下方的空白,单位为像素。
左边的空白,单位为像素。
右边的空白,单位为像素。
上方的空白,单位为像素。
媒体文件的类型。
video
:视频文件。audio
:音频文件。自定义用户信息。
互动白板实时房间的白板工具状态。
是否加粗:
true
:加粗。false
:(默认)不加粗。当前使用的白板工具名称,详见 ApplianceNames。
是否支持绘制虚线(仅限铅笔工具):
true
:支持绘制虚线。false
:(默认)不支持绘制虚线。是否使用斜体:
true
:使用斜体。false
:(默认)不使用斜体。是否加删除线:
true
:加删除线。false
:(默认)不加删除线。绘制图形的类型。
绘制线条的颜色,为 RGB 格式,例如 [0, 0, 255]
表示蓝色。
绘制线条的粗细。
是否允许直接选择并编辑文字:
true
:允许直接选择并编辑文字。false
:(默认)不允许直接选择并编辑文字。字体颜色,为 RGB 格式,例如 [0, 0, 255]
表示蓝色。
字体大小,取值必须大于 0。Chrome 浏览器对于小于 12 的字体会自动调整为 12。
是否加下划线:
true
:加下划线。false
:(默认)不加下划线。浏览器的原生事件。
MouseEvent
:鼠标事件,详见 MouseEvent。WheelEvent
:滚轮事件,详见 WheelEvent。KeyboardEvent
:键盘事件,详见 KeyboardEvent。TouchEvent
:触摸事件,详见 TouchEvent。文档转换生成的图片或动态 PPT 页的描述。
图片或动态 PPT 页的高。
文档转换任务的类型。
图片或动态 PPT 页的场景列表。
文档转换任务的 UUID,即转换任务的唯一识别符。
图片或动态 PPT 页的宽。
文档转换任务的回调。
转换进度更新回调。
进度详情。
转换任务失败回调。
发生的错误。
PPTTask
对象的参数。
转换任务的回调函数。
轮询转换任务状态的时间间隔(毫秒)。
轮询的超时时间(毫秒)。
转换任务的类型。
处理该转换任务的数据中心。支持传入以下值:
region |
数据中心 | 服务区 |
---|---|---|
us-sv |
美国硅谷 | 北美洲、南美洲 |
sg |
新加坡 | 新加坡、东亚、东南亚 |
in-mum |
印度孟买 | 印度 |
eu |
欧洲(法兰克福) | 欧洲 |
cn-hz |
中国杭州 | 其他数据中心服务区未覆盖的地区 |
转换任务的 Task Token,用于文件转换任务的鉴权。
转换任务的 UUID,即转换任务的唯一识别符。
文档转换任务的进度详情。
已转换的页数。
转换进度(百分比)。
转换任务当前的步骤。
转换任务的状态。
待转换的总页数。
检查白板房间是否可以回放的参数配置。
回放的起始时间(单位为毫秒的 Unix 时间戳)。
该属性必须和 room
、duration
一起使用,而且使用时禁止传入 slice
。
回放的时长(毫秒)。
该属性必须和 room
、beginTimestamp
一起使用,而且使用时禁止传入 slice
。
当前房间所在的数据中心,支持传入以下值:
region |
数据中心 | 服务区 |
---|---|---|
us-sv |
美国硅谷 | 北美洲、南美洲 |
sg |
新加坡 | 新加坡、东亚、东南亚 |
in-mum |
印度孟买 | 印度 |
eu |
欧洲(法兰克福) | 欧洲 |
cn-hz |
中国杭州 | 其他数据中心服务区未覆盖的地区 |
房间的 UUID,即房间的唯一标识符。成功创建房间后会返回该值。
beginTimestamp
和 duration
,则表明回放该房间的所有录像片段。beginTimestamp
、duration
,则表明回放该房间在对应时间范围内的所有录像片段。房间的 Room Token,用于加入房间时的用户鉴权。详见互动白板 Token 概述。
回放的录像片段的 UUID。你可以在房间录制的时候从 room.slice
获取。
Note
room
同时传入。beginTimestamp
和 duration
。PlayerCallbacks
包含白板回放的事件回调。该类型继承 DisplayerCallbacks 且包含以下成员:
onIsPlayableChanged: (isPlayable: boolean)=>void
isPlayable
发生改变的回调。
Player
对象的状态。该类型继承 DisplayerState 且包含以下成员:
白板回放的观看模式,详见 ObserverMode。
组件插件的描述。Agora 支持的自定义插件包括组件插件和不可见插件。
属性的默认值。
碰撞检测。你可以通过碰撞检测定义组件插件可以被选择工具选中的区域。
组件插件对象。
可选中区域的中心点的 X 轴坐标。
可选中区域的中心点的 Y 轴坐标。
可选中区域的半径。
碰撞检测的结果:
true
:检测成功。false
:检测失败。组件插件的类型,即该组件插件的唯一识别符。
组件插件的外观。
设置是否拦截该组件插件的原生事件。
组件插件对象。
原生事件。
是否拦截该组件插件的原生事件:
true
:拦截。false
:不拦截。组件插件对象的描述。
组件插件对象的属性。
组件插件对象的高。
组件插件对象的左上角在世界坐标系(以白板初始化时的中心点为原点的坐标系)中的 X 轴坐标。
组件插件对象的左上角在世界坐标系(以白板初始化时的中心点为原点的坐标系)中的 Y 轴坐标。
能否选中组件插件对象:
true
:能选中。false
:不能选中。组件插件对象的宽。
组件插件的外观设置。
组件插件图标周围的空白。
组件插件图标的中心点在世界坐标系中(以白板初始化时的中心点为原点的坐标系)的坐标。
组件插件对象。
组件插件图标的缩放比例。
组件插件图标的大小。
世界坐标系(以白板初始化时的中心点为原点的坐标系)的点坐标。
点在世界坐标系中的 X 轴坐标。
点在世界坐标系中的 Y 轴坐标。
图片或动态 PPT 页的描述。
你可以在初始化 WhiteScene
时配置 PptDescription
,以在白板上插入图片或动态 PPT。
支持的图片或动态 PPT 格式包括:
Note
图片或动态 PPT 在白板中的高度,单位为像素。
图片或动态 PPT 预览图的 URL 地址。动态 PPT 预览图的 URL 地址可以从文档转换任务的查询结果中的 preview
字段获取,例如,"https://docs-test-xxx.oss-cn-hangzhou.aliyuncs.com/dynamicConvert/2fdxxxxx67e/preview/1.png"。
图片或动态 PPT 页的地址,支持的格式如下:
"https://docs-test-xxx.oss-cn-hangzhou.aliyuncs.com/staticConvert/2fdxxxxx67e/1.jpeg"
。"pptx://cover.herewhite.com/dynamicConvert/6a212c90fa5311ea8b9c074232aaccd4/1.slide"
,即动态文档转换任务的查询结果中 conversionFileUrl
字段的值。图片或动态 PPT 在白板中的宽度,单位为像素。
动态 PPT 文件的参数设置。
PPT 预览页面的配置。
给预览页面的菜单栏添加界面文字。详见 International。
文档转换任务的进度详情。
转换后生成的图片或动态 PPT 页。
已转换的页数。
转换进度的百分比。
转换任务当前的步骤。
总页数。
AgoraRTCClient
类用于桥接 Agora RTC SDK 的混音方法和白板 SDK。
当用户同时使用音视频功能和互动白板,且在互动白板中展示的动态 PPT 包含音频文件时,可能遇到以下问题:
为解决上述问题,你可以使用 AgoraRTCClient
类调用 Agora RTC SDK 的混音方法播放动态 PPT 中的音频文件。
Note
目前仅支持 Electron 平台的 Agora RTC SDK.
调节音乐文件的本地播放音量。
音乐文件在本端播放的音量。取值范围为 0 到 100 间的整数,默认为 100,即保持原始文件音量。
调节音乐文件的远端播放音量。
音乐文件在远端播放的音量。取值范围为 0 到 100 间的整数,默认为 100,即保持原始文件音量。
调节音乐文件的播放音量。
该方法调节混音里伴奏在本端和远端播放的音量。
伴奏在本端和远端播放的音量。取值范围为 0 到 100 间的整数,默认为 100,即保持原始文件音量。
获取音乐文件的播放进度。
获取指定音乐文件的总时长。
获取音乐文件的本地播放音量。
获取音乐文件的远端播放音量。
暂停播放音乐文件及混音。
恢复播放音乐文件及混音。
设置音乐文件的播放位置。
该方法可以设置音频文件的播放位置,这样你可以根据实际情况播放文件,而不是非得从头到尾播放一个文件。
设置的播放位置,单位为毫秒,取值必须为整数。
开始播放音乐文件及混音。
指定需要混音的本地或在线音频文件的绝对路径。
是否只有本地用户可以听到混音后的音频流:
true
:只有本地可以听到混音的音频流。false
:本地和对方都可以听到混音的音频流。是否播放麦克风采集的音频:
true
: 只播放音频文件,不播放麦克风采集的音频。false
: 将音频文件和麦克风采集的音频混音后播放。音乐文件的播放次数。
0
表示不播放;1
表示播放 1
次。开始播放音乐文件及混音的回调。其中 state: number
为音乐文件及混音的播放状态,
errorCode: number
为错误码。
开始播放音乐文件及混音的回调。其中 state: number
为音乐文件及混音的播放状态,
errorCode: number
为错误码。
停止播放音乐文件及混音。
停止播放音乐文件及混音的回调。其中 state: number
为音乐文件及混音的播放状态,
errorCode: number
为错误码。
停止播放音乐文件及混音的回调。其中 state: number
为音乐文件及混音的播放状态,
errorCode: number
为错误码。
断线重连设置。
是否关闭断线重连:
true
: 关闭断线重连。false
: 开启断线重连。视觉矩形的描述。该类继承 Size 且包含以下成员:
originX: number
视觉矩形左上角原点在世界坐标系(以白板初始化时的中心点为原点的坐标系)中的 X 轴坐标。
originY: number
视觉矩形左上角原点在世界坐标系(以白板初始化时的中心点为原点的坐标系)中的 Y 轴坐标。
组件插件的渲染。
组件插件属性的默认值。
碰撞检测。你可以通过碰撞检测定义组件插件可以被选择工具选中的区域。
组件插件对象。
可选中区域的中心点的 X 轴坐标。
可选中区域的中心点的 Y 轴坐标。
可选中区域的半径。
碰撞检测的结果:
true
:检测成功。false
:检测失败。组件插件类型,为该组件插件的唯一识别符。
组件插件的外观。
设置是否拦截该组件插件的原生事件。
组件插件对象。
原生事件。
是否拦截该组件插件的原生事件:
true
:拦截。false
:不拦截。Player
对象的参数配置,用于白板回放。该类型继承 ConstructRoomParams 且增加以下属性:
region?: string
Player
对象所在的数据中心。支持传入以下值:
region |
数据中心 | 服务区 |
---|---|---|
us-sv |
美国硅谷 | 北美洲、南美洲 |
sg |
新加坡 | 新加坡、东亚、东南亚 |
in-mum |
印度孟买 | 印度 |
eu |
欧洲(法兰克福) | 欧洲 |
cn-hz |
中国杭州 | 其他数据中心服务区未覆盖的地区 |
Note
region
的值。WhiteWebSdk
对象和创建 Player
对象时都没有设置数据中心,SDK 会报错。slice?: string
回放的录像片段的 UUID。你可以在房间录制的时候从 room.slice
获取。
Note
该属性需要和 room
同时传入。
传入该属性表明只回放特定片段,因此禁止再传入 beginTimestamp
和 duration
。
room: string
回放房间的 UUID,即房间的唯一标识符。成功创建房间后会返回该值。
beginTimestamp
和 duration
,则表明回放该房间的所有录像片段。beginTimestamp
和 duration
,则表明回放该房间在对应时间范围内的所有录像片段。roomToken: string
房间的 Room Token,用于加入房间时的用户鉴权。详见互动白板 Token 概述。
beginTimestamp?: number
白板回放的起始时间(单位为毫秒的 Unix 时间戳)。
该属性必须和 room
、duration
一起使用,而且使用时禁止传入 slice
。
duration?: number
白板回放的时长(毫秒)。
该属性必须和 room
、beginTimestamp
一起使用,而且使用时禁止传入 slice
。
RoomCallbacks
包含白板房间的事件回调。该类型继承 DisplayerCallbacks 并增加以下成员:
onPhaseChanged: (phase: RoomPhase)=>void
房间连接状态发生变化的回调。
实时房间内互动模式(具有读写权限)用户的信息。
用户 ID。
在用户加入互动白板实时房间时,会自动分配用户 ID,用于标识房间内的用户。同一房间中的每个用户具有唯一的用户 ID。
用户所有的白板工具状态,详见 MemberState。
自定义用户信息,在用户加入房间时传入。详见 UserPayload。
当前的 session ID。
互动白板实时房间的所有状态。该类继承 DisplayerState 且包含以下成员:
memberState: MemberState
当前使用的白板工具,详见 MemberState。
broadcastState: Readonly
当前的视角状态。
场景定义。
场景名称。
在场景中展示的图片或动态 PPT。每个场景中可以展示一张图片或一页动态 PPT,你可以通过 PptDescription
设置待插入图片或动态 PPT 的宽、高、资源地址或预览图等。详见 PptDescription。
场景列表。
某一场景目录下的所有场景。
场景状态。
当前场景所属场景目录的路径。
当前场景在所属场景目录中的索引号。
当前场景的名称。
当前场景的路径。
当前场景目录下所有场景的列表。
场景回调。
新增场景回调。
新增子场景目录回调。
删除场景回调。
删除子场景目录回调。
指定场景目录下场景数量发生变化回调。
指定场景目录下子场景目录数量发生变化回调。
尺寸大小。
高度。
宽度。
字体样式。
是否加粗:
true
:加粗。false
:(默认)不加粗。颜色,RGB 格式。例如,[0, 0, 255]
代表蓝色。
字体大小,取值必须大于 0。
是否使用斜体:
true
:使用斜体。false
:(默认)不使用斜体。是否加删除线:
true
:加删除线。false
:(默认)不加删除线。是否加下划线:
true
:加下划线。false
:(默认)不加下划线。用户自定义图标。
自定义字体。
key-value
键值对,key
为字体名称,value
为字体的 URL 地址,例如 "Calibri": "https://your-cdn.com/Calibri.ttf"
。
自定义用户信息。
[key: string]: any
key-value 结构的自定义用户信息,例如,"avatar", "https://example.com/user.png"
。
uid: string
用户标识,字符串格式,不能超过 1024 字节。
请确保同一房间内每个用户 uid
的唯一性。
白板场景。
场景名称。
在场景中展示的图片或动态 PPT。每个场景中可以展示一张图片或一页动态 PPT,你可以通过 PptDescription 设置待插入图片或动态 PPT 的宽、高、资源地址或预览图等。
WhiteWebSdk
对象的配置。
Note
成功初始化 WhiteWebSdk
后,无法再调用 WhiteWebSdkConfiguration
中的任何方法修改 WhiteWebSdk
的配置。
白板项目的唯一标识。详见获取互动白板项目的安全密钥。
该客户端的设备类型,决定 SDK 如何处理鼠标事件和触碰事件。
如果填写错误,会导致 SDK 对设备输入的响应行为不符合预期。如果不填,SDK 会根据内在逻辑自动判断设备的类型。
是否关闭新铅笔工具(pencil
)的补间动画功能:
true
:关闭补间动画功能。关闭该功能后,会缩短延时,但远端用户看到的笔迹绘制过程可能出现卡顿。false
:(默认)开启补间动画功能。开启后,当本地用户使用 pencil
在白板上绘制或书写时,SDK 会自动在关键帧之间插入帧,使远端用户看到的书写或绘制过程更加流畅,但会因此增加延时。是否关闭新铅笔的笔锋效果:
true
:关闭笔锋效果。false
:(默认)开启笔锋效果。是否关闭图片旋转:
true
:禁止图片旋转。false
:(默认)开启图片旋转。开启后,可对选中的图片任意旋转。文字工具(currentApplianceName="text"
)的字体。若不传,SDK 会使用浏览器的默认字体。
自定义字体。
为显示动态 PPT 中的非常规字体,你需要先将字体文件上传到自己的业务服务器或云存储中并生成 URL 地址,然后在初始化 WhiteWebSdk
时,将 URL 地址传给 fonts
属性。详见 UserFonts。
抓手工具对应的快捷键。
按下该键时,会自动切换成抓手工具(currentApplianceName="hand"
);松开后,切回原来的工具。如果不传,则关闭该快捷键功能。
不可见插件。
SDK 上报日志的选项,详见 LoggerOptions。
WhiteWebSdk
初始化失败的回调。
错误信息。
是否开启仅接收远端用户状态改变回调:
true
:(默认)开启。开启该功能后,本地用户仅会接收到远端用户状态改变的回调,自身状态的改变不会触发回调。false
:关闭。关闭该功能后,本地用户会接收到远端用户状态改变的回调,也会接收到自身状态改变的回调。组件插件。
动态 PPT 专用参数。详见 PptParams。
是否在加载动态 PPT 首页时,一次性加载动态 PPT 中的所有图片资源:
true
:一次性加载所有动态 PPT。false
: (默认)不一次性加载所有动态 PPT。Note
Agora 不推荐设置 preloadDynamicPPT(true)
,这样会使 PPT 显示缓慢。
断线重连设置。默认开启自动断线重连。
如果要关闭断线重连,你可以将 reconnectionOptions
设为 false
或将 disableReconnect
设为 true
。
详见《实时房间状态管理》。
数据中心,支持传入以下值:
region |
数据中心 | 服务区 |
---|---|---|
us-sv |
美国硅谷 | 北美洲、南美洲 |
sg |
新加坡 | 新加坡、东亚、东南亚 |
in-mum |
印度孟买 | 印度 |
eu |
欧洲(法兰克福) | 欧洲 |
cn-hz |
中国杭州 | 其他数据中心服务区未覆盖的地区 |
Note
该方法设置的数据中心必须与创建房间时设置的数据中心一致;否则,SDK 将无法连接到房间。
白板上绘画的渲染模式。默认为 Canvas
。
该客户端的屏幕类型,用于调整手势识别参数。默认为 Desktop
。
将白板中图片等资源的 URL 拦截并替换。
例如,你可以使用如下代码给所有图片的 URL 增加尾缀:
图片等资源原来的 URL。
替换后的 URL。
是否用 MobX 监听 displayer.state
:
true
:用 MobX 监听 displayer.state
。此时 displayer.state
会变成 MobX observable object,详见 Creating observable state。false
:不用 MobX 监听 displayer.state
。由 React.ComponentType
类型组成的数组,用于包装白板的界面。默认值为 []。
你可以使用如下代码对白板的界面进行自定义包装:
配置视觉矩形。
视觉矩形是用户的视角必须容纳的区域。设置好视觉矩形后,SDK 会自动将视角会调整到刚好可以完整展示视觉矩形所表示的范围。
你可以根据要展示的 PPT 幻灯片或图像的尺寸设置视觉矩形,以确保相同的内容在不同尺寸的屏幕上都可以完整显示。
视觉矩形的高度。
视觉矩形的高度不能小于实际展示内容的宽度,否则用户将看不见超出的部分。
视觉矩形左上角在世界坐标系(以白板初始化时的中心点为原点的坐标系)中的 X 轴坐标。
视觉矩形左上角在世界坐标系(以白板初始化时的中心点为原点的坐标系)中的 Y 轴坐标。
视觉矩形的宽度。
视觉矩形的宽度不能小于实际展示内容的宽度,否则用户将看不见超出的部分。
由 React.ComponentType
类型组成的数组,用于包装白板的界面。默认值为 []。
系统事件触发者的用户 ID。
Akko 的版本。
默认的快捷键。
键盘按键 | 效果 |
---|---|
Backspace 或 Delete | 删除所选对象 |
Shift | 锁定放缩长宽比,令其等比放缩 |
Ctrl + Z 或 Command + Z | 撤回 |
Ctrl + Y 或 Command + Y | 重做 |
Ctrl + C 或 Command + C | 复制 |
Ctrl + V 或 Command + V | 粘贴 |
Displayer
对象的 Consumer。
Player
对象的 Consumer。
Room
对象的 Consumer。
当前 SDK 的版本号,格式为字符串,如 "2.12.11"
。
等比例缩放视角,使视角边界的短边正好顶住与其垂直的屏幕的两边,以保证视角边界铺满屏幕。
视角的实时缩放比例。
等比例缩放视角,使视角边界的短边正好顶住与其垂直的屏幕的两边,以保证视角边界铺满屏幕;在此基础上再将视角边界缩放指定的倍数。
在等比例缩放的基础上再缩放视角边界的倍数。
视角的实时缩放比例。
等比例缩放视角,使视角边界的长边正好顶住与其垂直的屏幕的两边,以保证在屏幕上完整展示视角边界。
实时缩放比例。
等比例缩放视角,使视角边界的长边正好顶住与其垂直的屏幕的两边,以保证在屏幕上完整展示视角边界;在此基础上,再将视角边界缩放指定的倍数。
在等比例缩放的基础上再缩放视角边界的倍数。
实时缩放比例。
等比例缩放视角,使视角边界的长边正好顶住与其垂直的屏幕的两边;在此基础上,在视角边界的四周填充指定的空白空间。
在等比例缩放的基础上再填充的空白空间,单位为像素。
实时缩放比例。
按指定的比例缩放视角边界。
指定的缩放比例。
实时缩放比例。
创建 PPTTask
对象。
在 app 服务端发起文档转换任务后,app 客户端可以调用该方法,并传入从 app 服务端获取的 Task Token 和 Task UUD,创建 PPTTask
对象。你可以从 PPTTask
对象的回调中获取转换任务的进度和转换结果。
PPTTask
对象的参数。
创建的 PPTTask
对象。
创建插件。
创建的插件。
添加自定义的图标。
自定义的图标。
判断 Displayer
对象是否为 Player
对象。
Displayer
对象。
该 Displayer
对象是否为 Player
对象:
true
:该 Displayer
对象是 Player
对象。false
:该 Displayer
对象不是 Player
对象。判断 Displayer
对象是否为 Room
对象。
Displayer
对象。
Displayer
对象是否为 Room
对象:
true
:该 Displayer
对象是 Room
对象。false
:该 Displayer
对象不是 Room
对象。预览 PPT 文件。
该方法会创建一个独立于白板的新页面,用于预览 PPT 文件。
轮询 PPT 转换进度的响应内容。详见 ConversionResponse。
空的 HTML 元素容器。
预览页面的配置。详见 PreviewConfig。
是否提前请求下一页 PPT 的资源:
用户传入的自定义字体。详见 UserFonts。
PPT 预览的日志。预留参数,暂不支持。
PPT 预览的其他参数。详见 PptParams。
事件。
EventEmitter 对象。
设置异步模块的加载模式。
异步模块的加载模式,详见 AsyncModuleLoadMode。
视角状态,包含视角为主播模式的用户信息。