Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IAppConfig

Hierarchy

  • IAppConfig

Index

Properties

allowReplaceActiveBroadcaster

allowReplaceActiveBroadcaster: boolean

房间内存在主播时(视角跟随),是否允许其他用户设置自己为主播

audioFitStrategy

audioFitStrategy: { type: 0 | 1 | 2; value?: number }

audioFitStrategy会影响其他端添加音频后,本端调整视角的策略:

0: 添加音频后,视角不做任何变化 1: 移动视角,使得视角包含新增音频,以及当前画布上所有内容 2: 移动视角,使得新增视频居中,同时音频相对容器较长的一边,占据容器宽高的一定百分比(比如value为1,则占据100%。value为0.5,则占据50%)。

移动端默认值为: { type: 2, value: 1 }

桌面端默认值为: { type: 2 value: 0.5 }

Type declaration

  • type: 0 | 1 | 2
  • Optional value?: number

cacheUploadDocs

cacheUploadDocs: boolean

是否将资源弹窗的上传记录保存在localStorage中,并在初始化时,使用localStorage中的记录还原资源弹窗。默认为true

cameraMaxZoom

cameraMaxZoom: number

最大缩放比例。默认为 4

cameraMinZoom

cameraMinZoom: number

最小缩放比例。默认为 0.25

canvasBgColor

canvasBgColor: string

白板背景色

API CHANGE:

3.6.0版本之前,请使用canvas_bg_color

3.6.0版本之后,请使用canvasBgColor。3.6.0之后canvas_bg_color依旧可以使用,但是未来可能不再支持

defaultBoardName

defaultBoardName: string

默认白板的显示名。设置显示名仅在当前客户端有效,不会影响其他客户端

deleteBoardBehavior

deleteBoardBehavior: "keepBoard" | "keepBoardCompat" | "legacy"

deleteBoard 时的 board 跳转逻辑。

主要区别在于删除的board不是选中的board时,是否需要跳转。3.9.8 及之前默认值为 legacy。3.9.9 及之后默认值为 keepBoard

  • legacy: 跳转到删除 board 的下一个 board
  • keepBoard: 保持当前的 board 不变
  • keepBoardCompat: 保持当前 board 不变。如果你需要兼容 3.9.8 及之前的版本,应该使用该选项

Optional disableAutoResize

disableAutoResize: boolean

默认为true true: 容器resize时,容器内元素大小不变 false:容器resize时,容器所代表的世界坐标系的宽度不变. 如果是等比例缩放,容器大小变化,则容器内元素内容和容器的相对位置不变

drawMergeDebug

drawMergeDebug: boolean

默认为false。仅当drawMergeInterval > 0时有效 设置为true时,会在涂鸦时打印两笔之间的时间差与曼哈顿距离,这样方便产品/开发设置合适的drawMergeInterval,以及drawMergeDist。

drawMergeDist

drawMergeDist: number

默认为200。仅当drawMergeInterval > 0时有效 注意该距离为两点之间的曼哈顿距离。即 Math.abs(x1 - x2) + Math.abs(y1 - y2)。这里的x,y均为屏幕上面的css像素点距离

drawMergeInterval

drawMergeInterval: boolean

默认为-1。 如果该值 <= 0, 则认为不对涂鸦进行合并。 如果该值 > 0, 则当两次涂鸦之间的间隔小于drawMergeInterval时,且第一笔的最后一点,和第二笔的第一点距离小于drawMergeDist时, 认为两次涂鸦为同一笔操作

isDocZoomLevel1

isDocZoomLevel1: boolean

文档的默认缩放大小是否为 100%。

默认为 true,即页面刚好显示完整文档时,页面的默认缩放大小为 100%。

3.9.7 新增 feature。此前,文档刚好显示时的缩放比,取决于文档本身的大小,和容器的大小之间的比例。

如果你需要回到 3.9.6 之前的配置,请设置 isDocZoomLevel1 为 false

nosAntiLeech

nosAntiLeech: boolean

上传资源时,是否添加防盗链。默认为 false。如果要使用防盗链,首先需要在云信业务后台,开通点播防盗链能力(URL鉴权防盗链)

nosAntiLeechExpire

nosAntiLeechExpire: number

防盗链资源失效时间,单位为(s),默认为7200

presetId

presetId: number

音视频转码模板id

参考该地址创建:https://doc.yunxin.163.com/vod/docs/Dc5NDE5NjM?platform=server 参数为: { "presetName":"白板视频转码模板", "sdMp4":1, "hdMp4":0, "shdMp4":0, "uhdMp4": 0, "sdFlv":0, "hdFlv":0, "shdFlv":0, "sdHls":0, "hdHls":0, "shdHls":0, "transConfig": [{ "presetType": 1, "video": { "maxWidth": "auto", "maxHeight": "auto" } }] }

previewCustomBg

previewCustomBg: boolean

预览图中是否包含自定义背景函数的绘制。默认为false

previewMode

previewMode: "fitDoc" | "fitContainer"

预览图的模式 fitDoc: 在预览图中,文档显示最大化 fitContainer: 在预览图中,当前白板页的容器显示最大化

resMaxRetry

resMaxRetry: number

resRetryCors

resRetryCors: boolean

默认为false

图片资源第一次加载会使用跨域方式加载,如果加载失败,第二次会使用非跨域方式加载。如果设置为true,则无论失败几次,都会一直使用跨域方式加载

resRetryInterval

resRetryInterval: number

默认为5000(5s)

资源加载失败后,隔多久尝试重新加载。注意第一次失败后,会立即开始第二次重新加载。该参数仅影响第三次,第四次加载资源

selectMode

selectMode: "intersect" | "contain"

默认为intersect

intersect:当选择矩形和图形的包含盒相交时,即为选中 contain: 当选择矩形完全包含图形的包含盒时为选中

showCursorNickname

showCursorNickname: boolean

共享鼠标位置时,是否显示鼠标所有者的昵称。和DrawPlugin.setShowCursor配合使用

showImportProgress

showImportProgress: boolean

showLaserNickname

showLaserNickname: boolean

显示激光笔时,是否显示激光笔所有者的昵称

showSelectNickname

showSelectNickname: boolean

显示选择框时,是否显示选择框所有者的昵称

staticDocType

staticDocType: "template" | "array"

该配置会影响addDoc时,添加静态文档的参数。

若你的所有客户白板版本都大于等于3.6.1, 则你应该使用'template' 若你的sdk版本小于3.6.1, 或者你需要和低版本的白板sdk互通,则你应该使用array

注意,如果使用array,在加载页数很大(如大于100)的静态文档时,可能会存在性能问题。

uniqueDocName

uniqueDocName: boolean

是否确保新增的文档名称唯一。默认为false,即可用添加同名文档。

videoFitStrategy

videoFitStrategy: { type: 0 | 1 | 2; value?: number }

videFitStrategy会影响其他端添加视频后,本端调整视角的策略:

0: 添加视频后,视角不做任何变化 1: 移动视角,使得视角包含新增视频,以及当前画布上所有内容 2: 移动视角,使得新增视频居中,同时视频相对容器较长的一边,占据容器宽高的一定百分比(比如value为1,则占据100%。value为0.5,则占据50%)。

移动端默认值为: { type: 2, value: 1 }

桌面端默认值为: { type: 2 value: 0.5 }

Type declaration

  • type: 0 | 1 | 2
  • Optional value?: number

workerTimerInterval

workerTimerInterval: number

页面切换到背景时,白板推流的刷新 interval。默认为 200(ms)

zoomSensitivity

zoomSensitivity: number

缩放灵敏度设置。这个值应该大于0,小于1。默认为0.91