TRROMediaObserver

TRROMediaObserver 回调函数

Methods

onMqttConnectionState(param) → {function}

MQTT 连接状态回调

Parameters:
NameTypeDescription
paramObject
Properties
NameTypeAttributesDescription
stateMqttConnectionState

MQTT 连接状态

messagestring<optional>

相关信息

Returns:
Type: 
function

onSignalingState(param, roomId) → {function}

信令状态回调

Parameters:
NameTypeDescription
paramObject
roomIdstring

信令房间 ID

param.statestring

socket.io-client 内置事件,具体可以参考 https://socket.io/docs/v2/client-api/#events

param.dataObject

socket.io-client 内置事件的相关参数,具体可以参考 https://socket.io/docs/v2/client-api/#events

Returns:
Type: 
function

onPeerConnectionState(param) → {function}

peer connection 连接改变回调

CONNECTED = 0 连接成功
NEW = 1 新建连接
CONNECTING = 2 连接中
FAILED = 3 连接失败
DISCONNECTED = 4 连接断开
CLOSED = 5 主动关闭
RECONNECTING = 6 重连中
NOT_SUPPORT = 255 当前浏览器不支持 WebRTC
LIMIT_EXCEEDED = 256 当前 PeerConnection 连接数已达到浏览器上限

Parameters:
NameTypeDescription
paramObject
Properties
NameTypeAttributesDescription
deviceIdstring

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

streamIdnumber<optional>

流 ID,该字段只在 server2 模式下有值

mediaTypeMediaType<optional>

流类型,该字段只在 server2 模式下有值

statestring

连接状态信息

codestring

连接状态码

messagestring

message

dataObject

扩展信息

Returns:
Type: 
function

onDataChannelState(param) → {void|function}

数据通道状态回调

Parameters:
NameTypeDescription
paramObject
Properties
NameTypeAttributesDescription
deviceIdstring

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

statestring

数据通道状态,取值为 'open' | 'close' | 'error'

messagestring<optional>

错误信息

labelstring

数据通道标签

Returns:
  • Type: 
    void
  • Type: 
    function

onConnected(param) → {function}

现场设备连接回调

Parameters:
NameTypeDescription
paramObject

回调数据

Properties
NameTypeDescription
deviceIdstring

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

Returns:
Type: 
function

onDisconnected(param) → {function}

现场设备断开连接回调

Parameters:
NameTypeDescription
paramObject

回调数据

Properties
NameTypeDescription
deviceIdstring

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

Returns:
Type: 
function

onTrackPublishState(param) → {function}

视频流 发布/取消发布 回调

Parameters:
NameTypeDescription
paramObject

回调数据

Properties
NameTypeDescription
statestring

视频流状态 'publish' | 'unpublish'

deviceIdstring

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

streamIdnumber

对应已经订阅的 streamId

mediaTypeMediaType

'video' | 'audio'

Returns:
Type: 
function

onControlData(param) → {function}

DataChannel 自定义消息 回调

Parameters:
NameTypeDescription
paramObject

回调数据

Properties
NameTypeAttributesDescription
deviceIdstring

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

dataTypestring

自定义消息类型 'string' | 'arrayBuffer'

datastring | ArrayBuffer

自定义消息

orderedboolean<optional>

是否通过可靠通道发送,仅在 channelType 为 'sctp' 时有值

channelType'sctp' | 'mqtt'

消息通道类型,'sctp' 表示 DataChannel,'mqtt' 表示 MQTT

Returns:
Type: 
function

onKick(param) → {function}

剔除回调

Parameters:
NameTypeDescription
paramObject

回调数据

Properties
NameTypeDescription
codenumber

code

reasonstring

原因

Returns:
Type: 
function

onPermissionStateChange(param) → {function}

权限信息回调

Parameters:
NameTypeDescription
paramObject

回调数据

Properties
NameTypeDescription
deviceIdstring

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

userIdstring

远端设备 ID

permissionPermissionState

权限信息

Returns:
Type: 
function

onError(param) → {function}

错误通知

错误码原因
20101用户名或者密码错误
20102同名用户登录
20199MQTT 连接错误
Parameters:
NameTypeDescription
paramObject

回调数据

Properties
NameTypeDescription
codenumber

错误码

messagestring

错误信息

Returns:
Type: 
function

onEvent(param) → {function}

事件回调

Parameters:
NameTypeDescription
paramOnEventResponse

回调数据

Properties
NameTypeDescription
typestring

事件类型 autoplay | webrtcStats | gatewayStats | localTrackUnpublished

dataObject

扩展信息

Returns:
Type: 
function