larksr_websdk 3.3.106 → 3.3.107

package/dist/doc/en/config.md

@@ -0,0 +1,228 @@
+# LarkSR Object Parameters
+
+The parameters for creating a LarkSR object are as follows:
+
+```typescript
+/**
+ * LarkSR Configuration Interface
+ */
+interface ILarkSRConfig {
+    /**
+     * Required. Root element. The component will be mounted under the root element.
+     * Note: *Do not* set it to document.documentElement.
+     * In default mode, the root element will be rotated to enforce landscape mode.
+     * @see handleRootElementSize
+     * @see scaleMode
+     */
+    rootElement: HTMLElement;
+    /**
+     * Optional. Server address. The address for accessing the LarkServer frontend.
+     * Example: http://192.168.0.55:8181/
+     * When using managed services, the server address is automatically assigned and can be left empty.
+     * When using managed services, @see CreateLarkSRClientFromePXYHost @see larksr.connectWithPxyHost
+     */
+    serverAddress?: string;
+    /**
+     * Optional. SDK authorization code. If not provided here, it must be initialized in the instance later by calling initSDKAuthCode.
+     */
+    authCode?: string;
+    /**
+     * Optional. Whether the authorization is successful.
+     * @deprecated This parameter is currently not called back. If SDK verification fails, it will return a failure in connect.
+     */
+    authCodeCallback?: (isSuccess: boolean, e: any) => void;
+    /**
+     * Optional. Background image URL during loading.
+     */
+    loadingBgUrl?: string;
+    /**
+     * Optional. Whether to synchronize the size style of the root component.
+     * Enabled by default, setting the root component size to the browser viewport size.
+     * If disabled, the internal components will be displayed according to the size of the passed root element.
+     * Note: When disabled, the root element will not be automatically filled. If the root element height is 0, it will not be displayed.
+     * Note: When disabled, mobileForceLandscape will lose its effect.
+     */
+    handleRootElementSize?: boolean;
+    /**
+     * Same as handleRootElementSize.
+     */
+    handelRootElementSize?: boolean;
+    /**
+     * Whether to only set the rotation of the root component. Only effective when handleRootElementSize is true. Sets the rotation of the root component for mobileForceLandscape mode.
+     * Default is false. In this case, the SDK will set the width, height, margin 0, and padding 0 of the root component.
+     * When true and handleRootElementSize is also true, only the rotation attribute of the root component is set, used for forced landscape mode and switching between forced landscape and portrait modes.
+     * Note: When onlyHandleRootElementTransform is successfully enabled, ensure the size of the root element and call the resize method to notify the update of the root element size when the root element changes.
+     */
+    onlyHandleRootElementTransform?: boolean;
+    /**
+     * Whether to listen to mouse, keyboard, and other input events within the SDK.
+     * If disabled, input events need to be sent manually.
+     * Note: When disabled, full-screen mode and lock mode will be invalid and need to be triggered externally.
+     * @see fullScreenMode
+     */
+    handlInput?: boolean;
+    /**
+     * Whether to attempt muted playback when video autoplay fails. An event will be thrown when muted playback occurs.
+     * When the user interacts with the screen during muted playback, it will attempt to play sound.
+     */
+    mutePlayWhenFailed?: boolean;
+    /**
+     * Optional. Whether it is a VR monitoring type.
+     */
+    isMonitor?: boolean;
+    /**
+     * Optional. Bitrate.
+     */
+    codeRate?: number;
+    /**
+     * Optional. Frame rate.
+     */
+    frameRate?: number;
+    /**
+     * Optional. Audio frame rate.
+     */
+    audioCodeRate?: number;
+    /**
+     * Optional. Log level. Default is warn.
+     */
+    logLevel?: 'info' | 'warn' | 'error';
+    /**
+     * Optional. Loading timeout. Default is 60s. Loading stops after this time.
+     */
+    loadingTimeout?: number;
+    /**
+     * Optional. Whether to automatically synchronize clipboard data.
+     */
+    syncLocalToCloudClipboard?: boolean;
+    /**
+     * Optional. Preferred video codec format.
+     */
+    preferDecoder?: 'auto' | 'vp8' | 'vp9' | 'h264' | 'h265' | 'hevc' | 'av1x';
+    /**
+     * Optional. Video scaling mode within the container.
+     * ScaleMode: 'contain' | 'fill_clip' | 'fill_stretch'
+     * contain: Scales with the original size of the application.
+     * fill_clip: Crop mode, fully fills the screen while maintaining aspect ratio.
+     * fill_stretch: Stretch mode, fully fills the screen without maintaining aspect ratio.
+     * Corresponds to the initial display mode in the backend application management -> application editing -> general advanced settings. This configuration has a higher priority than the backend configuration.
+     */
+    scaleMode?: ScaleMode;
+    /**
+     * Full-screen mode.
+     *  0 -》 Manually triggered by the user.
+     *  1 -》 Triggered on the first click.
+     *  2 -》 Triggered on every click.
+     * Corresponds to the full-screen mode in the backend application management -> application editing -> general advanced settings. This configuration has a higher priority than the backend configuration.
+     */
+    fullScreenMode?: number;
+    /**
+     * Optional. Full-screen mode on mobile devices, same values as fullScreenMode.
+     * Corresponds to the full-screen mode in the backend application management -> application editing -> mobile advanced settings. This configuration has a higher priority than the backend configuration.
+     */
+    mobileFullScreenMode?: number;
+    /**
+     * Optional. Whether to force landscape mode on mobile devices.
+     * Corresponds to whether to force landscape mode on mobile devices in the backend application management -> application editing -> mobile advanced settings. This configuration has a higher priority than the backend configuration.
+     */
+    mobileForceLandscape?: boolean;
+    /**
+     * Optional.
+     * Initial mouse mode, 0 for automatic detection, 1 for locked, 2 for unlocked.
+     * Corresponds to the initial mouse mode in the backend application management -> application editing -> general advanced settings. This configuration has a higher priority than the backend configuration.
+     */
+    initCursorMode?: boolean;
+    /**
+     * Optional.
+     * External port mapping of the rendering server.
+     * Format: key=[Rendering Server IP:PORT] value=[External IP:PORT]
+     * {
+     *    "RENDER-A-IP:RENDER-A-PORT1": "PUBLIC-A-IP:PORT1",
+     *    "RENDER-B-IP:RENDER-B-PORT1": "PUBLIC-A-IP:PORT2",
+     *    "RENDER-C-IP:RENDER-C-PORT1": "PUBLIC-A-IP:PORT3",
+     *    "RENDER-D-IP:RENDER-D-PORT1": "PUBLIC-B-IP:PORT1",
+     *    "RENDER-E-IP:RENDER-E-PORT1": "PUBLIC-B-IP:PORT2",
+     *    "RENDER-E-IP:RENDER-E-PORT2": "PUBLIC-C-IP:PORT1",
+     * }
+     */
+    publicPortMapping?: PublicPortMapping;
+    /**
+     * Optional.
+     * Whether to prompt for text input APP_REQUEST_INPUT.
+     * When the server detects an input method event, an event will be thrown. You can add an input box on the web layer and use inputText to send text to the cloud.
+     * Enabled by default. When manually disabled, the APP_REQUEST_INPUT event will not be thrown.
+     */
+    textInputEventPrompt?: boolean;
+    /**
+     * Optional.
+     * Whether to automatically connect to audio devices when the audio input feature is enabled.
+     * Disabled by default.
+     * Note that the default audio device of the system is enabled by default.
+     */
+    audioInputAutoStart?: boolean;
+    /**
+     * Optional.
+     * Whether to automatically connect to video devices when the video input feature is enabled.
+     * Disabled by default.
+     * Note that the default video device of the system is enabled by default.
+     */
+    videoInputAutoStart?: boolean;
+    /**
+     * Optional.
+     * mouseZoomDirection
+     * Used for the correspondence between pinch zoom operations on mobile devices and application mouse zoom.
+     * 1: Mouse wheel up to zoom in,
+     * 0: Mouse wheel down to zoom in (default).
+     */
+    mouseZoomDirection?: number;
+    /**
+     * Optional.
+     * Touch operation mode, whether the touch operation on mobile devices corresponds to the touch screen or mouse on the cloud.
+     * 'touchScreen' | 'mouse'
+     * Touch operation mode, corresponds to the touch operation mode in the backend application management -> application editing -> mobile advanced settings. This configuration has a higher priority than the backend configuration.
+     */
+    touchOperateMode?: 'touchScreen' | 'mouse';
+    /**
+     * Optional.
+     * Prefer to use the external IP for peer-to-peer connection of the rendering server.
+     * If configured, it will override the preferPublicIp parameter set in the backend.
+     */
+    preferPublicIp?: string;
+    /**
+     * Optional.
+     * Whether to autoplay. Enabled by default.
+     * If disabled, there will be a prompt UI after a successful connection, and the user needs to trigger it manually.
+     * Enabling autoplay does not guarantee that all browsers will autoplay successfully. When playback fails or the browser does not support autoplay,
+     * a play button will be displayed, and the user needs to click the play button to play manually.
+     */
+    autoPlay?: boolean;
+    /**
+     * Optional.
+     * Whether to display the play button in case of playback failure or manual playback mode.
+     * Enabled by default. Note that if disabled, you need to add prompts or UI to guide the user to click play.
+     * In the UI, the user needs to trigger larksr.videoComponent.playVideo();
+     */
+    showPlayButton?: boolean;
+    /**
+     * Optional.
+     * Language settings, currently only supports Chinese and English, default is Chinese.
+     * zh-CN for Chinese, en for English.
+     */
+    language?: string;
+    /**
+     * Timeout for receiving video streams or successful playback after a successful peer-to-peer connection. In autoplay mode, a prompt button will pop up after the timeout.
+     * Default is 20s.
+     */
+    playTimeout?: number;
+    /**
+     * Whether to use the new camera/microphone protocol.
+     * Separate upload process requires rendering server version greater than 3290.
+     */
+    useSeparateMediaSharePeer?: boolean;
+    /**
+     * Whether to enable canvas rendering. Disabled by default.
+     * Note that enabling canvas on mobile devices will consume additional performance.
+     * Known issue: On iOS, when canvas mode is disabled, the stretch mode that ignores the aspect ratio is invalid.
+     */
+    enableCanvasRender?: boolean;
+}
+```

