Whiteboard SDK Reference
Generated from the public Web/Android/iOS interfaces: classes, methods, events, error codes and capability scope.
Web SDK
TypeScript implementation with REST persistence and LiveKit data-channel sync, covering rooms, scenes, undo/redo, camera and replay.
| Class | Methods | Not supported in the current version |
|---|---|---|
Camera | fitToContent panBy setBounds setViewport setViewport0 toScreen toWorld viewport zoomTo | — |
LiveKitWhiteboardSync | publish receive subscribe | — |
LoopbackWhiteboardSync | publish subscribe | — |
Member | setAppliance setStrokeStyle setWritable writable | — |
Player | currentFrame duration emitState pause phase play progressTime seek status stop tick | — |
Replay | — | |
Room | addPage applyMutation applyState canRedoSteps canUndoSteps connect drawStroke eraseStroke exportSnapshot insertImage leave loadSnapshot mapUndoError member memberRole memberStateForSelf moveCamera phase receive redo refresh replay requireMember roomInfo roomState setAppliance setPhase setScenePath setWritable svgUrl undo updateSceneCount upsertMember writable | — |
Scene | content current currentScenePath insertPage pages removePage roomUUID switchTo | removePage → NOT_SUPPORTED |
WhiteboardError | toJSON | — |
WhiteboardHttpTransport | withToken | — |
WhiteboardSdk | createRoom createRoomToken createSdkToken getRoom joinRoom listRooms replay replaySnapshot transport | — |
Android (interface definitions, runtime not available)
Android / iOS currently provide interface definitions only; calls return `WhiteboardError.code = NOT_SUPPORTED` and never silently succeed.
NOT_SUPPORTED Interfaces / classes: 81 · Interface members: 81
| Class | Methods |
|---|---|
com.herewhite.sdk._white_sdk_configuration.PptParams | 2 |
com.herewhite.sdk._white_sdk_configuration.RenderEngineType | 0 |
com.herewhite.sdk._white_sdk_configuration.SlideAppOptions | 0 |
com.herewhite.sdk.AbstractCommonCallbacks | 6 |
com.herewhite.sdk.AbstractPlayerEventListener | 8 |
com.herewhite.sdk.AbstractRoomCallbacks | 7 |
com.herewhite.sdk.AudioMixerBridge | 5 |
com.herewhite.sdk.AudioMixerImplement | 1 |
com.herewhite.sdk.combine_player._native_player.NativePlayerPhase | 0 |
com.herewhite.sdk.combine_player._player_sync_manager.Callbacks | 2 |
com.herewhite.sdk.combine_player.NativePlayer | 4 |
com.herewhite.sdk.combine_player.PlayerSyncManager | 7 |
com.herewhite.sdk.CommonCallback | 7 |
com.herewhite.sdk.CommonCallbacks | 0 |
com.herewhite.sdk.Displayer | 19 |
com.herewhite.sdk.domain._content_mode_config.ScaleMode | 0 |
com.herewhite.sdk.domain._logger_options.Level | 0 |
com.herewhite.sdk.domain._logger_options.ReportMode | 0 |
com.herewhite.sdk.domain._window_app_param.Attributes | 0 |
com.herewhite.sdk.domain._window_app_param.Options | 0 |
com.herewhite.sdk.domain._window_app_param.ProjectorAttributes | 0 |
com.herewhite.sdk.domain._window_app_param.ProjectorOptions | 0 |
com.herewhite.sdk.domain._window_docs_event.Options | 0 |
com.herewhite.sdk.domain.AkkoEvent | 5 |
com.herewhite.sdk.domain.AnimationMode | 0 |
com.herewhite.sdk.domain.Appliance | 14 |
com.herewhite.sdk.domain.BroadcastState | 3 |
com.herewhite.sdk.domain.CameraBound | 15 |
com.herewhite.sdk.domain.CameraConfig | 8 |
com.herewhite.sdk.domain.CameraState | 3 |
com.herewhite.sdk.domain.ConnectionPrepareParam | 4 |
com.herewhite.sdk.domain.ContentModeConfig | 6 |
com.herewhite.sdk.domain.EventEntry | 3 |
com.herewhite.sdk.domain.EventListener | 1 |
com.herewhite.sdk.domain.FontFace | 7 |
com.herewhite.sdk.domain.FrequencyEventListener | 1 |
com.herewhite.sdk.domain.GlobalState | 0 |
com.herewhite.sdk.domain.ImageInformation | 12 |
com.herewhite.sdk.domain.ImageInformationWithUrl | 11 |
com.herewhite.sdk.domain.LoggerOptions | 10 |
com.herewhite.sdk.domain.MemberInformation | 9 |
com.herewhite.sdk.domain.MemberState | 24 |
com.herewhite.sdk.domain.PlayerConfiguration | 16 |
com.herewhite.sdk.domain.PlayerObserverMode | 0 |
com.herewhite.sdk.domain.PlayerPhase | 0 |
com.herewhite.sdk.domain.PlayerState | 0 |
com.herewhite.sdk.domain.PlayerTimeInfo | 4 |
com.herewhite.sdk.domain.Point | 4 |
com.herewhite.sdk.domain.PptPage | 9 |
com.herewhite.sdk.domain.Promise | 0 |
com.herewhite.sdk.domain.RectangleConfig | 11 |
com.herewhite.sdk.domain.Region | 0 |
com.herewhite.sdk.domain.RoomMember | 5 |
com.herewhite.sdk.domain.RoomOptimizeOptions | 0 |
com.herewhite.sdk.domain.RoomPhase | 0 |
com.herewhite.sdk.domain.RoomState | 3 |
com.herewhite.sdk.domain.Scene | 6 |
com.herewhite.sdk.domain.SceneState | 3 |
com.herewhite.sdk.domain.ShapeType | 0 |
com.herewhite.sdk.domain.SlideErrorType | 0 |
com.herewhite.sdk.domain.UrlInterrupter | 1 |
com.herewhite.sdk.domain.ViewMode | 0 |
com.herewhite.sdk.domain.WhiteDisplayerState | 5 |
com.herewhite.sdk.domain.WhiteObject | 0 |
com.herewhite.sdk.domain.WhiteScenePathType | 0 |
com.herewhite.sdk.domain.WindowAppParam | 1 |
com.herewhite.sdk.domain.WindowAppSyncAttrs | 0 |
com.herewhite.sdk.domain.WindowDocsEvent | 6 |
com.herewhite.sdk.domain.WindowParams | 2 |
com.herewhite.sdk.Player | 13 |
com.herewhite.sdk.PlayerEventListener | 0 |
com.herewhite.sdk.PlayerListener | 8 |
com.herewhite.sdk.Room | 56 |
com.herewhite.sdk.RoomCallbacks | 0 |
com.herewhite.sdk.RoomListener | 7 |
com.herewhite.sdk.RoomParams | 34 |
com.herewhite.sdk.WhiteboardView | 1 |
com.herewhite.sdk.WhiteSdk | 18 |
com.herewhite.sdk.WhiteSdkConfiguration | 32 |
com.herewhite.sdk.window.SlideListener | 2 |
Es | 0 |
iOS (interface definitions, runtime not available)
Android / iOS currently provide interface definitions only; calls return `WhiteboardError.code = NOT_SUPPORTED` and never silently succeed.
NOT_SUPPORTED Interfaces / classes: 58 · Interface members: 58
| Class | Methods |
|---|---|
Whiteboard.WhiteAnimationMode | 0 |
Whiteboard.WhiteAppParam | 3 |
Whiteboard.WhiteAppSyncAttributes | 5 |
Whiteboard.WhiteAudioMixerBridge | 2 |
Whiteboard.WhiteAudioMixerBridgeDelegate | 5 |
Whiteboard.WhiteBoardView | 4 |
Whiteboard.WhiteBroadcasterInformation | 2 |
Whiteboard.WhiteBroadcastState | 3 |
Whiteboard.WhiteCameraBound | 9 |
Whiteboard.WhiteCameraConfig | 4 |
Whiteboard.WhiteCameraState | 3 |
Whiteboard.WhiteCombineDelegate | 8 |
Whiteboard.WhiteCombinePlayer | 10 |
Whiteboard.WhiteCommonCallbackDelegate | 9 |
Whiteboard.WhiteCommonCallbacks | 1 |
Whiteboard.WhiteContentMode | 0 |
Whiteboard.WhiteContentModeConfig | 4 |
Whiteboard.WhiteDisplayer | 18 |
Whiteboard.WhiteDisplayerState | 5 |
Whiteboard.WhiteEvent | 6 |
Whiteboard.WhiteFontFace | 5 |
Whiteboard.WhiteGlobalState | 0 |
Whiteboard.WhiteImageInformation | 9 |
Whiteboard.WhiteMemberInformation | 4 |
Whiteboard.WhiteMemberState | 8 |
Whiteboard.WhiteObserverMode | 0 |
Whiteboard.WhitePanEvent | 2 |
Whiteboard.WhitePlayer | 13 |
Whiteboard.WhitePlayerConfig | 10 |
Whiteboard.WhitePlayerEvent | 1 |
Whiteboard.WhitePlayerEventDelegate | 9 |
Whiteboard.WhitePlayerPhase | 0 |
Whiteboard.WhitePlayerState | 1 |
Whiteboard.WhitePlayerTimeInfo | 4 |
Whiteboard.WhitePptPage | 5 |
Whiteboard.WhitePptParams | 1 |
Whiteboard.WhiteReadonlyMemberState | 10 |
Whiteboard.WhiteRectangleConfig | 7 |
Whiteboard.WhiteRoom | 63 |
Whiteboard.WhiteRoomCallbackDelegate | 9 |
Whiteboard.WhiteRoomCallbacks | 1 |
Whiteboard.WhiteRoomConfig | 20 |
Whiteboard.WhiteRoomMember | 4 |
Whiteboard.WhiteRoomPhase | 0 |
Whiteboard.WhiteRoomState | 3 |
Whiteboard.WhiteScene | 4 |
Whiteboard.WhiteScenePathType | 0 |
Whiteboard.WhiteSceneState | 3 |
Whiteboard.WhiteSDK | 16 |
Whiteboard.WhiteSdkConfiguration | 18 |
Whiteboard.WhiteSlideAppParams | 9 |
Whiteboard.WhiteSlideDelegate | 2 |
Whiteboard.WhiteSliderView | 2 |
Whiteboard.WhiteSyncManagerPauseReason | 0 |
Whiteboard.WhiteVideoView | 1 |
Whiteboard.WhiteViewMode | 0 |
Whiteboard.WhiteWindowDocsEventOptions | 1 |
Whiteboard.WhiteWindowParams | 2 |
Error codes
| code | Handling |
|---|---|
INVALID_PARAMETER | invalid_parameter |
INVALID_TOKEN | invalid_token |
TOKEN_EXPIRED | token_expired |
TOKEN_ROLE_FORBIDDEN | whiteboard_token_role_forbidden |
TOKEN_ROOM_MISMATCH | whiteboard_token_room_mismatch |
ROOM_NOT_FOUND | whiteboard_room_not_found |
ROOM_BANNED | whiteboard_room_banned |
ROOM_CLOSED | whiteboard_room_closed |
SCENE_NOT_FOUND | whiteboard_scene_not_found |
STROKE_NOT_FOUND | whiteboard_stroke_not_found |
INVALID_SCENE_PATH | whiteboard_invalid_scene_path |
INVALID_OPERATION | whiteboard_invalid_operation |
UNDO_EMPTY | whiteboard_undo_empty |
REDO_EMPTY | whiteboard_redo_empty |
VERSION_CONFLICT | whiteboard_version_conflict |
NETWORK_ERROR | network_error |
NOT_SUPPORTED | NOT_SUPPORTED |