# WhiteWebSdk (/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/classes/whitewebsdk) > For AI agents: see the complete documentation index at [llms.txt](/llms.txt). ```ts export declare class WhiteWebSdk ``` ## 成员 [#成员] - [region](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/classes/whitewebsdk#region) - [deviceType](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/classes/whitewebsdk#devicetype) - [screenType](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/classes/whitewebsdk#screentype) - [renderEngine](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/classes/whitewebsdk#renderengine) - [version](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/classes/whitewebsdk#version) - [constructor](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/classes/whitewebsdk#constructor) - [joinRoom](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/classes/whitewebsdk#joinroom) - [isPlayable](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/classes/whitewebsdk#isplayable) - [replayRoom](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/classes/whitewebsdk#replayroom) - [pptConverter](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/classes/whitewebsdk#pptconverter) - [getLocalLogState](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/classes/whitewebsdk#getlocallogstate) - [onLocalLogStateChange](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/classes/whitewebsdk#onlocallogstatechange) - [collectLocalLogs](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/classes/whitewebsdk#collectlocallogs) - [flushLocalLogs](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/classes/whitewebsdk#flushlocallogs) - [uploadLocalLogs](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/classes/whitewebsdk#uploadlocallogs) ## Properties [#properties] ### region [#region] readonly region: string; ```text 默认所在区域 如果在调用 ``joinRoom``、``replayRoom``、``isPlayable`` 时没有指定 ``region``,则以此属性为准。 ``` ### deviceType [#devicetype] readonly deviceType: DeviceType; ```text 该客户端的设备类型,决定 SDK 如何处理鼠标事件和触碰事件 ``` ### screenType [#screentype] readonly screenType: ScreenType; ```text 该客户端的屏幕类型,用于调整手势识别参数 ``` ### renderEngine [#renderengine] readonly renderEngine: RenderEngine; ```text 对画面的渲染模式 ``` ### version [#version] readonly version: string; ```text 当前 SDK 的版本 ``` ## Constructors [#constructors] ### constructor [#constructor] constructor(params: WhiteWebSdkConfiguration); WhiteWebSdk ## Methods [#methods] ### joinRoom [#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 对象 }); ``` ```` Promise<Room> ### isPlayable [#isplayable] isPlayable(params: PlayableCheckingParams): Promise<boolean>; ```text 判断房间是否可播放 ``` Promise<boolean> ### replayRoom [#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 对象 }); ``` ```` Promise<Player> ### pptConverter [#pptconverter] pptConverter(roomToken: string): LegacyPPTConverter; ```text @deprecated ``` LegacyPPTConverter ### getLocalLogState [#getlocallogstate] getLocalLogState(): WhiteLocalLogState; 同步读取本地日志状态。 WhiteLocalLogState ### onLocalLogStateChange [#onlocallogstatechange] onLocalLogStateChange(listener: (state: WhiteLocalLogState)=>void): ()=>void; 监听本地日志状态,返回解除订阅函数。 ()=>void ### collectLocalLogs [#collectlocallogs] collectLocalLogs(): Promise<WhiteLocalLogExportResult>; 收集本地日志;异步返回导出结果。需要先开启本地日志。 Promise<WhiteLocalLogExportResult> ### flushLocalLogs [#flushlocallogs] flushLocalLogs(): Promise<void>; 将当前本地日志刷新到持久化存储;异步完成。 Promise<void> ### uploadLocalLogs [#uploadlocallogs] uploadLocalLogs(request?: WhiteLocalLogUploadRequest): Promise<WhiteLocalLogUploadResult>; 上传本地日志;日志运行时和上传开关均需可用,enabled/ enabledUpload 未设置为 false 时默认尝试开启。通过返回结果和状态事件观察上传。 Promise<WhiteLocalLogUploadResult>