Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WhiteWebSdk

The WhiteWebSdk class initializes a WhiteWebSdk object.

Hierarchy

  • WhiteWebSdk

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

deviceType

deviceType: DeviceType

The device type, which determines how the SDK handles mouse and touch events.

region

region: string

The data center, which supports the following values:

region Data center Service area
us-sv Silicon Valley, United States North America and South America
sg Singapore Singapore, East Asia, and Southeast Asia
in-mum Mumbai, India India
eu Frankfurt, Europe Europe
cn-hz Hangzhou, China Areas not covered by other data centers

Note

This property must has the same value as the data center that you set when creating the room; otherwise, the SDK fails to connect to the room.

renderEngine

renderEngine: RenderEngine

The rendering mode. See RenderEngine.

screenType

screenType: ScreenType

The user's screen type, which is used to adjust parameters for gesture recognition.

version

version: string

The version of the current SDK.

since

2.13.14

Methods

joinRoom

  • Joins the live Interactive Whiteboard room.

    example
    const joinRoomParams = {...};
const roomCallbacks = {...};

whiteWebSdk.joinRoom(joinRoomParams, roomCallbacks)
           .then(function (room) {
           })
           .catch(function (error) {
           });

    Parameters

    Returns Promise<Room>

    • The Room object, if the method call succeeds. See Room.
    • An error message, if the method call fails.