类型: interface

白板状态。

类型: PageInfo[]

页面信息。

类型: string

当前页面 ID。

类型: StatusType

状态，是否可用。

类型: interface

页面信息

类型: string

页面 ID

类型: BackgroundInfo | undefined

页面背景设置

类型: string | undefined

页面设置

类型: interface

背景信息

类型: number

背景颜色

类型: string

背景图片地址

类型: BkFillType

图片填充方式

类型: BkImageSize | undefined

图片大小

类型: enum

背景图片填充方式

• 成员

  属性	值	描述
  kFill	0	平铺窗口，按照白板比例缩放图片进行填充。
  kCenter	1	居中放置，不缩放。
  kHidden	2	等比例缩放，如果画布和图片比例不一致，将对图片进行裁切。

类型: interface

背景图片尺寸

类型: number

宽

类型: number

高

类型: enum

当前白板是否可编辑

• 成员

  属性	值	描述
  Active	0	可编辑
  Inactive	1	已关闭，不可编辑。如果开启了录像，在此状态下可以开始播放录像。不可用。房间中有用户调用 closeAllWhiteBoard 关闭白板后，再次进房时，白板状态将为已关闭。

类型: interface

白板信息。

类型: number

白板 ID。

类型: WebPageInfo[]

页面信息。

类型: string

当前页面 ID。

类型: StatusType

是否可用。

类型: { [key: string]: number; }

每个页面操作记录数，key 为 page ID。

类型: number

白板中的操作记录数。

类型: BackgroundInfoCache | undefined

背景设置。

类型: { [key: string]: UserCursorInfo; }

自定义光标设置。

类型: { zoom: number; offsetX: number; offsetY: number; }

缩放相关信息

• 成员

  名称	类型	描述
  zoom	number
  offsetX	number
  offsetY	number

类型: string

类型: number

类型: interface

页面信息。

类型: string

页面 ID。

类型: { bkColor?: string | undefined; bkImage?: string | undefined; bkImageFillType?: BkFillType | undefined; bkImageSize?: BkImageSize | undefined; } | undefined

背景设置。

• 成员

  名称	类型	描述
  bkColor	string | undefined	背景颜色。例如 rgba(0,0,0,255)。
  bkImage	string | undefined	背景图片。
  bkImageFillType	BkFillType | undefined	背景图片填充设置。
  bkImageSize	BkImageSize | undefined	背景图片尺寸。

类型: string | undefined

补充信息。

类型: interface

默认背景设置

类型: string | undefined

背景颜色。例如 rgba(0,0,0,255)。

类型: string | undefined

背景图片

类型: BkFillType | undefined

背景图片填充方式

类型: BkImageSize | undefined

背景图片尺寸

类型: interface

自定义光标设置

类型: CursorShowState

显示状态

类型: CursorType

光标类型

类型: enum

光标显示状态

• 成员

  属性	值	描述
  kHide	0	隐藏
  kShow	1	显示
  kSimulate	2	同步

类型: enum

光标类型

• 成员

  属性	值	描述
  kArrow	0	选择工具
  kPen	2	画笔工具
  kShape	3	形状绘制工具
  kText	4	文本工具
  kErase	5	橡皮擦工具
  kLaserPen	6	激光笔工具
  kMove	7	图形平移光标，光标不同步此类型，仅 Web 端本地用
  kRotate	8	图形旋转光标，光标不同步此类型，仅 Web 端本地用
  kZoom	9	放大缩小工具，光标不同步此类型，仅 Web 端本地用

类型: enum

锁定原因。

• 成员

  属性	值	描述
  BOARD_DATA_ERROR	1	数据错误。
  NET_WORK_CONGESTION	2	网络拥塞。
  NET_WORK_DISCONNECT	3	网络断开。

类型: enum

图片加载状态。

• 成员

  属性	值	描述
  loading	0	加载中。
  end	1	加载完成。
  error	2	加载错误。

类型: enum

视图缩放同步选项

• 成员

  属性	值	描述
  kBroadcast	0	视图控制模式。本端的视图设置将同步给其他用户，设置为自由模式的用户除外。 同一个白板可以有多个控制方，缩放设置为最近一次调用 API 传入的设置。
  kFollow	1	视图跟随模式
  kFree	2	自由模式，不跟随其他用户的视图缩放设置。同时本地的视图缩放设置也不会影响到设置为跟随的用户。

类型: enum

是否可编辑。

• 成员

  属性	值	描述
  kRead	0	只读。
  kEditAll	1	可编辑。

编辑动作类型。

