小程序

远端音视频流,通过监听 client.on('stream-added') 事件获得。
远端流的生命周期在事件 client.on('stream-added') 到事件 client.on('stream-removed') 之间,在这两个事件之间,远端流可能会通过 client.on('stream-updated') 进行更新,比如远端用户通过增加或删除 track 后本地就会收到此通知。

Index

---

Properties

• streamCodecOption

Accessors

• audioTrack
• videoTrack

Methods

destroy	fire	getStreamId
getUserId	getAudioOn	getType
getVideoOn	hasAudio	hasVideo
muteAudio	muteVideo	unmuteAudio
unmuteVideo	off	on
one	isSubscribed	onMiniProgramState

Methods

---

destroy
销毁音视频流

remoteStream.destroy():void

返回

• void

---

fire
提交事件

remoteStream.fire(类型: string, data: any):void

参数

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

返回

• void

---

getStreamId
获取 stream id

remoteStream.getStreamId():string

返回

• string

---

getUserId
获取 userId

remoteStream.getUserId(): string

返回

• string

---

getAudioOn
获取流音频是否挂起

remoteStream.getAudioOn(): boolean

返回

• boolean

---

getType
获取流类型

remoteStream.getType(): string

返回

• string
• main 主流
• assist 辅流
• 对应移动端推的主辅流，web 端没有辅流的概念

---

getVideoOn
获取流视频是否挂起

remoteStream.getVideoOn(): boolean

返回

• boolean

---

hasAudio
是否有音频

remoteStream.hasAudio(): boolean

返回

• boolean

---

hasVideo
是否有视频

remoteStream.hasVideo(): boolean

返回

• boolean

---

isPlaying
流是否正在播放

remoteStream.isPlaying():boolean

返回

• boolean

---

muteAudio
禁用音频轨道

remoteStream.muteAudio():boolean

返回

• boolean

详情

• 对于本地流,调用该方法会停止发送音频,远端会触发 client.on(‘mute-audio’) 事件
• 对于远端流,调用该方法会停止播放音频,但是仍然接收音频数据。

muteVideo
禁用视频轨道

remoteStream.muteVideo():boolean

返回

• boolean

详情

• 对于本地流,调用该方法会停止发送视频,远端会触发 client.on(‘mute-video’) 事件
• 如果视频是从摄像头采集,此时摄像头灯仍然是亮着的
• 对于远端流,调用该方法会停止播放视频,但是仍然接收视频数据

---

unmuteAudio
启用音频轨道

remoteStream.unmuteAudio(): boolean

返回

• boolean

详情

• 对于本地流,调用该方法会触发远端 client.on(‘unmute-audio’) 事件
• 音频轨道默认是开启的,若你调用 muteAudio 后可用该方法重新启用音频

---

unmuteVideo
启用视频轨道

remoteStream.unmuteVideo(): boolean

返回

• boolean

详情

• 对于本地流,调用该方法会触发远端 client.on(‘unmute-video’) 事件
• 视频轨道默认是开启的,若你调用 muteVideo 后可用该方法重新启用视频

---

off
取消事件监听

remoteStream.off(类型: string, fn: Function): this

参数

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

返回

• 实例本身Stream

详情

• 只传 类型 取消此事件的所有监听
• 不传任何参数取消所有事件的监听

---

on
监听Stream事件

remoteStream.on(类型: string, fn: Function): this

参数

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

返回

• 实例本身Stream

---

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

remoteStream.one(类型: string, fn: Function): this

参数

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

返回

• 实例本身Stream

---

isSubscribed
远端流是否已经订阅

remoteStream.isSubscribed(): boolean

返回

• boolean

onMiniProgramState

参数

名称	类型	描述
info	object	小程序 netstatus 事件回调的 info

返回

• void

---