Class: WEBRTC2

WEBRTC2


new WEBRTC2()

请使用 WEBRTC2.createClient 来初始化sdk Client对象.

Methods


addTasks(options)

增加互动直播推流任务

Parameters:
Name Type Description
options Array

推流任务列表

Properties
Name Type Argument Description
rtmpTasks Number <optional>

推流任务

Returns:
Type
Promise

deleteTasks(options)

删除互动直播推流任务

Parameters:
Name Type Description
options Object
Properties
Name Type Argument Description
taskId Array <optional>

该推流任务的id要求唯一

Returns:
Type
Promise

getLocalAudioStats()

获取本地发布流的音频统计数据

Returns:
Type
Promise

getLocalVideoStats()

获取本地发布流的音频统计数据

Returns:
Type
Promise

getRemoteAudioStats()

获取远端订阅流的音频统计数据

Returns:
Type
Promise

getRemoteVideoStats()

获取远端订阅流的视频统计数据

Returns:
Type
Promise

getSessionStats()

获取与会话的连接状况统计数据

Returns:
Type
Promise

getSystemStats()

获取系统电量

Returns:
Type
Promise

getTransportStats()

获取与网关的连接状况统计数据

Returns:
Type
Promise

join(options)

加入频道

Parameters:
Name Type Description
options Object
Properties
Name Type Argument Description
channel String

频道名称

uid Number

用户唯一标识(整数,建议五位数以上)

token Number

传入能标识用户角色和权限的 Token。如果安全要求不高,也可以将值设为 空字符串。

joinChannelLiveConfig Object <optional>

加入房间互动直播相关参数

Properties
Name Type Argument Description
liveEnable Boolean <optional>

是否旁路直播

rtmpUrl String <optional>

旁路直播地址

rtmpRecord Boolean <optional>

是否开启互动直播录制

splitMode Number <optional>

推流布局模式

layout String <optional>

自定义推流布局

joinChannelRecordConfig Object <optional>

加入房间录制相关参数

Properties
Name Type Argument Description
isHostSpeaker Boolean <optional>

是否是主讲人

recordAudio Boolean <optional>

是否开启音频实时音录制,0不需要,1需要(默认0)

recordVideo Boolean <optional>

是否开启视频实时音录制,0不需要,1需要(默认0)

recordType Number <optional>

录制模式,0混单(产生混合录制文件+单独录制文件) 1只混(只产生混合录制文件) 2只单(只产生单独录制文件)

Returns:
Type
Promise

leave()

离开频道

Parameters:
Type Description
Void
Returns:
Type
Promise

publish(options)

发布视频

Parameters:
Name Type Description
options Object

参数

Properties
Name Type Description
stream Stream

Stream类型

Returns:
Type
Promise

setChannelProfile(options)

设置房间模型

Parameters:
Name Type Description
options Object
Properties
Name Type Argument Description
mode Object <optional>

房间属性,"rtc": 通信场景,"live": 直播场景

Returns:
Type
Promise

setRemoteVideoStreamType(stream, resolution:)

中途更新订阅的视频分辨率。

Parameters:
Name Type Description
stream Stream

参数

resolution: Number

订阅的分辨率 WebRTC2.VIDEO_QUALITY_180p、WebRTC2.VIDEO_QUALITY_480p、WebRTC2.VIDEO_QUALITY_720p、WebRTC2.VIDEO_QUALITY_1080p

Returns:
Type
Promise

subscribe(options)

订阅远端音视频流

Parameters:
Name Type Description
options Object

参数

Properties
Name Type Description
stream Stream

Stream类型

Returns:
Type
Promise

unpublish(options)

取消发布本地音视频流

Parameters:
Name Type Description
options Object

参数

Properties
Name Type Description
stream Stream

Stream类型

Returns:
Type
Promise

unsubscribe(options)

取消订阅远端音视频流

Parameters:
Name Type Description
options Object

参数

Properties
Name Type Description
stream Stream

Stream类型

Returns:
Type
Promise

updateTasks(options)

更新互动直播推流任务

Parameters:
Name Type Description
options Object
Properties
Name Type Argument Description
rtmpTasks Object <optional>

推流任务

Returns:
Type
Promise

<static> createClient(options)

创建Client对象实例

Parameters:
Name Type Description
options Object

配置参数

Properties
Name Type Argument Default Description
appkey String <optional>

实例的应用ID

debug Boolean <optional>
false

是否开启debug模式,默认不开启,debug模式下浏览器会打印log日志


<static> destroy()

销毁实例

Parameters:
Type Description
Void