小程序

Stream 接口提供的方法用于定义音视频流对象的行为,例如流的播放控制、音视频的编码配置等。

• 你可以通过 createStream 创建 Stream对象
• 一个Stream对象指通话中发布的本地音视频流或订阅的远端音视频流
• Stream 方法如无特别说明,本地 LocalStream 和远端 RemoteStream 音视频流均可调用
• 一个 Stream 中最多只能同时包含一个音频 track 和一个视频 track

一个远端用户可发送至多两个远端流对象,其中一个远端流对象包含一路音频和一路主路视频,另一个远端流对象仅仅包含一路辅路视频。 这两种远端流对象的类型可通过 userID 对应流的后缀来区别:

• “0”表示主视(main)频流
• “1”表示辅助(assist)视频流

Hierarchy

---

Stream

• LocalStream
• RemoteStream

Index

---

Accessors

• audioTrack
• videoTrack

Methods

---

destroy	getStreamId	getUserId
fire	getAudioOn	getVideoOn
hasAudio	hasVideo	isLocalStream
isPlaying	muteAudio	unmuteAudio
muteVideo	unmuteVideo	off
on	one	-

Properties

---

streamCodecOption
流配置项

stream.streamCodecOption: streamCodecOption

详情

• 详见 streamCodecOption

---

Accessors

---

audioTrack
音频轨道

stream.audioTrack(): MediaStreamTrack

返回

• MediaStreamTrack

---

videoTrack
视频轨道

stream.videoTrack(): MediaStreamTrackMediaStreamTrack

返回

• MediaStreamTrack

---

Methods

---

destroy
销毁音视频流

stream.destroy():void

返回

• void

---

fire
提交事件

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

参数

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

返回

• void

---

getStreamId
获取 stream id

stream.getStreamId():string

返回

• string

---

getUserId
获取 userId

stream.getUserId(): string

返回

• string

---

getAudioOn
获取流音频是否挂起

stream.getAudioOn(): boolean

返回

• boolean

---

getVideoOn
获取流视频是否挂起

stream.getVideoOn(): boolean

返回

• boolean

---

hasAudio
是否有音频

stream.hasAudio(): boolean

返回

• boolean

---

hasVideo
是否有本地视频

stream.hasVideo(): boolean

返回

• boolean

---

isLocalStream
判断是否是本地流

stream.isLocalStream(): boolean

返回

• boolean

---

muteAudio
禁用音频轨道

stream.muteAudio():boolean

返回

• boolean

详情

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

---

unmuteAudio
启用音频轨道

stream.unmuteAudio(): boolean

返回

• boolean

详情

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

---

muteVideo
禁用视频轨道

stream.muteVideo():boolean

返回

• boolean

详情

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

---

unmuteVideo
启用视频轨道

stream.unmuteVideo(): boolean

返回

• boolean

详情

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

---

off
取消事件监听

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

参数

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

返回

• 实例本身 Stream

详情

• 只传 类型 取消此事件的所有监听

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

  ---

on
监听Stream事件

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

参数

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

返回

• 实例本身 Stream

详情

• 详细事件列表请参见：StreamEvent

---

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

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

参数

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

返回

• 实例本身 Stream

---