• 类型

  TOOL_TYPE | Constant.SHAPE_TYPE | ''
  ts

类型: interface

选择框样式。

类型: MotionType | undefined

锚点形状。

类型: number | undefined

锚点宽度。

类型: number | undefined

锚点边框线条宽度。

类型: string | undefined

锚点边框颜色。例如 rgba(0,0,0,255)。

类型: string | undefined

锚点填充颜色。例如 rgba(0,0,0,255)。

类型: boolean | undefined

锚点是否透明。

类型: number | undefined

选择框宽度。

类型: string | undefined

选择框颜色。例如 rgba(0,0,0,255)。

类型: string | undefined

旋转手柄图标资源地址。

类型: number | undefined

旋转手柄距离选择框顶点的距离。

类型: enum

选择框形状。

• 成员

  属性	值	描述
  kRect	0	矩形。
  kCircle	1	圆形。

类型: enum

白板录像回放状态

• 成员

  属性	值	描述
  INIT	0	初始化
  PAUSE	1	暂停播放
  START	2	开始播放
  END	3	停止播放

类型: interface

白板响应信息

类型: BoardInfo[]

白板信息

类型: number

包 ID

类型: number

类型: StatusType

类型: interface

白板信息

类型: number

白板 ID

类型: PageInfo[]

页面信息

类型: string

当前页面信息

类型: StatusType

白板生命周期

类型: { [key: string]: number; }

控制用户数量

类型: number

控制用户数量

类型: BackgroundInfo

背景信息

类型: { [key: string]: UserCursorInfo; }

光标信息

类型: string | undefined

画板名称

类型: string | undefined

白板初始设置

类型: IZoomInfo

缩放信息

类型: number

创建时间

类型: interface

缩放相关信息

类型: number

缩放系数

类型: number

缩放中心 x 坐标。坐标原点为画板中心。

类型: number

缩放中心 y 坐标。坐标原点为画板中心。

类型: enum

• 成员

  属性	值	描述
  CONNECTION_START	0	进行连接前准备，锁定相关资源。
  CONNECTION_STATE_DISCONNECTED	1	连接断开。
  CONNECTION_STATE_CONNECTING	2	首次连接，正在连接中。
  CONNECTION_STATE_CONNECTED	3	首次连接成功。
  CONNECTION_STATE_RECONNECTING	4	连接断开后重新连接中。
  CONNECTION_STATE_RECONNECTED	5	连接断开后重连成功。

类型: interface

白板关闭提示

类型: boolean

是否成功关闭白板

类型: interface

文件转码任务配置
参数说明参见 文件转码说明。

类型: string

App ID
你可以在控制台上查看 App ID。或通过调用 Open API 获取。

类型: string

类型: string

类型: TranscodeConfig

参数说明详见 TranscodeConfig

类型: StorageConfig

参数说明详见 StorageConfig

类型: TranscodeMode | undefined

类型: Priority | undefined

• 类型

  (transcodePercent: number, transcodeStatus: TaskStatus, task_id: string) => void
  ts

• 参数

  • transcodePercent

    类型: number

  • transcodeStatus

    类型: TaskStatus

  • task_id

    类型: string

类型: interface

参数说明详见 TranscodeConfig

类型: InputFormat

类型: OutputFormat

类型: number

类型: number

类型: boolean | undefined

类型: boolean | undefined

类型: number | undefined

类型: number | undefined

类型: enum

• 成员

  属性	值	描述
  ppt	1
  pptx	2
  doc	3
  docx	4
  pdf	5

类型: enum

• 成员

  属性	值	描述
  png	1
  'jpg/jpeg'	2

类型: interface

参数说明详见 StorageConfig

类型: StorageType

类型: TosConfig | undefined

类型: CustomConfig | undefined

类型: enum

储存方式

• 成员

  属性	值	描述
  Tos	0
  S3	1

类型: interface

使用火山 Tos 此项必填。

类型: string

类型: string

类型: interface

使用第三方 Tos 此项必填。

类型: Vendor

类型: string

类型: string

类型: string

类型: string

类型: enum

• 成员

  属性	值	描述
  amazon	0
  alicloud	1

类型: enum

转码类型

• 成员

  属性	值	描述
  static	0	静态

类型: enum

转码优先级

• 成员

  属性	值	描述
  nonrealtime	0	非实时转码(默认)
  realtime	1	实时转码

类型: enum

• 成员

  属性	值	描述
  Pending	0
  Ongoing	1
  Completed	2
  Fail	3

类型: interface

文件转码任务响应信息

类型: string

任务 ID。