WhiteWebSdk

  • Web

更新时间不可用

Whiteboard Web SDK 2.16.59 公开 class。

TypeScript
export declare class WhiteWebSdk

成员

Properties

region

readonly region: string;

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

deviceType

readonly deviceType: DeviceType;

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

screenType

readonly screenType: ScreenType;

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

renderEngine

readonly renderEngine: RenderEngine;

Text
对画面的渲染模式

version

readonly version: string;

Text
当前 SDK 的版本

Constructors

constructor

constructor(params: WhiteWebSdkConfiguration);
Returns
返回类型描述

WhiteWebSdk

表格内容超出当前宽度,可横向滚动查看更多列。

Methods

joinRoom

joinRoom(params: JoinRoomParams, callbacks?: Partial<RoomCallbacks>, options?: WhiteLocalLogJoinOptions): Promise<Room>;
Text
加入一个实时房间
@param params 加入房间的参数
@param callbacks 回调函数
@returns 异步地返回房间
@throws 如果加入房间失败,则会异步地抛出错误

@example
```typescript
const joinRoomParams = {...};
const roomCallbacks = {...};

whiteWebSdk.joinRoom(joinRoomParams, roomCallbacks)
           .then(function (room) {
               // 加入房间成功,拿到 room 对象
           })
           .catch(function (error) {
               // 加入房间失败,拿到 error 对象
           });
```
Returns
返回类型描述

Promise<Room>

表格内容超出当前宽度,可横向滚动查看更多列。

isPlayable

isPlayable(params: PlayableCheckingParams): Promise<boolean>;
Text
判断房间是否可播放
Returns
返回类型描述

Promise<boolean>

表格内容超出当前宽度,可横向滚动查看更多列。

replayRoom

replayRoom(params: ReplayRoomParams, callbacks?: Partial<PlayerCallbacks>): Promise<Player>;
Text
回放房间录像
@param params 回放房间录像参数
@param callbacks 回调函数
@returns 异步地返回房间
@throws 如果加入房间失败,则会异步地抛出错误

@example
```typescript
const replayRoomParams = {...};
const replayCallbacks = {...};

whiteWebSdk.replayRoom(replayRoomParams, replayCallbacks)
           .then(function (player) {
               // 回放成功,拿到 player 对象
           })
           .catch(function (error) {
               // 回放失败,拿到 error 对象
           });
```
Returns
返回类型描述

Promise<Player>

表格内容超出当前宽度,可横向滚动查看更多列。

pptConverter

pptConverter(roomToken: string): LegacyPPTConverter;
Text
@deprecated
Returns
返回类型描述

LegacyPPTConverter

表格内容超出当前宽度,可横向滚动查看更多列。

getLocalLogState

getLocalLogState(): WhiteLocalLogState;

同步读取本地日志状态。

Returns
返回类型描述

WhiteLocalLogState

表格内容超出当前宽度,可横向滚动查看更多列。

onLocalLogStateChange

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

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

Returns
返回类型描述

()=>void

表格内容超出当前宽度,可横向滚动查看更多列。

collectLocalLogs

collectLocalLogs(): Promise<WhiteLocalLogExportResult>;

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

Returns
返回类型描述

Promise<WhiteLocalLogExportResult>

表格内容超出当前宽度,可横向滚动查看更多列。

flushLocalLogs

flushLocalLogs(): Promise<void>;

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

Returns
返回类型描述

Promise<void>

表格内容超出当前宽度,可横向滚动查看更多列。

uploadLocalLogs

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

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

Returns
返回类型描述

Promise<WhiteLocalLogUploadResult>

表格内容超出当前宽度,可横向滚动查看更多列。