# API 参考 (/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/overview)

> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).

## API 类型 [#api-类型]

- AkkoObjectDisposedListener
- AkkoObjectUpdatedListener
- AkkoObjectUpdatedProperty
- [AnimationMode](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/enums/animationmode)
- [ApplianceNames](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/enums/appliancenames)
- [AsyncModuleLoadMode](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/enums/asyncmoduleloadmode)
- BroadcastState
- CNodeProps
- [Callbacks](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/callbacks)
- Camera
- CameraBound
- CameraState
- CameraTransformation
- Color
- ConstructRoomParams
- ContentMode
- ConversionResponse
- ConversionType
- ConvertedFile
- [CurrentStep](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/enums/currentstep)
- [Cursor](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/cursor)
- [CursorAdapter](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/cursoradapter)
- CursorDescription
- [CursorMember](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/cursormember)
- [CursorNames](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/enums/cursornames)
- [DeviceType](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/enums/devicetype)
- [Displayer](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/displayer)
- DisplayerCallbacks
- DisplayerState
- Event
- EventFilter
- EventListener
- [EventPhase](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/enums/eventphase)
- EventScope
- EventsListener
- FloatBarOptions
- GlobalState
- HotKey
- HotKeyChecker
- HotKeyDescription
- HotKeyEvent
- HotKeys
- Identifier
- ImageInformation
- International
- InvisibleCallbacks
- [InvisiblePlugin](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/classes/invisibleplugin)
- InvisiblePluginClass
- InvisiblePluginContext
- JoinRoomParams
- [KeyboardKind](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/enums/keyboardkind)
- LegacyPPT
- LegacyPPTConvertParams
- LegacyPPTConverter
- Level
- Log
- Logger
- LoggerCallbackListener
- LoggerCallbacks
- LoggerOptions
- LoggerPrinter
- [LoggerReportMode](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/enums/loggerreportmode)
- [LowTaskAnimationInterval](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/enums/lowtaskanimationinterval)
- MagixEventListenerOptions
- Margin
- MediaType
- MemberInformation
- MemberState
- NativeEvent
- [NewPencilWritingQuality](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/enums/newpencilwritingquality)
- [ObserverMode](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/enums/observermode)
- [OptimizeOptions](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/optimizeoptions)
- [OriginCoordType](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/enums/origincoordtype)
- PPT
- PPTKind
- PPTTask
- PPTTaskCallbacks
- PPTTaskParams
- PPTTaskProgress
- PPTTaskStatus
- PPTTaskStep
- PlayableCheckingParams
- [Player](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/player)
- PlayerCallbacks
- [PlayerPhase](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/enums/playerphase)
- [PlayerSeekingResult](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/enums/playerseekingresult)
- PlayerState
- Plugin
- PluginDescription
- [PluginInstance](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/plugininstance)
- PluginProps
- [Plugins](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/plugins)
- Point
- PptDescription
- PptParams
- PreviewConfig
- Progress
- RTCClient
- ReconnectionOptions
- Rectangle
- [RenderEngine](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/enums/renderengine)
- RenderPlugin
- ReplayRoomParams
- [Room](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/room)
- RoomCallbacks
- RoomDisconnectOptions
- [RoomErrorLevel](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/enums/roomerrorlevel)
- RoomMember
- [RoomPhase](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/enums/roomphase)
- RoomState
- SceneDefinition
- SceneMap
- [ScenePathType](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/enums/scenepathtype)
- SceneState
- ScenesCallbacks
- [ScenesCallbacksNode](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/scenescallbacksnode)
- [Scope](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/enums/scope)
- [ScreenType](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/enums/screentype)
- [ShapeType](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/enums/shapetype)
- Size
- Status
- TextFormat
- UpdateEventKind
- UserCursorIcons
- UserFonts
- UserPayload
- View
- ViewCallbacks
- [ViewMode](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/enums/viewmode)
- ViewVisionMode
- Views
- WhiteFoundationUnavailableReason
- WhiteLocalLogAutoUploadOptions
- WhiteLocalLogDisconnectOptions
- WhiteLocalLogExportResult
- WhiteLocalLogJoinOptions
- WhiteLocalLogOptions
- WhiteLocalLogState
- WhiteLocalLogTrigger
- WhiteLocalLogUnavailableReason
- WhiteLocalLogUploadRequest
- WhiteLocalLogUploadResult
- WhiteLocalLogUploadStage
- WhiteScene
- [WhiteWebSdk](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/classes/whitewebsdk)
- WhiteWebSdkConfiguration
- WorldViewRectangle
- WrappedComponents

<a id="whiteversion"></a>

### WhiteVersion [#whiteversion]

```text
export declare const WhiteVersion: string;
```

<a id="listenupdated"></a>

### listenUpdated [#listenupdated]

```text
export declare function listenUpdated<T extends Object>(object: T, listener: AkkoObjectUpdatedListener<T>): void;
```

