小程序

Client 接口提供音视频通话的核心功能,例如加入频道、发布和订阅音视频流等。

• 你可以通过 creatClient 创建 Client 对象
• 一个 Client 对象代表一个本地客户端

Client对象

let client = BRTC.createClient({'appId','h264','rtc'})

Hierarchy

---

• Client

Index

---

Index

join	destroy	fire
leave	off	on
one	publishRTMP	unpublishRTMP
subscribeRTMP	unsubscribeRTMP	setPublishOnly

Methods

---

join
加入房间

client.join(roomId: string, userId: number, sig: string): Promise‹any› 

参数

名称	类型	描述
roomId	string	房间id
userId	number	用户id
sig	string	签名 参考SDK 动态授权

返回

• Promise‹any›

详情

• 加入一个音视频通话房间进房代表开始一个音视频通话会话,这时候 SDK 会监听远端用户进房退房情况,若有远端用户进房并且发布流,本地会收到 ‘stream-added’ 事件
• 进入房间后用户可以通过 publish 发布本地流
• 该方法让用户加入通话的房间,加入房间内的每一个用户的uid必须是唯一的
• 同一个房间内用户 ID 相同时,后进入的用户会将前一个用户踢出房间

---

destroy
销毁 client 实例

client.destroy(): Promise‹any›

返回

• Promise‹any›

---

fire
提交事件

client.fire(type: string ,data: any ): void

参数

名称	类型	描述
type	string	事件类型
data	string	事件数据

返回

• void

---

leave
退出房间

client.leave(): Promise‹any› 

返回

• Promise‹any›

详情

• 退房前请确保已经通过 unpublish 取消发布本地流,若未取消发布本地流,SDK 内部会自动取消发布本地流

---

off
取消事件监听

client.off(type: string , fn: Function ): this 

参数

名称	类型	描述
type	string	事件类型
fn	Function	事件回调

返回

• this 实例本身 Client

详情

• 取消事件监听,用于移除通过 on 绑定的事件
• 只传 type 取消此事件的所有监听
• 不传任何参数取消所有事件的监听

---

on
监听客户端对象事件

client.on(type: string , fn: Function ): this 

参数

名称	类型	描述
type	string	事件类型
fn	Function	事件回调

返回

• this 实例本身 Client

详情

• 相关事件详见 Events

---

one
监听一次事件

client.one(type: string , fn: Function ): this

参数

名称	类型	描述
type	string	事件类型
fn	Function	事件回调

返回

• this 实例本身 Client

详情

• 监听一次事件,执行一次之后自动取消监听

---

publishRTMP
发布本地音视频流

client.publishRTMP(stream: LocalStream): Promise‹string›

参数

名称	类型	描述
stream	LocalStream	创建的本地流对象

返回

• Promise‹string› 推流的 rtmp 地址

详情

• 该方法需要在 join 进房后调用,一次音视频会话中只能发布一个本地流。若想发布另外一个本地流,可先通过 unpublish取消发布当前本地流后再发布新的本地流
• 在发布本地流后,可通过 removeTrack、addTrack、replaceTrack 来更新本地流中的某个音频或视频流
• 发布本地流后远端会收到 ‘stream-added’ 事件通知

---

setPublishOnly
本地只发布一路音视频流

client.setPublishOnly(value: boolean ): void

参数

名称	类型	描述
value	boolean	是否只推流

返回

• void

详情

• 设置 client 只用于推流,一般用于推多路流的时候
• 设置主 client 为 false,辅 client 为 true,这样辅 client 只用于推流,只会触发 ’stream-published‘ 事件,所有的流由主 client 来订阅

---

unpublishRTMP
取消发布本地流

client.unpublishRTMP(stream: LocalStream): Promise‹any›

参数

名称	类型	描述
stream	LocalStream	本地流对象

返回

• Promise‹any›

详情

• 取消发布本地流后远端会收到 ‘stream-removed’ 事件通知
• 请在 leave 退房前取消已经发布的本地流

---

subscribeRTMP
订阅远端流

client.subscribeRTMP(stream: RemoteStream , options: SubscribeOptions : Promise‹string›

参数

名称	类型	默认值	描述
stream	RemoteStream	-	需要订阅的远端流对象,由 ‘stream-added’ 事件获得
options	SubscribeOptions	{audio: true, video: true}	订阅选项

返回

• Promise‹string› 拉流的 rtmp 地址

详情

• 订阅远端流,可通过该订阅接口指明需要订阅音频、视频或者音视频流
• 开发者可通过该订阅接口指明需要订阅音频、视频或者音视频流
• 若不想接收该远端流所包含的任何音视频数据,请通过 unsubscribe 取消订阅

---

unsubscribeRTMP
取消订阅远端流

client.unsubscribeRTMP(stream: RemoteStream): Promise‹any›

参数

名称	类型	描述
stream	RemoteStream	取消订阅的远端流

返回

• Promise‹any›

详情

• RemoteStream 需要取消订阅的远端流对象,由 ‘stream-added’ 事件获得

---