WhiteWebSdk
- Web
更新时间不可用
Whiteboard Web SDK 2.16.59 公开 class。
export declare class WhiteWebSdk成员
- region
- deviceType
- screenType
- renderEngine
- version
- constructor
- joinRoom
- isPlayable
- replayRoom
- pptConverter
- getLocalLogState
- onLocalLogStateChange
- collectLocalLogs
- flushLocalLogs
- uploadLocalLogs
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
const joinRoomParams = {...};
const roomCallbacks = {...};
whiteWebSdk.joinRoom(joinRoomParams, roomCallbacks)
.then(function (room) {
// 加入房间成功,拿到 room 对象
})
.catch(function (error) {
// 加入房间失败,拿到 error 对象
});
```| 返回类型 | 描述 |
|---|---|
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
const replayRoomParams = {...};
const replayCallbacks = {...};
whiteWebSdk.replayRoom(replayRoomParams, replayCallbacks)
.then(function (player) {
// 回放成功,拿到 player 对象
})
.catch(function (error) {
// 回放失败,拿到 error 对象
});
```| 返回类型 | 描述 |
|---|---|
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> |