RTCDevice

RTCDevice

RTC 设备。

Constructor

new RTCDevice(modeopt)

Parameters:
Name Type Attributes Description
mode string <optional>

模式：'recvonly' ， 'sendonly' ，'sendrecv' 。

Classes

RTCDevice

Members

candidates :Array

Type:
  • Array

configuration :object

Type:
  • object

inboundStream :MediaStream

Type:
  • MediaStream

localVideoElem :HTMLElement

Type:
  • HTMLElement

mediaConstraint :MediaConstraint

Type:

mediaReady :boolean

媒体数据是否已经连接。

Type:
  • boolean

mode :string

Type:
  • string

outboundMeter :VolumeMeter|AudioWorkletVolumeMeter

Type:

outboundStream :MediaStream

Type:
  • MediaStream

pc :RTCPeerConnection

Type:
  • RTCPeerConnection

ready :boolean

是否已就绪。

Type:
  • boolean

remoteVideoElem :HTMLElement

Type:
  • HTMLElement

sn :number

Type:
  • number

spanners :Array.<DeviceSpanner>

Type:

started :boolean

是否已启动 PeerConnection 。

Type:
  • boolean

streamState :object

出入栈流的状态记录。

Type:
  • object

Methods

doAnswer(description, handleSuccess, handleFailure)

主叫执行 Answer 应答。

Parameters:
Name Type Description
description JSON
handleSuccess function
handleFailure function

enableInboundAudio(enabled) → {boolean}

启用/停用入站音频。

Parameters:
Name Type Description
enabled boolean

指定是否启用。
Returns:

返回设置是否有效。

Type
boolean

enableInboundVideo(enabled) → {boolean}

启用/停用入站视频。

Parameters:
Name Type Description
enabled boolean

指定是否启用。
Returns:

返回设置是否有效。

Type
boolean

enableOutboundAudio(enabled) → {boolean}

启用/停用出站音频。

Parameters:
Name Type Description
enabled boolean

指定是否启用。
Returns:

返回设置是否有效。

Type
boolean

enableOutboundVideo(enabled) → {boolean}

启用/停用出站视频。

Parameters:
Name Type Description
enabled boolean

指定是否启用。
Returns:

返回设置是否有效。

Type
boolean

getVolume() → {number}

返回音量。

Returns:

返回音量值，从 0.0 (静音) 到 1.0 (最大声)。

Type
number

inboundAudioEnabled() → {boolean}

返回入站音频是否已启用。

Returns:

返回入站音频是否已启用。

Type
boolean

inboundVideoEnabled() → {boolean}

返回入站视频是否已启用。

Returns:

返回入站视频是否已启用。

Type
boolean

isWorking() → {boolean}

当前 RTC 设备是否正在工作。

Returns:

如果正在通话返回 true 。

Type
boolean

openAnswer(description, mediaConstraint, handleSuccess, handleFailure)

启动 RTC 终端为被叫。

Parameters:
Name Type Description
description JSON

主叫的 Session Description 。
mediaConstraint MediaConstraint

媒体约束，设置为 null 值时不使用用户媒体设备。
handleSuccess function

启动成功回调函数。
handleFailure function

启动失败回调函数。

openOffer(mediaConstraint, handleSuccess, handleFailure)

启动 RTC 终端为主叫。

Parameters:
Name Type Description
mediaConstraint MediaConstraint

媒体约束。
handleSuccess function

启动成功回调函数。
handleFailure function

启动失败回调函数。

outboundAudioEnabled() → {boolean}

返回出站音频是否已启用。

Returns:

返回出站音频是否已启用。

Type
boolean

outboundVideoEnabled() → {boolean}

返回出站视频是否已启用。

Returns:

返回出站视频是否已启用。

Type
boolean

setVolume(value)

设置扬声器音量。

Parameters:
Name Type Description
value number

音量值，从 0.0 (静音) 到 1.0 (最大声)。