package/dist/doc/en/dev.md

@@ -0,0 +1,84 @@
+# Dev Branch Current Version 3.2.4-dev.0.1
+
+> The Dev branch includes unreleased server-side features. Used for testing and debugging.
+
+## New Features in 3.2.4-dev.0.1
+
+> The following sample code assumes that the `larksr` object has been initialized and connected successfully.
+> Test demo: https://github.com/ParaverseTechnology/lark_sr_websdk_demos/tree/gh-pages
+
+(1). Added multi-channel media upload feature on the Web. Use `larksr.getMediaSharePeerConnection(index)` to get the media upload channel.
+
+The index supports 0 - 5. The operations for opening media after obtaining the media channel are the same as the previous interface. The original interface is equivalent to `getMediaSharePeerConnection(0)`.
+
+Usage example:
+
+```javascript
+larksr.getMediaSharePeerConnection(0).openVideo();
+larksr.getMediaSharePeerConnection(0).closeVideo();
+```
+
+> When connected to older versions of the rendering server that do not support multi-channel uploads, only channel 0 will work.
+
+(2). Get the connection status of a specific channel using `getStats`
+
+```javascript
+larksr.getMediaSharePeerConnection(0).getStats()
+.then((res) => {
+    console.log("state: ", res);
+})
+.catch((e) => {
+    console.log("get state failed", e);
+})
+```
+
+(3). Set the video codec for a specific connection channel using `preferVideoCode`
+
+```javascript
+larksr.getMediaSharePeerConnection(0).preferVideoCode = 'h264';
+```
+
+> If the current browser supports the specified video codec, it will be used preferentially. If not, the default codec will be used.
+> The setting will take effect the next time the video is opened. The already opened video channel will not change.
+
+(4). Set the video upload bitrate for a specific connection channel
+
+```javascript
+larksr.getMediaSharePeerConnection(0).codeRate = {
+        start: 1000,
+        min: 1000,
+        max: 20000,
+}
+```
+
+> The setting will take effect the next time the video is opened. The already opened video channel will not change.
+
+(5). Media connection channels can listen to events individually, for example:
+
+```javascript
+larksr.getMediaSharePeerConnection(0).on("rtc_state_change", function(e) {
+    console.log("ice state change", e);
+});
+```
+
+(6). The opened or saved media channel object has a unique id, 0 - 5
+
+```javascript
+larksr.getMediaSharePeerConnection(0).id
+```
+
+(7). Force the use of canvas mode, and the video channel's canvas can rotate the image clockwise or counterclockwise.
+
+Enable rotation:
+
+```javascript
+larksr.getMediaSharePeerConnection(0).forceRenderToCanvas = true;
+```
+
+Force clockwise rotation:
+
+```javascript
+larksr.getMediaSharePeerConnection(0).canvasRender.setRotate(true);
+```
+
+> The setting will take effect the next time the video is opened. The already opened video channel will not change.

