Global

Members

NetworkErrorCode[undefined]

success 默认所有信令返回

NetworkErrorCode[undefined]

stream not found 媒体服务-流不存在 subscribe 信令返回

NetworkErrorCode[undefined]

param err 媒体服务-参数错误 subscribe 信令返回

NetworkErrorCode[undefined]

track not found 媒体服务-订阅的track不存在 subscribe 信令返回

NetworkErrorCode[undefined]

json invalid! 检查信令结构、参数

NetworkErrorCode[undefined]

参数错误 param invalid! 检查信令参数

NetworkErrorCode[undefined]

user not join! 用户未进房,请先进房

NetworkErrorCode[undefined]

user repeat join! 用户重复登录,进房只需要调用一次

NetworkErrorCode[undefined]

src user not exist! 远端用户不存在 invite、offer、answer、custom data 等和远端用户有关的信令

NetworkErrorCode[undefined]

user sig invalid! user sig 无效

NetworkErrorCode[undefined]

auth server sig invalid! 公有云鉴权服务鉴权失败

NetworkErrorCode[undefined]

no track exist! 流不存在 subscribe 信令返回

NetworkErrorCode[undefined]

server overload! 服务过载 join 信令返回

NetworkErrorCode[undefined]

media server except! 媒体服务响应异常

NetworkErrorCode[undefined]

unknown 未定义错误

Type Definitions

ConnectionState

连接状态

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

CloudMode

云模式 public 公有云 public_intl 公有云国际站 private 私有云

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

SDKMode

服务模式 server 专属加速模式 server2 普通加速模式

Type:
  • 'server' | 'server2'

MediaType

媒体类型

Type:
  • 'video' | 'audio'

RoomState

房间状态

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

SignalingState

信令状态

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

MqttConnectionState

MQTT 连接状态

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

PermissionState

网关设备权限

Type:
  • 'master' | 'guest'

Gateway

Properties:
Name Type Description
deviceId string

现场设备 ID。公有云模式下,返回的 ID 的格式为 ${projectId}/${fieldDeviceId}

deviceName string
deviceType string
streamCount number
status string
version string

网关 SDK 版本号

网关信息

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 (只在公有云场景下出现), , 21 mqtt client not connected (只在公有云场景下出现), , 22 mqtt publish message failed (只在公有云场景下出现), , 25 mqtt sessionId not found (只在公有云场景下出现)

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

自动播放返回类型

Type:
  • object

OnEventWebRTCStatsResponse

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

码率 Mbit/s

data[].resolution string

分辨率

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

解码类型

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 回调

Type:
  • object

OnEventGatewayStatsResponse

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

网关 mqtt stats 回调

Type:
  • object

OnEventLocalTrackUnpublishedResponse

Properties:
Name Type Description
type 'localTrackUnpublished'
data Object

本地音频流自动取消推流回调

Type:
  • object

OnEventResponse

OnEvent 回调

Type: