WhiteWebSdk

Whiteboard Web SDK 2.16.59 公开 class。

JavaScript

export declare class WhiteWebSdk  

Properties

region

readonly region: string;

默认所在区域 如果在调用 ``joinRoom``、``replayRoom``、``isPlayable`` 时没有指定 ``region``，则以此属性为准。

deviceType

readonly deviceType: DeviceType;

该客户端的设备类型，决定 SDK 如何处理鼠标事件和触碰事件

screenType

readonly screenType: ScreenType;

该客户端的屏幕类型，用于调整手势识别参数

renderEngine

readonly renderEngine: RenderEngine;

对画面的渲染模式

version

readonly version: string;

当前 SDK 的版本

Constructors

constructor

constructor(params: WhiteWebSdkConfiguration);

返回值

WhiteWebSdk

Methods

joinRoom

joinRoom(params: JoinRoomParams, callbacks?: Partial<RoomCallbacks>, options?: WhiteLocalLogJoinOptions): Promise<Room>;

加入一个实时房间
@param params 加入房间的参数
@param callbacks 回调函数
@returns 异步地返回房间
@throws 如果加入房间失败，则会异步地抛出错误
@example
typescript{"\n"}const joinRoomParams = {"{"}...{"}"};{"\n"}const roomCallbacks = {"{"}...{"}"};{"\n"}whiteWebSdk.joinRoom(joinRoomParams, roomCallbacks){"\n"}{" "}.then(function (room) {"{"}{"\n"}{" "}// 加入房间成功，拿到 room 对象{"\n"}{" "}{"}"}){"\n"}{" "}.catch(function (error) {"{"}{"\n"}{" "}// 加入房间失败，拿到 error 对象{"\n"}{" "}{"}"});{"\n"}

返回值

Promise<Room>

isPlayable

isPlayable(params: PlayableCheckingParams): Promise<boolean>;

判断房间是否可播放

返回值

Promise<boolean>

replayRoom

replayRoom(params: ReplayRoomParams, callbacks?: Partial<PlayerCallbacks>): Promise<Player>;

回放房间录像
@param params 回放房间录像参数
@param callbacks 回调函数
@returns 异步地返回房间
@throws 如果加入房间失败，则会异步地抛出错误
@example
typescript{"\n"}const replayRoomParams = {"{"}...{"}"};{"\n"}const replayCallbacks = {"{"}...{"}"};{"\n"}whiteWebSdk.replayRoom(replayRoomParams, replayCallbacks){"\n"}{" "}.then(function (player) {"{"}{"\n"}{" "}// 回放成功，拿到 player 对象{"\n"}{" "}{"}"}){"\n"}{" "}.catch(function (error) {"{"}{"\n"}{" "}// 回放失败，拿到 error 对象{"\n"}{" "}{"}"});{"\n"}

返回值

Promise<Player>

pptConverter

pptConverter(roomToken: string): LegacyPPTConverter;

@deprecated

返回值

LegacyPPTConverter

getLocalLogState

getLocalLogState(): WhiteLocalLogState;

同步读取本地日志状态。

返回值

WhiteLocalLogState

onLocalLogStateChange

onLocalLogStateChange(listener: (state: WhiteLocalLogState)=>void): ()=>void;

监听本地日志状态，返回解除订阅函数。

返回值

()=>void

collectLocalLogs

collectLocalLogs(): Promise<WhiteLocalLogExportResult>;

收集本地日志；异步返回导出结果。需要先开启本地日志。

返回值

Promise<WhiteLocalLogExportResult>

flushLocalLogs

flushLocalLogs(): Promise<void>;

将当前本地日志刷新到持久化存储；异步完成。

返回值

Promise<void>

uploadLocalLogs

uploadLocalLogs(request?: WhiteLocalLogUploadRequest): Promise<WhiteLocalLogUploadResult>;

上传本地日志；日志运行时和上传开关均需可用，enabled/ enabledUpload 未设置为 false 时默认尝试开启。通过返回结果和状态事件观察上传。

返回值

Promise<WhiteLocalLogUploadResult>