You need to enable JavaScript to run this app.
导航

类型详情

最近更新时间2024.02.20 20:19:35

首次发布时间2023.08.07 20:50:14

WebPageInfo

类型: interface

页面信息。

pageId

类型: string

页面 ID。

bkInfo

类型: WebBackgroundInfo | undefined

背景设置。

extra

类型: string | undefined

补充信息。

pptInfo

类型: WebPagePptInfo | undefined

关联ppt的信息

WebBackgroundInfo

类型: interface

bkColor

类型: string | undefined

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

bkImage

类型: string | undefined

背景图片。

bkImageFillType

类型: BkFillType | undefined

背景图片填充设置。

bkImageSize

类型: BkImageSize | undefined

背景图片尺寸。

BkFillType

类型: enum

背景图片填充方式

  • 成员

    属性描述
    kFill0平铺窗口,按照白板比例缩放图片进行填充。
    kCenter1居中放置,不缩放。
    kHidden2等比例缩放,如果画布和图片比例不一致,将对图片进行裁切。

BkImageSize

类型: interface

背景图片尺寸

width

类型: number

宽,单位为画布宽度的万分之一。

height

类型: number

高,单位为画布高度的万分之一。

WebPagePptInfo

类型: interface

slideIndex

类型: number | undefined

ppt 索引

CreatePageOptions

类型: interface

创建页面选项

insertPageIndex

类型: number | undefined

指定页面索引。创建的页面将插入到指定的页面之后。默认插入到当前页后面

autoFlip

类型: boolean | undefined

是否自动翻页。

  • True: 在页面创建完成后,当前页面变更为刚批量创建的第一页。
  • False: 不翻页,即创建页面后当前页面不变。默认选项。

CreatePageProgressResult

类型: interface

创建页面成功事件

userId

类型: string

创建页面的用户

pages

类型: WebPageInfo[]

刚创建的白板页面信息

insertPageId

类型: string

指定页面的 pageId,新建页面将插入此页面之后

progress

类型: number

创建进度

totalCount

类型: number

创建页后的白板总页数

FlipPageResult

类型: interface

userId

类型: string

翻页的用户

currentIndex

类型: number

当前页面 Index。

ErrorCode

  • 类型

    EnumValue<typeof ErrorCode>
    

ImageLoadStatus

类型: enum

图片加载状态。

  • 成员

    属性描述
    loading0加载中。
    end1加载完成。
    error2加载错误。

CreateWhiteBoardInfo

类型: interface

白板初始化信息

boardId

类型: number | undefined

白板 ID,可选,默认从 1 开始自增的数字

boardName

类型: string | undefined

白板名称,可选,默认和 id 一样
支持的字符为中文、英文、数字、下划线(_) 和 连线符(-)

pages

类型: WebPageInfo[] | undefined

页面信息,默认创建一个空白页面

bkInfo

类型: WebBackgroundInfo | undefined

白板背景信息,默认无背景

CreateWhiteBoardResult

类型: interface

创建白板成功提示

userId

类型: string

创建白板的用户 ID

boardId

类型: number

当前白板 ID

whiteBoard

类型: IWhiteBoard

当前白板实例

SwitchBoardResult

类型: interface

当前白板更换成功提示

userId

类型: string

更换白板的用户 ID

boardId

类型: number

当前白板 ID

whiteBoard

类型: IWhiteBoard

当前白板实例

WebBoardInfo

类型: interface

白板信息

boardId

类型: number

只读, 白板 ID

boardName

类型: string | undefined

只读, 白板名称
支持的字符为中文、英文、数字、下划线(_) 和 连线符(-)

createTimestamp

类型: number

只读, 创建时间,为精确到毫秒的 UNIX 时间戳

bkInfo

类型: WebBackgroundInfo | undefined

只读, 背景设置

status

类型: StatusType

只读, 白板状态,是否可用

pages

类型: WebPageInfo[]

只读, 页面信息

currentPageId

类型: string

当前页面 ID

controlCount

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

只读, 每个页面操作记录数,key 为 page ID。

boardControlCount

类型: number

只读, 白板中的操作记录数。

userCursorInfo

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

只读, 自定义光标设置。

zoomInfo

类型: ZoomOffsetInfo

只读, 缩放相关信息

pptInfo

类型: PptInfo | undefined

只读, ppt的配置

currentPptStepIndex

类型: number | undefined

当前 ppt 步数

StatusType

类型: enum

当前白板是否可编辑

  • 成员

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

UserCursorInfo

类型: interface

自定义光标设置

showState

类型: CursorShowState

显示状态

cursorType

类型: CursorType

光标类型

CursorShowState

类型: enum

光标显示状态

  • 成员

    属性描述
    kHide0隐藏
    kShow1显示
    kSimulate2同步

CursorType

类型: enum

光标类型

  • 成员

    属性描述
    kPointer0选择工具
    kPen2画笔工具
    kShape3形状绘制工具
    kText4文本工具
    kErase5橡皮擦工具
    kLaserPen6激光笔工具
    kMove7图形平移光标,光标不同步此类型,仅 Web 端本地用
    kRotate8图形旋转光标,光标不同步此类型,仅 Web 端本地用
    kZoom9放大缩小工具,光标不同步此类型,仅 Web 端本地用
    kFileArrow10ppt和白板切换模式时使用

ZoomOffsetInfo

类型: interface

缩放相关信息

zoom

类型: number

缩放系数

offsetX

类型: number

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

offsetY

类型: number

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

PptInfo

类型: interface

fileId

类型: string

ppt的FileId

title

类型: string | undefined

ppt的名称

customArgs

类型: string | undefined

业务层自定义参数

IDocsCreateTranscodeTask

类型: interface

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

app_id

类型: string

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

resource

类型: string

