Global

Members

NetworkErrorCode[undefined]

Success Default response for all signaling

NetworkErrorCode[undefined]

Stream not found Media service - Stream doesn't exist Returned by subscribe signaling

NetworkErrorCode[undefined]

Parameter error Media service - Invalid parameters Returned by subscribe signaling

NetworkErrorCode[undefined]

Track not found Media service - Subscribed track doesn't exist Returned by subscribe signaling

NetworkErrorCode[undefined]

Invalid JSON Check signaling structure and parameters

NetworkErrorCode[undefined]

Invalid parameters Check signaling parameters

NetworkErrorCode[undefined]

User not joined User hasn't joined the room

NetworkErrorCode[undefined]

User repeated join User logged in repeatedly

NetworkErrorCode[undefined]

Source user doesn't exist Remote user doesn't exist Applies to signaling related to remote users (invite, offer, answer, custom data, etc.)

NetworkErrorCode[undefined]

Invalid user signature

NetworkErrorCode[undefined]

Invalid auth server signature Public cloud authentication failed

NetworkErrorCode[undefined]

No track exists Stream doesn't exist Returned by subscribe signaling

NetworkErrorCode[undefined]

Server overload Returned by join signaling

NetworkErrorCode[undefined]

Media server exception

NetworkErrorCode[undefined]

Unknown error

Type Definitions

ConnectionState

Connection State

Type:
  • 'new' | 'connecting' | 'connected' | 'failed' | 'disconnected' | 'reconnecting' | 'not_support' | 'limit_exceeded'

CloudMode

Cloud Mode public - Public cloud public_intl - Public cloud (international) private - Private cloud

Type:
  • 'public' | 'public_intl' | 'private'

SDKMode

Service Mode server - Dedicated acceleration mode server2 - Standard acceleration mode

Type:
  • 'server' | 'server2'

MediaType

Media Type

Type:
  • 'video' | 'audio'

RoomState

Room State

Type:
  • 'joining' | 'joined' | 'unjoined'

SignalingState

Signaling State

Type:
  • 'new' | 'scheduling' | 'scheduled' | 'connecting' | 'connected' | 'disconnected' | 'closed' | 'reconnecting'

MqttConnectionState

MQTT Connection State

Type:
  • 'new' | 'connecting' | 'connected' | 'reconnecting' | 'error' | 'closed'

PermissionState

Gateway Device Permission

Type:
  • 'master' | 'guest'

Gateway

Properties:
Name Type Description
deviceId string

Field device ID. In public cloud mode, format is ${projectId}/${fieldDeviceId}

deviceName string
deviceType string
streamCount number
status string
version string

Gateway SDK version

Gateway Information

Type:
  • object

OnEventAutoplayResponse

Properties:
Name Type Description
type 'autoplay'
data object
Properties
Name Type Attributes Description
code number

0 - Success, -1 - Failed, 20 - MQTT client not found (public cloud only), 21 - MQTT client not connected (public cloud only), 22 - MQTT publish failed (public cloud only), 25 - MQTT sessionId not found (public cloud only)

message string
fieldDeviceId string
srcUserId string
streamId number
trackId string
mediaType MediaType
videoWidth number <optional>
videoHeight number <optional>

Autoplay Response Type

Type:
  • object

OnEventWebRTCStatsResponse

Properties:
Name Type Description
type 'webrtcStats'
data Array
data[].srcUserId string
data[].trackId string
data[].bitrate number

Bitrate (Mbit/s)

data[].resolution string

Resolution

data[].fps number
data[].mediaType MediaType
data[].codec string

Codec type

data[].nack number
data[].packetsLost number
data[].packetsReceived number
data[].framesReceived number
data[].firCount number
data[].pliCount number
data[].rtt number
data[].latency number
data[].latency1 number
data[].latency2 number
data[].lag100 number
data[].lag150 number
data[].decodeTime number
data[].processingDelay number

WebRTC Stats Callback

Type:
  • object

OnEventGatewayStatsResponse

Properties:
Name Type Description
type 'gatewayStats'
data object
Properties
Name Type Description
fieldDeviceId string
stats any

Gateway Stats Callback

Type:
  • object

OnEventLocalTrackUnpublishedResponse

Properties:
Name Type Description
type 'localTrackUnpublished'
data Object

Local Audio Track Unpublish Callback

Type:
  • object

OnEventResponse

OnEvent Response

Type: