Type Definitions

TouchType

触摸事件类型

Type:
  • 'touchstart' | 'touchmove' | 'touchend' | 'touchcancel' | string

OnEventReadClipboardErrorResponse

Properties:
Name Type Attributes Description
type 'readclipboarderror'
data object <optional>
Properties
Name Type Attributes Description
message any <optional>

通常 http 协议会读取剪切板失败

Type:
  • object

OnEventIceConnectionStateChangeResponse

Properties:
Name Type Attributes Description
type 'ice_state'
data object <optional>
Properties
Name Type Attributes Description
value 'connected' | 'disconnected' <optional>

ice 链接状态回调

Type:
  • object

StreamPushState

直播推流相关

Type:
  • 'NoStreamPushing' | 'PushConnecting' | 'Pushing' | 'PushPaused' | 'PushReConnecting'

DebugSettingParams

Properties:
Name Type Attributes Description
showSendKmData boolean <optional>

打印键盘/鼠标键入的消息

showSendAckData boolean <optional>

打印发送的ACK message

showSendHbData boolean <optional>

打印发送的Hb message

showOnHbMessage boolean <optional>

打印心跳回包消息

showOnKmMessage boolean <optional>

打印km回包消息

showOnAckMessage boolean <optional>

打印ACK回包消息

showOnCdMessage boolean <optional>

打印CD回包消息

showOnSvMessage boolean <optional>

打印Sv回包消息

showLog boolean <optional>

打印SDK 所有日志

showStats boolean <optional>

展示数据面板 webrtc 状态信息,否则需要按 CTRL+~ 快捷键显示。

调试相关设置

Type:
  • object

MouseEvent

PC 上的鼠标事件

Type:
  • 'mouseleft' | 'mouseright' | 'mousemiddle' | 'mouseforward' | 'mousebackward' | 'mousescroll' | 'mousemove' | 'mousemove_v2' | 'mousedeltamove' | 'mousedeltamove_v2' | 'mousehorizontalscroll'

GamePadEvent

手柄事件

Type:
  • 'gamepadconnect' | 'gamepaddisconnect' | 'gamepadkey' | 'axisleft' | 'axisright' | 'lt' | 'rt'

KMMessageType

KM 通道数据类型

Type:

RawEventData

Properties:
Name Type Attributes Description
type KMMessageType
x number <optional>
y number <optional>
down boolean <optional>
delta number <optional>
key number <optional>

底层接收的原始数据类型

Type:
  • object

CameraProfileType

摄像头分辨率类型,用于快速设置

Type:
  • '120p' | '180p' | '240p' | '360p' | '480p' | '720p' | '1080p'

JoystickEventTypes

摇杆事件类型

Type:
  • 'start' | 'move' | 'end' | 'added'