Type Definitions
TouchType
Touch Type valid values: touchstart, touchmove, touchend, touchcancel.
Type:
- 'touchstart' | 'touchmove' | 'touchend' | 'touchcancel' | string
OnEventReadClipboardErrorResponse
Properties:
| Name | Type | Attributes | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
type |
'readclipboarderror' | ||||||||||
data |
object |
<optional> |
Properties
|
Usually the http protocol will fail to read clipboard
Type:
- object
StreamPushState
Push stream
Type:
- 'NoStreamPushing' | 'PushConnecting' | 'Pushing' | 'PushPaused' | 'PushReConnecting'
DebugSettingParams
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
showSendKmData |
boolean |
<optional> |
Whether to print the messages input by the keyboard/mouse. |
showSendAckData |
boolean |
<optional> |
Whether to print the sent ACK messages. |
showSendHbData |
boolean |
<optional> |
Whether to print the sent heartbeat messages. |
showOnHbMessage |
boolean |
<optional> |
Whether to print the heartbeat response packet messages. |
showOnKmMessage |
boolean |
<optional> |
Whether to print the keyboard/mouse response messages. |
showOnAckMessage |
boolean |
<optional> |
Whether to print the ACK response packet messages. |
showOnCdMessage |
boolean |
<optional> |
Whether to print the CD response packet messages. |
showOnSvMessage |
boolean |
<optional> |
Whether to print the server response packet messages. |
showLog |
boolean |
<optional> |
Whether to print all logs of the SDK. |
showStats |
boolean |
<optional> |
Whether to display the WebRTC status on the data panel. You can also press CTRL + ~ to display it. |
Debug settings
Type:
- object
MouseEvent
Mouse events on PC
Type:
- 'mouseleft' | 'mouseright' | 'mousemiddle' | 'mouseforward' | 'mousebackward' | 'mousescroll' | 'mousemove' | 'mousemove_v2' | 'mousedeltamove' | 'mousedeltamove_v2'
GamePadEvent
Gamepad events
Type:
- 'gamepadconnect' | 'gamepaddisconnect' | 'gamepadkey' | 'axisleft' | 'axisright' | 'lt' | 'rt'
KMMessageType
KM DataChannel data types
Type:
- MouseEvent | GamePadEvent | KeyBoardEvent
RawEventData
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
type |
KMMessageType | ||
x |
number |
<optional> |
|
y |
number |
<optional> |
|
down |
boolean |
<optional> |
|
delta |
number |
<optional> |
|
key |
number |
<optional> |
The underlying raw data type, which can be used to send mouse, keyboard, and joystick messages.
Type:
- object
CameraProfileType
Camera resolution type for quick setup
Type:
- '120p' | '180p' | '240p' | '360p' | '480p' | '720p' | '1080p'
JoystickEventTypes
Joystick event types.
Type:
- 'start' | 'move' | 'end' | 'added'