WMKS Constants

HTML Console SDK methods use the following constants for parameter input and return values. Each description includes an example that lists the constant values.

AudioEncodeType

Types of audio encode methods.

AudioEncodeType: {
        VORBIS: "vorbis",
        OPUS: "opus",
        AAC: "aac"
},

ConnectionState

Describes the state when attempting to connect to a remote VM.

ConnectionState: {
        CONNECTING: "connecting",
        CONNECTED: "connected",
        DISCONNECTED: "disconnected"
},

ErrorType

Errors that can occur when WMKS is connected to a remote VM.

ErrorType: {
        AUTHENTICATION_FAILED: "authenticationfailed",
        WEBSOCKET_ERROR: "websocketerror",
        PROTOCOL_ERROR: "protocolerror"
},

Events

Events that WMKS can trigger.

Events: {
        CONNECTION_STATE_CHANGE: "connectionstatechange",
        REMOTE_SCREEN_SIZE_CHANGE: "screensizechange",
        FULL_SCREEN_CHANGE: "fullscreenchange",
        ERROR: "error",
        KEYBOARD_LEDS_CHANGE: "keyboardledschanged",
        HEARTBEAT: "heartbeat",
        AUDIO: "audio",
        COPY: "copy",
        TOGGLE: "toggle"
},

InputDeviceType

Specifies the input device when viewing VM consoles on mobile devices.

InputDeviceType: {
        KEYBOARD: 0,
        EXTENDED_KEYBOARD: 1,
        TRACKPAD: 2
}

Position

WMKS displays the remote screen of the VM in equal proportions. After rescale, the remote screen size might not match the container size. Position provides two options to position the screen in the container.

Position: {
        CENTER:   0,
        LEFT_TOP: 1
},