# Room (/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room)
> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).
```ts
export declare interface Room extends Displayer
```
## 成员 [#成员]
- [uuid](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#uuid)
- [uid](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#uid)
- [session](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#session)
- [roomToken](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#roomtoken)
- [phase](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#phase)
- [calibrationTimestamp](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#calibrationtimestamp)
- [state](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#state)
- [isWritable](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#iswritable)
- [canUndoSteps](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#canundosteps)
- [canRedoSteps](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#canredosteps)
- [disableDeviceInputs](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#disabledeviceinputs)
- [disableEraseImage](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#disableeraseimage)
- [disableSerialization](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#disableserialization)
- [timeDelay](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#timedelay)
- [syncMode](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#syncmode)
- [useNativeClipboard](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#usenativeclipboard)
- [setWritable](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#setwritable)
- [setGlobalState](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#setglobalstate)
- [setMemberState](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#setmemberstate)
- [setViewMode](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#setviewmode)
- [setScenePath](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#setscenepath)
- [setSceneIndex](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#setsceneindex)
- [syncBlockTimestamp](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#syncblocktimestamp)
- [stopBlockTimestamp](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#stopblocktimestamp)
- [dispatchMagixEvent](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#dispatchmagixevent)
- [putScenes](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#putscenes)
- [cleanCurrentScene](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#cleancurrentscene)
- [removeScenes](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#removescenes)
- [moveScene](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#movescene)
- [exportScene](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#exportscene)
- [importScene](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#importscene)
- [insertImage](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#insertimage)
- [lockImage](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#lockimage)
- [completeImageUpload](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#completeimageupload)
- [getImagesInformation](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#getimagesinformation)
- [createInvisiblePlugin](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#createinvisibleplugin)
- [insertPlugin](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#insertplugin)
- [removePlugin](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#removeplugin)
- [updatePlugin](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#updateplugin)
- [getPluginAttributes](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#getpluginattributes)
- [getPluginRectangle](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#getpluginrectangle)
- [duplicate](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#duplicate)
- [copy](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#copy)
- [paste](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#paste)
- [undo](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#undo)
- [redo](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#redo)
- [clearUndoHistory](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#clearundohistory)
- [delete](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#delete)
- [lockImages](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#lockimages)
- [moveSelectedComponentsToTop](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#moveselectedcomponentstotop)
- [moveSelectedComponentsToBottom](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#moveselectedcomponentstobottom)
- [insertText](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#inserttext)
- [updateText](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#updatetext)
- [updateSelectedText](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#updateselectedtext)
- [pptNextStep](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#pptnextstep)
- [pptPreviousStep](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#pptpreviousstep)
- [disconnect](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#disconnect)
- [uploadLocalLogs](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room#uploadlocallogs)
## 继承自 Displayer [#继承自-displayer]
## Properties [#properties]
### uuid [#uuid]
readonly uuid: string;
```text
房间的 ``uuid``,用于唯一标识该房间。
```
### uid [#uid]
readonly uid: string;
```text
加入该房间的用户的唯一标识符
```
### session [#session]
readonly session: string;
```text
房间当前的 Session 的 ``uuid``。会被上报作为日志字段(如果开启了自动日志上报功能)。如果当前尚未与服务器建立连接,则为 ``undefined``。
```
### roomToken [#roomtoken]
readonly roomToken: string;
```text
房间 Token,即加入房间时传入的字段。
```
### phase [#phase]
readonly phase: RoomPhase;
```text
房间连接所处的阶段
```
### calibrationTimestamp [#calibrationtimestamp]
readonly calibrationTimestamp: number;
```text
与服务器时钟校准后的当前时间戳,单位为毫秒
```
### state [#state]
readonly state: RoomState;
```text
业务状态
阅读 [《房间与回放的业务状态管理》](/javascript-zh/home/business-state-management) 、[《房间业务状态管理》](/document-zh/home/business-state-management) 以了解更多。
```
### isWritable [#iswritable]
readonly isWritable: boolean;
```text
房间是否「可写」
```
### canUndoSteps [#canundosteps]
readonly canUndoSteps: number;
```text
可撤销步骤。即此时此刻,还可以调用多少次 ``room.undo()`` 方法。
```
### canRedoSteps [#canredosteps]
readonly canRedoSteps: number;
```text
可重做步骤。即此时此刻,还可以调用多少次 ``room.redo()`` 方法。
```
### disableDeviceInputs [#disabledeviceinputs]
disableDeviceInputs: boolean;
```text
是否禁止设备操作。
注意区分「只读模式」与「禁止设备操作」,具体参考进阶教程[《禁止设备操作|禁止操作》](/javascript-zh/home/disable#禁止设备操作)。
```
### disableEraseImage [#disableeraseimage]
disableEraseImage: boolean;
```text
是否禁止橡皮擦除图片
```
### disableSerialization [#disableserialization]
disableSerialization: boolean;
```text
是否禁止如下方法(默认值是 ``true``)。可修改。
- ``room.redo``
- ``room.undo``
- ``room.duplicate``
- ``room.copy``
- ``room.paste``
房间内所有人的 ``white-web-sdk`` 的版本必须不低于 ``2.9.3`` 时,才能将该值设为 ``false``。房间内任何一个人将该值设为 ``false``,都会导致房间内低于 ``2.9.3`` 的用户前端报错且不能正常使用。
```
### timeDelay [#timedelay]
timeDelay: number;
```text
主动延迟接收的远端消息,单位是毫秒,默认值 ``0``。将该值设置成大于 ``0`` 的数字,可以人为造成类似网络时延的效果。可修改。
```
### syncMode [#syncmode]
syncMode: boolean;
```text
默认情况下,所有同步消息会按比较平滑的速度处理,以此保证观感的流畅性。
如果设置此项为 ``true``,则所有消息一经收到立刻处理,从而保证同步的实时性。
```
### useNativeClipboard [#usenativeclipboard]
useNativeClipboard: boolean;
```text
是否使用原生剪贴板。
设为 ``true`` 后,快捷键里的复制和粘贴将失效而使用原生 ``copy`` ``paste`` 事件。
此功能需要浏览器支持以及用户授予剪贴板权限,如果失败,将自动回退到虚拟剪贴板实现。
```
### createInvisiblePlugin [#createinvisibleplugin]
createInvisiblePlugin<K extends string, A extends Object, MA extends Object, P extends InvisiblePlugin<A, MA>>(pluginClass: InvisiblePluginClass<K, A, MA, P>, attributes: A): Promise<InvisiblePlugin<A, MA>>;
### callbacks [#callbacks]
readonly callbacks: Callbacks<CALLBACKS>;
### observerId [#observerid]
readonly observerId: number;
### region [#region]
readonly region: string;
### slice [#slice]
readonly slice: string;
### version [#version]
readonly version: string;
### deviceType [#devicetype]
readonly deviceType: DeviceType;
### screenType [#screentype]
readonly screenType: ScreenType;
### enableWriteNow [#enablewritenow]
readonly enableWriteNow: boolean;
### handToolKey [#handtoolkey]
readonly handToolKey: string | undefined;
### views [#views]
readonly views: Views;
### useMobXState [#usemobxstate]
readonly useMobXState: boolean;
### useMultiViews [#usemultiviews]
readonly useMultiViews: boolean;
### handToolActive [#handtoolactive]
handToolActive: boolean;
### disableOthersSelectingBox [#disableothersselectingbox]
disableOthersSelectingBox: boolean;
### disableCameraTransform [#disablecameratransform]
disableCameraTransform: boolean;
### commandWheelToZoom [#commandwheeltozoom]
commandWheelToZoom: boolean;
### dynamicConfig [#dynamicconfig]
readonly dynamicConfig?: DynamicConfigSnapshot;
加入房间时完成求值的远端参数快照。
### dynamicConfigState [#dynamicconfigstate]
readonly dynamicConfigState?: DynamicConfigState;
本次配置来源、运行时匹配和失败回退原因;不是配置文件原文。
## Methods [#methods]
### setWritable [#setwritable]
setWritable(isWritable: boolean): Promise<void>;
```text
修改 ``room.isWritable`` 的值。
该操作会向服务器发起请求,因此会返回一个 ``Promise`` 对象。注意通过 ``.catch()`` 的方式处理异常流程,因为请求可能被服务器拒绝,或失败。
```
Promise<void>
### setGlobalState [#setglobalstate]
setGlobalState(modifyState: Partial<GlobalState>): GlobalState;
````text
用于修改房间的 ``globalState`` 的字段。可以通过如下方法修改特定字段。
@example
```typescript
room.setGlobalState({
foobar: "hello world",
});
```
也可以通过将某个字段置为 ``undefined``,来删掉该字段。
@example
```typescript
room.setGlobalState({
foobar: undefined,
});
```
````
GlobalState
### setMemberState [#setmemberstate]
setMemberState(modifyState: Partial<MemberState>): MemberState;
````text
用于修改房间的 ``memberState`` 的字段。可以通过如下方法修改特定字段。
@example
```typescript
room.setMemberState({
foobar: "hello world",
});
```
@example
也可以通过将某个字段置为 ``undefined``,来删掉该字段。
```typescript
room.setMemberState({
foobar: undefined,
});
```
````
MemberState
### setViewMode [#setviewmode]
setViewMode(viewMode: ViewMode): void;
```text
修改房间的 ``room.state.broadcastState.mode`` 的值。会改变自己或房间内其他人的视角模式。
```
void
### setScenePath [#setscenepath]
setScenePath(scenePath: string): void;
```text
修改当前场景地址,会将切换当前房间的场景。
```
void
### setSceneIndex [#setsceneindex]
setSceneIndex(index: number): void;
```text
修改当前场景的索引号,会将切换当前房间的场景。
```
void
### syncBlockTimestamp [#syncblocktimestamp]
syncBlockTimestamp(timestamp: number): void;
```text
同步阻塞时间戳,以人为制造时延
```
void
### stopBlockTimestamp [#stopblocktimestamp]
stopBlockTimestamp(): void;
```text
停止通过同步阻塞时间戳来人为制作间延
```
void
### dispatchMagixEvent [#dispatchmagixevent]
dispatchMagixEvent(event: string, payload: any): void;
```text
向房间内广播自定义事件。其中,第一参数 ``event`` 是事件的名称,房间内其他成员可以通过它注册监听事件。
第二参数 ``payload`` 是负载,可以是任意类型的值,可根据具体业务自行设计。
```
void
### putScenes [#putscenes]
putScenes(path: string, scenes: ReadonlyArray<SceneDefinition>, index?: number): void;
```text
在房间中插入场景。参考[《插入新场景|场景管理》](/javascript-zh/home/scenes-management#插入新场景)。
@param path 想要插入到的场景组地址
@param scenes 场景描述列表
@param index 从哪个索引所在位置插入
```
void
### cleanCurrentScene [#cleancurrentscene]
cleanCurrentScene(retainPpt?: boolean): void;
```text
清理当前场景内所有内容。第一参数 ``retianPpt``
@param retainPpt 表明是否保留 PPT 背景不被清理,默认值是 ``true``
```
void
### removeScenes [#removescenes]
removeScenes(path: string): void;
```text
在房间中删除场景。参考[《删除场景|场景管理》](/javascript-zh/home/scenes-management#删除场景)。
```
void
### moveScene [#movescene]
moveScene(originalPath: string, targetPath: string): void;
```text
在房间中移动场景。参考[《移动场景|场景管理》](/javascript-zh/home/scenes-management#移动场景)。
```
void
### exportScene [#exportscene]
exportScene(scenePath: string): Promise<Blob>;
```text
导出特定场景路径的板书内容(包含 ppt 内容),可以直接保存为二进制文件(废弃)。
@param scenePath 需要导出场景的路径,必须是 ``ScenePathType`` 为 ``page`` 的路径。
```
void
### importScene [#importscene]
importScene(dir: string, payload: Blob, overrideName?: string): Promise<SceneDefinition>;
```text
导入之前导出的板书内容(废弃)。
@param dir 当前板书内容,需要插入的场景目录位置,该目录的 ScenePathType 可以为空,但是不能为 conflict,这回导致该路径无法成功插入新场景。
@param payload 二进制文件的文件句柄指向
@param overrideName 不使用文件内的 name,改为覆盖指定场景
@returns 板书内部的内容,一定会存在 name 字段,该字段不可更改;最后插入的板书路径为 dir + name。如果想修改板书路径,可以再调用 mvScene API 进行修改。
```
Promise<SceneDefinition>
### insertImage [#insertimage]
insertImage(imageInfo: ImageInformation): void;
```text
在当前场景中插入图片
该操作往往需要和 ``room.completeImageUpload`` 配合使用,具体例子可参考[《插入图片|教具》](/javascript-zh/home/tools#插入图片)。
```
void
### lockImage [#lockimage]
lockImage(uuid: string, locked: boolean): void;
```text
改变图片的锁定状态。若图片被锁定,则无法被框选、无法被拖动、无法被改变大小
@param uuid 图片的 UUID
```
void
### completeImageUpload [#completeimageupload]
completeImageUpload(uuid: string, src: string): void;
```text
设置图片资源。第一参数 ``uuid`` 是图片的唯一标识符,应该与 ``room.insertImage`` 中传入的 ``uuid`` 字段相同。
第二参数 ``src`` 是图片资源的 URL。具体例子可参考[《插入图片|教具》](/javascript-zh/home/tools#插入图片)。
```
void
### getImagesInformation [#getimagesinformation]
getImagesInformation(scenePath: string): ImageInformation[];
```text
导出特定场景的图片信息,注意这些信息可能与插入时填写的不同。
@param scenePath 需要导出图片信息的场景路径,必须是 ``ScenePathType`` 为 ``page`` 的路径。
```
ImageInformation[]
### insertPlugin [#insertplugin]
insertPlugin(kind: string, description?: PluginDescription): Identifier;
Identifier
### removePlugin [#removeplugin]
removePlugin(identifier: Identifier): boolean;
boolean
### updatePlugin [#updateplugin]
updatePlugin(identifier: Identifier, description: PluginDescription): boolean;
boolean
### getPluginAttributes [#getpluginattributes]
getPluginAttributes(identifier: Identifier): any | undefined;
any | undefined
### getPluginRectangle [#getpluginrectangle]
getPluginRectangle(identifier: string): Rectangle | undefined;
Rectangle | undefined
### duplicate [#duplicate]
duplicate(): void;
```text
复刻当前选择工具所选的所有组键件。只有在 ``room.disableSerialization`` 为 ``false`` 的时候可调用。
```
void
### copy [#copy]
copy(): void;
```text
复制当前选择工具所选的所有组键件。只有在 ``room.disableSerialization`` 为 ``false`` 的时候可调用。
```
void
### paste [#paste]
paste(): void;
```text
粘贴上一次复制的组件。只有在 ``room.disableSerialization`` 为 ``false`` 的时候可调用。
```
void
### undo [#undo]
undo(): number;
```text
撤回上一个动作。只有在 ``room.disableSerialization`` 为 ``false`` 的时候可调用。
```
number
### redo [#redo]
redo(): number;
```text
重做上一个动作。只有在 ``room.disableSerialization`` 为 ``false`` 的时候可调用。
```
number
### clearUndoHistory [#clearundohistory]
clearUndoHistory(includeRedo?: boolean): void;
```text
清空可撤回的历史记录, 令 ``canUndoSteps`` 立刻等于 0。
@param includeRedo 是否同时清空重做的记录,默认值是 ``true``
```
void
### delete [#delete]
delete(): void;
```text
删除当前选择工具所选的所有组件。
```
void
### lockImages [#lockimages]
lockImages(locked: boolean): void;
```text
修改当前选中图片的锁定状态
@param locked 是否锁定图片,当图片被锁定时,无法删除、移动、放缩。
```
void
### moveSelectedComponentsToTop [#moveselectedcomponentstotop]
moveSelectedComponentsToTop(): void;
```text
将当前选中的组件移动到顶层
```
void
### moveSelectedComponentsToBottom [#moveselectedcomponentstobottom]
moveSelectedComponentsToBottom(): void;
```text
将当前选中的组件移动到底层
```
void
### insertText [#inserttext]
insertText(x: number, y: number, textContent?: string): Identifier;
```text
在指定位置插入文字
@param x 第一个字的的左侧边中点,世界坐标系中的 x 坐标
@param y 第一个字的的左侧边中点,世界坐标系中的 y 坐标
@param textContent 初始化文字的内容,不传则为空
@returns 该文字的标识符
```
Identifier
### updateText [#updatetext]
updateText(identifier: Identifier, textContent: string): void;
```text
编辑指定文字的内容
@param identifier 文字的标识符。为 ``insertText()`` 的返回值。
@param textContent 文字要改成的内容
```
void
### updateSelectedText [#updateselectedtext]
updateSelectedText(format: TextFormat): void;
```text
修改当前被选中的 text 的状态
```
void
### pptNextStep [#pptnextstep]
pptNextStep(): void;
```text
PPT 翻页到下一页。如果当前 PPT 没有动画,则切换到顺位索引 +1 的场景,如果有动画,则播放下一个动画。
```
void
### pptPreviousStep [#pptpreviousstep]
pptPreviousStep(): void;
```text
PPT 翻页到前一页。如果当前 PPT 没有动画,则切换到顺位索引 -1 的场景,如果有动画,则切换到上一个动画播放完毕的样子。
```
void
### disconnect [#disconnect]
disconnect(options?: RoomDisconnectOptions): Promise<void>;
```text
令房间断开连接。这是一个异步方法,会返回 ``Promise`` 对象。
```
Promise<void>
### uploadLocalLogs [#uploadlocallogs]
uploadLocalLogs(): Promise<WhiteLocalLogUploadResult>;
上传本地日志;日志运行时和上传开关均需可用,enabled/ enabledUpload 未设置为 false 时默认尝试开启。通过返回结果和状态事件观察上传。
```text
主动上传当前房间关联的本地日志。
```
Promise<WhiteLocalLogUploadResult>
### refreshViewSize [#refreshviewsize]
refreshViewSize(): void;
void
### setCameraBound [#setcamerabound]
setCameraBound(cameraBound: CameraBound): void;
void
### createScenesCallback [#createscenescallback]
createScenesCallback(path: string, callbacks?: Partial<ScenesCallbacks>): ScenesCallbacksNode | null;
ScenesCallbacksNode | null
### memberState [#memberstate]
memberState(memberId: number): MemberState;
MemberState
### moveCamera [#movecamera]
moveCamera(camera: Partial<Camera> & Readonly<\{ animationMode?: AnimationMode; \}>): void;
void
### moveCameraToContain [#movecameratocontain]
moveCameraToContain(rectangle: Rectangle & Readonly<\{ animationMode?: AnimationMode; \}>): void;
void
### bindHtmlElement [#bindhtmlelement]
bindHtmlElement(element: HTMLDivElement | null): void;
void
### getInvisiblePlugin [#getinvisibleplugin]
getInvisiblePlugin<A extends Object, MA extends Object>(kind: string): InvisiblePlugin<A, MA> | null;
InvisiblePlugin<A, MA> | null
### convertToPointInWorld [#converttopointinworld]
convertToPointInWorld(point: \{ x: number; y: number; \}): \{ x: number; y: number; \};
\{ x: number; y: number; \}
### scenePreview [#scenepreview]
scenePreview(scenePath: string, div: HTMLElement, width?: number, height?: number, engine?: RenderEngine): void;
void
### generateScreenshot [#generatescreenshot]
generateScreenshot(scenePath?: string, width?: number, height?: number): Promise<string>;
Promise<string>
### fillSceneSnapshot [#fillscenesnapshot]
fillSceneSnapshot(scenePath: string, div: HTMLElement, width?: number, height?: number, engine?: RenderEngine): void;
void
### screenshotToCanvas [#screenshottocanvas]
screenshotToCanvas(context: CanvasRenderingContext2D, scenePath: string, width: number, height: number, camera: Camera, ratio?: number): void;
void
### screenshotToCanvasAsync [#screenshottocanvasasync]
screenshotToCanvasAsync(context: CanvasRenderingContext2D, scenePath: string, width: number, height: number, camera: Camera, ratio?: number, timeout?: number): Promise<void>;
Promise<void>
### getBoundingRect [#getboundingrect]
getBoundingRect(scenePath: string): Rectangle;
Rectangle
### addMagixEventListener [#addmagixeventlistener]
addMagixEventListener(event: string, listener: EventListener, options?: MagixEventListenerOptions): void;
addMagixEventListener(event: string, listener: EventsListener, fireInterval: number): void;
void
void
### removeMagixEventListener [#removemagixeventlistener]
removeMagixEventListener(event: string, listener?: EventListener): void;
void
### waitMagixEvent [#waitmagixevent]
waitMagixEvent(filter: EventFilter): Promise<Event>;
Promise<Event>
### scalePptToFit [#scaleppttofit]
scalePptToFit(animationMode?: AnimationMode): void;
void
### scenePathType [#scenepathtype]
scenePathType(path: string): ScenePathType;
ScenePathType
### entireScenes [#entirescenes]
entireScenes(): SceneMap;
SceneMap
### getScene [#getscene]
getScene(path: string): WhiteScene | undefined;
WhiteScene | undefined