MultipointComm

MultipointComm

多方通信服务。

Constructor

new MultipointComm()

Classes

MultipointComm

Members

activeCall :CallRecord

当前活跃的通话记录。

Type:

callTimeout :number

呼叫超时。

Type:
  • number

privateField :CommField

个人的私有通信场。

Type:

Methods

answerCall(mediaConstraint, targetopt, successCallbackopt, failureCallbackopt) → {boolean}

应答呼叫。

Parameters:
Name Type Attributes Description
mediaConstraint MediaConstraint

指定本地的媒体约束。
target CommField | Contact | Group <optional>

指定应答对象。
successCallback function <optional>

成功回调函数，函数参数：(callRecord:CallRecord) 。
failureCallback function <optional>

失败回调函数，函数参数：(error:ModuleError) 。
Returns:

返回是否允许执行该操作。

Type
boolean

config()

See:

createCommField(mediaConstraint, successCallback, failureCallback, groupopt, nameopt, contactsopt)

创建多方通讯场域。

Parameters:
Name Type Attributes Description
mediaConstraint MediaConstraint
successCallback function
failureCallback function
group Group <optional>
name string <optional>
contacts Array.<Contact> <optional>

destroyCommField(commFieldId, successCallback, failureCallbackopt)

销毁指定的通讯场域。

Parameters:
Name Type Attributes Description
commFieldId number
successCallback function
failureCallback function <optional>

(protected) follow(endpoint, successCallbackopt, failureCallbackopt) → {boolean}

定向接收指定终端的音视频数据。

Parameters:
Name Type Attributes Description
endpoint CommFieldEndpoint

指定待获取数据的终端。
successCallback function <optional>

成功回调函数，函数参数：(callRecord:CallRecord) 。
failureCallback function <optional>

失败回调函数，函数参数：(error:ModuleError) 。
Returns:

返回是否允许执行该操作。

Type
boolean

getActiveField() → {CommField}

获取当前通话的通信场域。

Returns:

返回当前通话的通信场域。

Type
CommField

getActiveRecord() → {CallRecord}

获取当前活跃的通话记录。

Returns:

返回当前活跃的通话记录。

Type
CallRecord

getCommField(idOrGroup, successCallback, failureCallbackopt)

获取指定 ID 的场域。

Parameters:
Name Type Attributes Description
idOrGroup number | Group
successCallback function
failureCallback function <optional>

getLocalVideoElement() → {HTMLElement}

获取本地视频标签的 DOM 元素。

Returns:

返回本地视频标签的 DOM 元素。

Type
HTMLElement

getPrivateField() → {CommField}

获取私有通信域。

Returns:
Type
CommField

getRemoteVideoElement() → {HTMLElement}

获取远端视频标签的 DOM 元素。

Returns:

返回远端视频标签的 DOM 元素。

Type
HTMLElement

hangupCall(successCallbackopt, failureCallbackopt) → {boolean}

终止当前的通话。

Parameters:
Name Type Attributes Description
successCallback function <optional>

成功回调函数，函数参数：(callRecord:CallRecord) 。
failureCallback function <optional>

失败回调函数，函数参数：(error:ModuleError) 。
Returns:

返回是否允许执行该操作。

Type
boolean

inviteCall(entityOrId, list, successCallback, failureCallback)

邀请列表里的联系人加入到当前通讯域。

Parameters:
Name Type Description
entityOrId CommField | Group | number

指定场域或者群组。
list Array

被邀请人的 ID 清单。
successCallback function
failureCallback function

isCalling(group, handler)

群组是否正在通话。

Parameters:
Name Type Description
group Group
handler function

回调函数，参数：(calling:boolean) 。

listMediaDevices(handler)

列举当前系统可用的所有媒体设备。

Parameters:
Name Type Description
handler function

结果回调函数。参数：(list:MediaDeviceDescription >) 。

makeCall(target, mediaConstraint, successCallbackopt, failureCallbackopt) → {boolean}

呼叫指定场域或者联系人。

Parameters:
Name Type Attributes Description
target CommField | Contact | Group

指定通话对象。指定 CommField 表示呼入通讯场，指定 Contact 表示呼叫联系人，指定 Group 表示呼叫群组。
mediaConstraint MediaConstraint

指定通话的媒体约束。
successCallback function <optional>

成功回调函数，函数参数：(callRecord:CallRecord) 。
failureCallback function <optional>

失败回调函数，函数参数：(error:ModuleError) 。
Returns:

返回是否允许执行该操作。

Type
boolean

setLocalVideoElement(element)

设置本地视频标签的 DOM 元素。

Parameters:
Name Type Description
element HTMLElement

指定本地视频标签的 DOM 元素。

setRemoteVideoElement(element)

设置远端视频标签的 DOM 元素。

Parameters:
Name Type Description
element HTMLElement

指定远端视频标签的 DOM 元素。

setVideoElementAgent(agent)

设置视频元素代理器。用于将视频、音频流加载到对应的 vidoe 标签上。 代理器是一个 function 类型，输入参数为联系人，返回该联系人对应的视频标签元素。

Parameters:
Name Type Description
agent function

指定能返回指定联系人 video 标签元素的函数。

start()

stop()

(protected) unfollow(endpoint, successCallback, failureCallback)

取消定向接收的指定终端音视频数据。

Parameters:
Name Type Description
endpoint CommFieldEndpoint
successCallback function
failureCallback function