<a id="unlistenupdated"></a>

### unlistenUpdated [#unlistenupdated]

```text
export declare function unlistenUpdated<T extends Object>(object: Object, listener: AkkoObjectUpdatedListener<T>): void;
```

<a id="listendisposed"></a>

### listenDisposed [#listendisposed]

```text
export declare function listenDisposed(object: Object, listener: AkkoObjectDisposedListener): void;
```

<a id="unlistendisposed"></a>

### unlistenDisposed [#unlistendisposed]

```text
export declare function unlistenDisposed(object: Object, listener: AkkoObjectDisposedListener): void;
```

<a id="akkoversion"></a>

### AkkoVersion [#akkoversion]

```text
export declare const AkkoVersion: any;
```

<a id="adminobserverid"></a>

### AdminObserverId [#adminobserverid]

```text
export declare const AdminObserverId: number;
```

<a id="nullidentifier"></a>

### NullIdentifier [#nullidentifier]

```text
export declare const NullIdentifier: any;
```

<a id="cnode"></a>

### CNode [#cnode]

```text
export declare const CNode: ComponentType<CNodeProps>;
```

<a id="previewppt"></a>

### previewPPT [#previewppt]

```text
export declare function previewPPT(conversionResponse: ConversionResponse, container: HTMLDivElement, config?: PreviewConfig, preload?: boolean, userFonts?: UserFonts, logger?: Logger, pptPrams?: PptParams, events?: EventEmitter): EventEmitter;
```

<a id="createplugins"></a>

### createPlugins [#createplugins]

```text
export declare function createPlugins<C_MAP extends Object>(plugins: Readonly<{
    [K: string]: Plugin<any>;
}>): Plugins<C_MAP>;
```

<a id="setasyncmoduleloadmode"></a>

### setAsyncModuleLoadMode [#setasyncmoduleloadmode]

```text
export declare function setAsyncModuleLoadMode(mode: AsyncModuleLoadMode): void;
```

<a id="isroom"></a>

### isRoom [#isroom]

```text
export declare function isRoom(displayer: Displayer): boolean;
```

<a id="isplayer"></a>

### isPlayer [#isplayer]

```text
export declare function isPlayer(displayer: Displayer): boolean;
```

<a id="defaulthotkeys"></a>

### DefaultHotKeys [#defaulthotkeys]

```text
export declare const DefaultHotKeys: Partial<HotKeys>;
```

<a id="createppttask"></a>

### createPPTTask [#createppttask]

```text
export declare function createPPTTask(params: PPTTaskParams): PPTTask;
```

<a id="tojs"></a>

### toJS [#tojs]

```text
export declare function toJS(source: any): any;
```

<a id="contentmodescale"></a>

### contentModeScale [#contentmodescale]

```text
export declare function contentModeScale(scale: number): ContentMode;
```

<a id="contentmodeaspectfit"></a>

### contentModeAspectFit [#contentmodeaspectfit]

```text
export declare function contentModeAspectFit(): ContentMode;
```

<a id="contentmodeaspectfitscale"></a>

### contentModeAspectFitScale [#contentmodeaspectfitscale]

```text
export declare function contentModeAspectFitScale(scale: number): ContentMode;
```

<a id="contentmodeaspectfitspace"></a>

### contentModeAspectFitSpace [#contentmodeaspectfitspace]

```text
export declare function contentModeAspectFitSpace(space: number): ContentMode;
```

<a id="contentmodeaspectfill"></a>

### contentModeAspectFill [#contentmodeaspectfill]

```text
export declare function contentModeAspectFill(): ContentMode;
```

<a id="contentmodeaspectfillscale"></a>

### contentModeAspectFillScale [#contentmodeaspectfillscale]

```text
export declare function contentModeAspectFillScale(scale: number): ContentMode;
```

<a id="displayerconsumer"></a>

### DisplayerConsumer [#displayerconsumer]

```text
export declare const DisplayerConsumer: Consumer<Displayer>;
```

<a id="roomconsumer"></a>

### RoomConsumer [#roomconsumer]

```text
export declare const RoomConsumer: Consumer<Room | undefined>;
```

<a id="playerconsumer"></a>

### PlayerConsumer [#playerconsumer]

```text
export declare const PlayerConsumer: Consumer<Player | undefined>;
```

<a id="injectcustomstyle"></a>

### injectCustomStyle [#injectcustomstyle]

```text
export declare function injectCustomStyle(icons: UserCursorIcons): void;
```

## 动态配置公开类型 [#动态配置公开类型]

- DynamicConfigURLOptions
- DynamicConfigRegionOptions
- DynamicConfigOptions
- DynamicConfigJSON
- DynamicConfigObject
- DynamicConfigSnapshot
- DynamicConfigFieldSource
- DynamicConfigFieldSources
- DynamicConfigState