IArBoardInitParams

SDK 加入频道时需要的身份凭证以及自定义房间号和用户 ID 的设置

用于配置 SDK 连接的私有化网关。

你可以在 new ArWhiteBoard 方法中传入该配置对象来配置。

示例：

import ArWhiteBoard, { IArBoardInitParams } from 'ar-whiteboard'

const initParams: IArBoardInitParams = {
  id: '<DOM_ID>',
  appId: '<YOUR_APPID>',
  channel: '<YOUR_CHANNEL_ID>',
  userId: '<YOUR_USER_ID>',
  token: null, // YOUR_TOKEN
}；
const board = new ArWhiteBoard(initParams);

id

id: string

白板父容器 DOM id。

appId

appId: string

应用 ID

channel

channel: string

频道 ID。标识通话的频道名称，长度在 64 字节以内的字符串。以下为支持的字符集范围（共 89 个字符）:

• 26 个小写字母 a-z。
• 26 个大写字母 A-Z。
• 10 个数字 0-9。
• 空格。
• "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "*", "{", "}", "|", "~", ","。

userId

userId: string

标识用户的 ID，长度在 64 字节以内的字符串。以下为支持的字符集范围（共 89 个字符）:

• 26 个小写字母 a-z。
• 26 个大写字母 A-Z。
• 10 个数字 0-9。
• 空格。
• "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "*", "{", "}", "|", "~", ","。

Optional token

token?: string

用于鉴权的 token。

• 如果你的项目没有开启 token 鉴权，这里填 null。
• 安全要求不高: 你可以使用控制台生成的临时 token，详见获取临时 Token。
• 安全要求高：传入从你的服务端获得的正式 token（不支持 Channel Key），详见获取正式 Token。

Optional baseParams

baseParams?: IArBoardInitBaseParams

基础配置。

progressBarUrl 地址必须是 http 、https 或者 base64 图片地址。

Optional styleParams

styleParams?: IArBoardInitStyleParams

样式配置。

Optional authParams

authParams?: IArBoardInitAuthParams

权限配置。

Optional serverParams

serverParams?: IConfigParameters

私有服务配置。

• Optional ConfPriCloudAddr

私有服务配置

• Optional ConfPriCloudAddr1

备用私有服务配置