需要进行转码的文档 URL 地址,必填。你需要自行实现将客户端的本地文档上传到云存储服务。

resource_attr

类型: IDocsResourceAttr | undefined

文档属性
动态转码必填

operator

类型: string

操作用户,必填

transcode_config

类型: TranscodeConfig | undefined

静态转码必填
参数说明详见 TranscodeConfig

storage_config

类型: StorageConfig

参数说明详见 StorageConfig

transcode_mode

类型: TranscodeMode | undefined

转码设置,必填

priority

类型: Priority | undefined

转码任务优先级

onProgress

任务状态

  • 类型

    (transcodePercent: number, transcodeStatus: TaskStatus, taskId: string) => void
    
  • 参数

    • transcodePercent

      类型: number

    • transcodeStatus

      类型: TaskStatus

    • taskId

      类型: string

IDocsResourceAttr

类型: interface

转码文档

file_name

类型: string

文档名称,必填。

size

类型: number

文档大小,单位 byte,必填

TranscodeConfig

类型: interface

参数说明详见 TranscodeConfig

input_format

类型: InputFormat

输入文档类型,必填

output_format

类型: OutputFormat

输出文档类型,必填

output_width

类型: number

转码后的图片宽度,单位为像素

output_height

类型: number

转码后的图片高度,单位为像素

force_use_resolution

类型: boolean | undefined

是否按照指定分辨率拉伸图片。默认为 false,按照文档的原始宽高比适配指定分辨率。

thumbnail

类型: boolean | undefined

是否生成缩略图,默认为 false

thumbnail_width

类型: number | undefined

缩略图分辨率宽,默认为 320

thumbnail_height

类型: number | undefined

缩略图分辨率高,默认为 180

InputFormat

类型: enum

文档转码输入格式

  • 成员

    属性描述
    ppt1ppt
    pptx2pptx
    doc3doc
    docx4docx
    pdf5pdf

OutputFormat

类型: enum

文档转码输出格式

  • 成员

    属性描述
    png1png
    'jpg/jpeg'2jpg/jpeg

StorageConfig

类型: interface

TOS 存储设置。参数说明详见 StorageConfig

type

类型: StorageType

存储类型,必填

tos_config

类型: TosConfig | undefined

火山引擎的对象存储服务参数设置

custom_config

类型: CustomConfig | undefined

第三方对象存储服务参数设置

StorageType

类型: enum

储存方式

  • 成员

    属性描述
    Tos0火山引擎 TOS 服务
    S31第三方的 TOS 服务

TosConfig

类型: interface

使用火山 TOS 时此项必填。

account_id

类型: string

账户 ID。火山引擎主账户的账号 ID

bucket

类型: string

桶名称。登录 TOS 控制台 开通和获取。

CustomConfig

类型: interface

使用第三方 TOS 时此项必填。向你的 TOS 服务供应商获取以下信息。

vendor

类型: Vendor

第三方对象存储供应商

  • 0: Amazon 亚马逊
  • 1: Alicloud 阿里云

region

类型: string

地区 ID。参考 数据结构 进行赋值。

bucket

类型: string

桶名称

access_key

类型: string

接入凭证

secret_key

类型: string

接入密钥

Vendor

类型: enum

使用第三方 TOS 服务厂商

  • 成员

    属性描述
    amazon0Amazon
    alicloud1Alicloud

TranscodeMode

类型: enum

转码类型

  • 成员

    属性描述
    static0静态
    dynamic1动态。转码后可以通过交互,播放 PPT 中的视频动画,执行 PPT 动画效果等。

Priority

类型: enum

转码优先级

  • 成员

    属性描述
    nonrealtime0非实时转码(默认)
    realtime1实时转码

TaskStatus

类型: enum

转码任务状态

  • 成员

    属性描述
    Pending0等待开始
    Ongoing1执行中
    Completed2已完成
    Fail3失败

IDocsTranscodeResult

类型: interface

转码任务结果

transcode_mode

类型: TranscodeMode

转码模式

images

类型: IDocsImage[]

转码结果

h5_url

类型: string

转码输出的文档链接

file_name

类型: string

文档名称

width

类型: number

图片宽度

height

类型: number

图片高度

file_id

类型: string | undefined

文档 ID,动态转码使用

IDocsImage

转码后的图片

  • 类型

    {
        page_id: number;
        img: string;
        thumbnail_url: string;
    }
    
  • 成员

    名称类型描述
    page_idnumber页面 ID
    imgstring图片 URL 地址
    thumbnail_urlstring图片缩略图 URL 地址

RemoveWhiteBoardResult

类型: interface

白板删除提示

userId

类型: string

删除白板的用户 ID

boardId

类型: number

删除的白板 ID

pptInfo

类型: PptInfo | undefined

被删除白板对应的 PPT 信息,为空时表示普通白板

IInitParams

类型: interface

白板 SDK 初始化参数

appId

类型: string

每个应用的唯一标识符,由控制台随机生成的。
不同的 appId 生成的实例在互动白板中无法互通。
获取 appId 详见开通服务

mount

类型: string

绑定网页上的 DOM 元素 ID。

IJoinRoomParams

类型: interface

进入白板房间参数

roomId

类型: string

房间 ID,是房间的唯一标志

userId

类型: string

用户 ID,详见 赋值规范

token

类型: string

动态密钥
用户登录必须携带的 Token,用于鉴权验证。
登录 Token 与加入房间时必须携带的 Token 不同。测试时可使用控制台生成临时 Token。正式上线需要使用密钥 SDK 在你的服务端生成并下发 Token。
获取 token 详见开通服务

defaultBoardInfo

类型: CreateWhiteBoardInfo | undefined

默认的白板信息,当房间内没有白板时,会用此参数创建第一个白板