package/dist/doc/en/event_codes.md

@@ -0,0 +1,286 @@
+# Event Codes
+
+The `code` field is attached to the events `LarkEvent = 'larkevent'`, `ERROR = 'error'`, `INFO = 'info'`. The specific values are listed below as `LarkEventType`.
+All event codes may be thrown in the `LarkEvent` event.
+
+The `LarkEventType` event codes are also used for listening to event codes when using the iframe poster method. For iframe embedding client and using event codes, refer to the demo: [larkwebclient-iframe-demos](https://github.com/ParaverseTechnology/larkwebclient-iframe-demos)
+
+```typescript
+//
+// Unified client event codes.
+//
+export enum LarkEventType {
+    // Web client loaded successfully (added in 3.1.8.1)
+    LK_WEB_CLIENT_LOAD_SUCCESS                       = 1,
+    // Enter application interface call
+    LK_TASK_CREATE_SUCCESS                           = 10,
+    LK_TASK_CREATE_FAILED                            = 11,
+    // Insufficient rendering resources
+    LK_RESOURCE_NOT_ENOUGH                           = 12,
+    // Synchronizing application
+    LK_TASK_SYNC_APP                                 = 20,
+    // Sync task failed (added in 3.1.8.1)
+    LK_TASK_SYNC_APP_FAILED                          = 21,
+    //
+    // Connect to application server events. Thrown when directly connecting to the rendering server
+    // Message source: websocket connection events
+    //
+    // Connected to rendering server successfully
+    LK_RENDER_SERVER_CONNECTED                       = 100,
+    // Failed to connect to rendering server
+    LK_RENDER_SERVER_FAILED                          = 101,
+    // Connection to rendering server closed
+    LK_RENDER_SERVER_CLOSE                           = 102,
+    // Connection to rendering server error
+    LK_RENDER_SERVER_ERROR                           = 103,
+
+    //
+    // Connect to websocket proxy server events
+    // Message source: websocket proxy connection events
+    //
+    // Connected to proxy server successfully
+    LK_PROXY_SERVER_CONNECTED                        = 200,
+    // Failed to connect to proxy server
+    LK_PROXY_SERVER_FAILED                           = 201,
+    // Connection to proxy server closed
+    LK_PROXY_SERVER_CLOSE                            = 202,
+    // Connection to proxy server error
+    LK_PROXY_SERVER_ERROR                            = 203,
+
+    //
+    // Version check
+    // Message source: server protocol response ToClientMessage->VersionCheckResponse
+    //
+    // Version check successful
+    LK_VERSION_CHECK_SUCCESS                         = 300,
+    // Version check failed
+    LK_VERSION_CHECK_FAILED                          = 301,
+
+    //
+    // Task check
+    // Message source: server protocol response ToClientMessage->TaskResponse
+    //
+    // Request task successful
+    LK_TASK_SUCCESS                                  = 400,
+    // Task not found
+    LK_TASK_NOTFOUND                                 = 401,
+    // Server error
+    LK_TASK_SERVER_ERROR                             = 402,
+    // Application parameter error
+    LK_TASK_APP_WRONGPARAM                           = 403,
+    // Task obtained successfully, but no GPU resources available
+    LK_TASK_NO_GPU_RESOURCE                          = 404,
+
+    //
+    // Start streaming
+    // Message source: server protocol response ToClientMessage->StartStreamResponse
+    //
+    // Start streaming successful
+    LK_START_STREAM_SUCCESS                           = 500,
+    // Start streaming process failed
+    LK_START_STREAM_PROCESS_START_FAILED              = 501,
+    // Start streaming timeout
+    LK_START_STREAM_PROCESS_START_TIMEOUT             = 502,
+    // Not streaming
+    LK_START_STREAM_NOT_STREAMING                     = 503,
+    // Streaming encoder error
+    LK_START_STREAM_ENCODER_ERROR                     = 504,
+
+    //
+    // RTC events
+    // Message source: webrtc connection events and ToClientMessage->WebrtcError
+    //
+    // RTC connection successful
+    LK_RTC_EVENT_PEERCONNECTION_CONNECTED             = 600,
+    // RTC connection closed
+    LK_RTC_EVENT_PEERCONNECTION_CLOSED                = 601,
+    // RTC connection error
+    LK_RTC_EVENT_PEERCONNECTION_ERROR                 = 602,
+    // RTC creation error, usually due to browser not supporting webrtc
+    // Added in 3.2.0.14
+    LK_RTC_EVENT_PEERCONNECTION_CREATE_FAILED         = 603,
+    // RTC state report (rtt, bitrate, etc.) Added in 3.1.1.8
+    LK_RTC_EVENT_PEERCONNECTION_STATE                 = 610,
+    // RTC retry Added in 3.1.6.2
+    LK_RTC_EVENT_PEERCONNECTION_RETRY                 = 611,
+
+    //
+    // Load video stream
+    // Message source: browser or native component Fixed in 3.1.6.2
+    //
+    LK_VIDEO_LOADED                                  = 700,
+    // Video autoplay failed, request manual trigger (3.1.8.2)
+    LK_VIDEO_PLAY_FAILED                             = 701,
+    // Received cloud video stream but not started playing (3.1.8.3)
+    LK_GOT_REMOTE_STREAM                             = 710,
+    // Received cloud video stream and started playing (3.2.13.0)
+    LK_VIDEO_PLAY_SUCCSS                             = 711,
+
+    //
+    // Server-initiated logout
+    // Message source: backend protocol NotifyClientLogout
+    //
+    LK_NOTIFY_CLIENT_LOGOUT_PLAYER_LOGOUT            = 800,
+    // Host logout in multi-viewer mode
+    LK_NOTIFY_CLIENT_LOGOUT_TASKOWNER_LOGOUT         = 801,
+
+    //
+    // Server pushes cloud application events
+    // Message source: backend protocol AppProcessNotification
+    //
+    LK_APP_PROCESS_NOTIFI_APP_QUIT                   = 900,
+    // No operation timeout (added in 3.1.8.1)
+    LK_NO_OPERATION_TIMEOUT                          = 901,
+    // Loading timeout (added in 3.1.8.8)
+    LK_LOADING_TIMEOUT                               = 902,
+    // Cloud application size change
+    // Added in 3.1.1.8
+    LK_APP_RESIZE                                    = 910,
+    // Cloud application mouse mode change
+    // Added in 3.1.1.8
+    LK_APP_MOUSE_MODE                                = 911,
+    // Received player list
+    // Added in 3.1.1.10
+    LK_APP_PLAER_LIST                                = 912,
+    // APP requests text input
+    LK_APP_REQUEST_TEXT                              = 913,
+    // sdk new
+    // Cloud mouse style
+    LK_APP_CURSOR_STYLE                              = 914,
+    // User manually clicked close button
+    LK_USER_REQUEST_QUIT                             = 920,
+    // Local webpage resize event
+    LK_UI_RESIZE                                     = 930,
+
+    //
+    // XR related events
+    //
+    // Start VR streaming successful
+    LK_STARTVRSTREAM_SUCCESS                            = 1000,
+    // Start VR streaming process failed
+    LK_STARTVRSTREAM_START_PROCESS_FAILED               = 1001,
+    // Start VR streaming driver timeout
+    LK_STARTVRSTREAM_START_DRIVER_RUNTIME_TIMEOUT       = 1002,
+    // Start VR streaming UDP port error
+    LK_STARTVRSTREAM_START_DRIVER_RUNTIME_UDPPORT_ERROR = 1003,
+    // Start VR streaming UDP encoder error
+    LK_STARTVRSTREAM_START_DRIVER_RUNTIME_ENCODER_ERROR = 1004,
+
+    //
+    // UI related event notifications
+    // 
+    // Alert box popup (added in 3.1.8.1)
+    LK_WEBCLIENT_NOTIFY_ALERT                           = 1100,
+    // Confirm box popup (added in 3.1.8.1)
+    LK_WEBCLIENT_NOTIFY_CONFIRM                         = 1101,
+    //
+    LK_WEBCLIENT_TOAST_MSG                              = 1102,
+
+    // User operation triggered events
+    // User screenshot (3.1.8.3)
+    LK_USER_CAPTURE_FRAME                               = 2000,
+    // User screenshot with extra data (3.1.8.8)
+    LK_USER_CAPTURE_FRAME_WITH_EXTRA_DATA               = 2001,
+
+    // External request for screenshot (3.1.8.3)
+    LK_REQUEST_CAPTURE_FRAME                            = 3000,
+    // External request for screenshot with extra data (3.1.8.8)
+    LK_REQUEST_CAPTURE_FRAME_WITH_EXTRA_DATA            = 3001,
+
+    //
+    // iframe external messages to web client
+    //
+    // Operations
+    // Mouse operations
+    LK_IFRAME_POSTER_OPERATE_MOUSE_MOVE               = 10000,
+    LK_IFRAME_POSTER_OPERATE_MOUSE_DOWN               = 10001,
+    LK_IFRAME_POSTER_OPERATE_MOUSE_UP                 = 10002,
+    LK_IFRAME_POSTER_OPERATE_MOUSE_WHEEL              = 10003,
+    // Keyboard operations
+    LK_IFRAME_POSTER_OPERATE_KEY_DOWN                 = 10010,
+    LK_IFRAME_POSTER_OPERATE_KEY_UP                   = 10011,
+    // Touch operations
+    LK_IFRAME_POSTER_OPERATE_TOUCH_DOWN               = 10020,
+    LK_IFRAME_POSTER_OPERATE_TOUCH_MOVE               = 10021,
+    LK_IFRAME_POSTER_OPERATE_TOUCH_UP                 = 10022,
+    // Joystick operations
+    LK_IFRAME_POSTER_OPERATE_GAMEPAD_BUTTON_DOWN      = 10030,
+    LK_IFRAME_POSTER_OPERATE_GAMEPAD_BUTTON_UP        = 10031,
+    LK_IFRAME_POSTER_OPERATE_GAMEPAD_TRIGGER_VALUE    = 10032,
+    LK_IFRAME_POSTER_OPERATE_GAMEPAD_JOYSTICK_STATES  = 10033,
+    // Microphone operations to open or close the default microphone
+    LK_IFRAME_POSTER_OPENAUDIO_INPUT                  = 10040,
+    LK_IFRAME_POSTER_CLOSE_AUDIO_INPUT                = 10041,
+
+    // Functions
+    // Set mouse mode, lock mode and unlock mode
+    LK_IFRAME_POSTER_FUNC_MOUSE_MODE                  = 10100,
+    // Set scale mode
+    LK_IFRAME_POSTER_FUNC_SCALE_MODE                  = 10101,
+    // Restart cloud application (added in 3.1.8.1)
+    LK_IFRAME_POSTER_FUNC_RESTART_CLOUD_APP           = 10102,
+    // WeChat browser load success event (added in 3.1.8.1)
+    LK_IFRAME_POSTER_FUNC_WX_JS_BRIDGE_READY          = 10103,
+    // Request to play video (when video component playback fails and requires user trigger
+    // but client internal alert is disabled)
+    LK_IFRAME_POSTER_FUNC_REQUEST_PLAY_VIDEO          = 10104,
+
+    // Control UI 
+    // Whether to display the desktop control bar
+    LK_IFRAME_POSTER_UI_CONTROLLER_BAR                = 10200,
+    // Whether to display the player list
+    LK_IFRAME_POSTER_UI_PLAYER_LIST                   = 10201,
+    // Whether to display the share URL in share mode
+    LK_IFRAME_POSTER_UI_PLAYER_SHARE_URL              = 10202,
+    // Whether to display the mobile control ball
+    LK_IFRAME_POSTER_UI_MOBILE_CONTROL_BALL           = 10203,
+    // Whether to display the mobile joystick
+    LK_IFRMAE_POSTER_UI_MOBILE_JOYSTICK               = 10204,
+    // Whether to display the mobile virtual keyboard
+    LK_IFRAME_POSTER_UI_MOBILE_VIRTUAL_KEYBOARD       = 10205,
+    // Whether to display the mobile virtual mouse
+    LK_IFRAME_POSTER_UI_MOBILE_VIRTUAL_MOUSE          = 10206,
+    // Whether to display the mobile menu
+    LK_IFRAME_POSTER_UI_MOBILE_MENU                   = 10207,
+    // Whether to force landscape mode on mobile
+    LK_IFRAME_POSTER_UI_MOBILE_FORCE_LANDSCAPE        = 10208,
+    // Whether to display touch points
+    LK_IFRAME_POSTER_UI_MOBILE_TOUCH_POINT            = 10209,
+    // Set Toast display level (added in 3.1.8.1)
+    LK_IFRAME_POSTER_UI_TOAST_LEVEL                   = 10210,
+    // Set Alert display (added in 3.1.8.1)
+    LK_IFRAME_POSTER_UI_ALERT                         = 10211,
+    // Set Confirm display (added in 3.1.8.1)
+    LK_IFRAME_POSTER_UI_CONFIRM                       = 10212,
+    
+
+    //
+    // iframe external messages to web client from datachannel 
+    //
+    LK_DATA_CHANNEL_ESTABLISHED                        = 20000,
+    LK_DATA_CHANNEL_RETYING                            = 20001,
+    LK_DATA_CHANNEL_CLOSE                              = 20002,
+    LK_DATA_CHANNEL_ERROR                              = 20003,
+    LK_DATA_CHANNEL_BINARY_MESSAGE                     = 20004,
+    LK_DATA_CHANNEL_TEXT_MESSAGE                       = 20005,
+    //
+    // iframe external messages to web client to datachannel 
+    //
+    LK_RE_CONNECT_DATA_CHANNEL                         = 20100,
+    LK_CLOSE_DATA_CHANNEL                              = 20101,
+    LK_DATA_CHANNEL_SEND_TEXT                          = 20102,
+    LK_DATA_CHANNEL_SEND_BINARY                        = 20103,
+    //
+    // iframe external messages to web client from datachannel-renderserver
+    //
+    LK_DATA_CHANNEL_RENDERSERVER_OPEN                  = 20200,
+    LK_DATA_CHANNEL_RENDERSERVER_CLOSE                 = 20201,
+    LK_DATA_CHANNEL_RENDERSERVER_BINARY_MESSAGE        = 20202,
+    LK_DATA_CHANNEL_RENDERSERVER_TEXT_MESSAGE          = 20203,
+    //
+    // iframe external messages to web client to datachannel 
+    //
+    LK_DATA_CHANNEL_RENDERSERVER_SEND_TEXT            = 20300,
+    LK_DATA_CHANNEL_RENDERSERVER_SEND_BINARY          = 20301,
+}
+```