CommField

CommField

多方通信场域。

Constructor

new CommField(id, founder, pipeline, self)

Parameters:
Name Type Description
id number

场域 ID 。
founder Contact

创建人 ID 。
pipeline Pipeline

数据通道。
self Self

当前登录的用户。

Classes

CommField

Members

callee :Contact

当前被叫，仅适用于私有域。

Type:

caller :Contact

当前主叫，仅适用于私有域。

Type:

endpoints :Array.<CommFieldEndpoint>

终端列表。

Type:

endTime :number

通讯域结束通话时间。

Type:
  • number

founder :Contact

通信场创建人。

Type:

group :Group

仅用于目标为群组时。

Type:

inboundRTC :RTCDevice

用于 MCU 模式下接收 Comm Field 单路流的入站 RTC 终端。

Type:

inboundRTCMap :OrderMap.<number, RTCDevice>

入站流的 RTC 终端。键为 Endpoint 的 ID 。

Type:

mediaConstraint :MediaConstraint

媒体约束。

Type:

mediaListener :MediaListener

监听器。

Type:

name :string

场域名称。

Type:
  • string

outboundRTC :RTCDevice

出站流的 RTC 终端。

Type:

pipeline :Pipeline

通信管道。

Type:

rtcForEndpointMap :OrderMap.<number, CommFieldEndpoint>

RTC 设备对应的目标。键为 RTC 设备的 SN 。

Type:

self :Self

当前签入的用户。

Type:

startTime :number

通讯域开始通话时间。

Type:
  • number

Methods

(static) create(json, pipeline, self) → {CommField}

创建由 JSON 格式定义的 CommField 对象。

Parameters:
Name Type Description
json JSON

指定 JSON 格式。
pipeline Pipeline

指定数据管道。
self Self

指定当前登录用户。
Returns:

返回 CommField 对象实例。

Type
CommField

(protected) applyCall(participant, device, successCallback, failureCallback)

申请通话。

Parameters:
Name Type Description
participant Contact
device Device
successCallback function
failureCallback function

(protected) applyJoin(participant, device, successCallback, failureCallback)

申请加入场域。

Parameters:
Name Type Description
participant Contact
device Device
successCallback function
failureCallback function

(protected) applyTerminate(participant, device, successCallbackopt, failureCallbackopt)

申请终止指定参与者的数据。

Parameters:
Name Type Attributes Description
participant Contact
device Device
successCallback function <optional>
failureCallback function <optional>

close()

关闭当前场域。

closeEndpoint(endpoint)

关闭指定的终端。

Parameters:
Name Type Description
endpoint CommFieldEndpoint

copy(source)

从 JSON 数据里复制数据。

Parameters:
Name Type Description
source CommField | JSON

getEndpoint(paramopt) → {CommFieldEndpoint}

返回指定的终端节点的实例。

Parameters:
Name Type Attributes Description
param CommFieldEndpoint | Contact | number <optional>

指定配置数据的终端，不填写此参数返回当前登录联系人的终端实例。
Returns:

返回指定的终端节点的实例。未找到终端返回 null 值。

Type
CommFieldEndpoint

getEndpoints() → {Array.<CommFieldEndpoint>}

获取终端节点列表。

Returns:

返回终端节点列表。

Type
Array.<CommFieldEndpoint>

getFounder() → {Contact}

返回创建人。

Returns:

返回创建人。

Type
Contact

getLocalDevice() → {RTCDevice}

获取本地的 RTC 设备。

Returns:

返回本地的 RTC 设备。

Type
RTCDevice

getMediaConstraint() → {MediaConstraint}

返回媒体约束。

Returns:

返回媒体约束。

Type
MediaConstraint

getMicrophoneVolume() → {number}

获取麦克风实时音量。

Returns:

返回麦克风实时音量。

Type
number

getName() → {string}

返回名称。

Returns:

返回名称。

Type
string

getRTCDevice(endpointopt) → {RTCDevice}

获取指定终端的 RTC 设备。

Parameters:
Name Type Attributes Description
endpoint CommFieldEndpoint | number <optional>

指定终端。
Returns:

返回指定终端的 RTC 设备。

Type
RTCDevice

hasJoin() → {boolean}

判断当前签入的终端是否参与了通讯。

Returns:

返回 true 表示当前签入的设备已经在当前场域内。

Type
boolean

(protected) hasRTCDevice(endpoint) → {boolean}

是否已经存在指定终端的 RTC 设备。

Parameters:
Name Type Description
endpoint CommFieldEndpoint

指定终端。
Returns:

如果存在返回 true 。

Type
boolean

isPrivate() → {boolean}

当前通信场是否是私有场域。

Returns:

如果是私有场域返回 true ，否则返回 false 。

Type
boolean

(protected) launchAnswer(rtcDevice, offerDescription, mediaConstraint, successCallback, failureCallback, targetopt)

启动为 Answer 。

Parameters:
Name Type Attributes Description
rtcDevice RTCDevice

RTC 设备。
offerDescription string
mediaConstraint MediaConstraint
successCallback function
failureCallback function
target CommFieldEndpoint <optional>

(protected) launchOffer(rtcDevice, mediaConstraint, successCallback, failureCallback, targetopt)

启动为 Offer 。

Parameters:
Name Type Attributes Description
rtcDevice RTCDevice

RTC 设备。
mediaConstraint MediaConstraint

媒体约束。
successCallback function

成功回调。函数参数：CommField 。
failureCallback function

失败回调。
target CommFieldEndpoint <optional>

目标终端。

numEndpoints() → {number}

终端节点数量。

Returns:

返回终端节点数量。

Type
number

numRTCDevices() → {number}

获取当前管理的 RTC 设备数量。

Returns:

返回当前管理的 RTC 设备数量。

Type
number

snapshootStatsReport(outboundCallback, inboundCallbackopt)

快照当前的 WebRTC 节点状态数据。

Parameters:
Name Type Attributes Description
outboundCallback function
inboundCallback function <optional>

toCompactJSON()

toJSON()