Class StreamStore
StreamStore
类用于管理媒体流。
Accessors
localCameraStreamUuid
get localCameraStreamUuid(): undefined | string
本地摄像头视频流 UUID
localMicStreamUuid
get localMicStreamUuid(): undefined | string
本地麦克风音频流 UUID
streamByStreamUuid
get streamByStreamUuid(): Map<string, EduStream>
房间内流信息列表 key: 流 UUID value: 流对象
streamByUserUuid
get streamByUserUuid(): Map<string, Set<string>>
房间内用户流信息列表 key: 用户 UUID value: 流 UUID 集合
streamVolumes
get streamVolumes(): Map<string, number>
音量列表 key: 流 UUID value: 音量值,范围:0 ~ 1
Methods
muteRemoteAudioStream
muteRemoteAudioStream(stream: EduStream, muted: boolean, fromScene?: AgoraRteScene): void
订阅/取消远端音频流
参数
参数名 | 描述 |
---|---|
返回值
muteRemoteVideoStream
muteRemoteVideoStream(stream: EduStream, muted: boolean, fromScene?: AgoraRteScene): void
订阅/取消远端视频流
参数
参数名 | 描述 |
---|---|
返回值
muteRemoteVideoStreamMass
muteRemoteVideoStreamMass(streams: EduStream[], muted: boolean, fromScene?: AgoraRteScene): undefined | Promise<string[]>
批量订阅
参数
参数名 | 描述 |
---|---|
返回值
publishStreamToCdn
publishStreamToCdn(fromScene?: AgoraRteScene): Promise<void>
旁路推流,将当前已发布的流推送到CDN
参数
参数名 | 描述 |
---|---|
流所在的房间对象,不传默认为当前房间 |
返回值
setLatencyLevel
setLatencyLevel(level: AgoraLatencyLevel, fromScene?: AgoraRteScene): Promise<void>
设置延时等级(仅可在当前端没有发布音视频流的情况下使用)
参数
参数名 | 描述 |
---|---|
流的延时等级 流所在的房间对象,不传默认为当前房间 |
返回值
setRemoteVideoStreamType
setRemoteVideoStreamType(streamUuid: string, remoteVideoStreamType: AGRemoteVideoStreamType, fromScene?: AgoraRteScene): Promise<void>
设置远端视频质量
参数
参数名 | 描述 |
---|---|
要设置的流的 UUID 要设置的流类型 流所在的房间对象,不传默认为当前房间 |
返回值
setupRemoteVideo
setupRemoteVideo(stream: EduStream, dom: HTMLElement, mirror: boolean, renderMode?: AGRenderMode, fromScene?: AgoraRteScene): void
渲染远端视频
参数
参数名 | 描述 |
---|---|
流对象 渲染节点 是否镜像 填充方式 流所在的房间对象,不传默认为当前房间 |
返回值
updateExpandedScopeAndStreams
updateLocalPublishState
updateLocalPublishState(state: { audioState?: AgoraRteMediaPublishState; videoState?: AgoraRteMediaPublishState }, fromScene?: AgoraRteScene): Promise<void>
更新本地音频和视频发布状态
参数
参数名 | 描述 |
---|---|
音频和视频发布状态
流所在的房间对象,不传默认为当前房间 |
返回值
updateRemotePublishState
updateRemotePublishState(userUuid: string, streamUuid: string, state: { audioState?: AgoraRteMediaPublishState; videoState?: AgoraRteMediaPublishState }, fromScene?: AgoraRteScene): Promise<void>
更新远端音频和视频发布状态
参数
参数名 | 描述 |
---|---|
用户 ID 流 ID 音频和视频发布状态
流所在的房间对象,不传默认为当前房间 |
返回值
updateRemotePublishStateBatch
updateRemotePublishStateBatch(streams: { audioSourceType?: AgoraRteAudioSourceType; audioState?: AgoraRteMediaPublishState; streamUuid: string; userUuid: string; videoSourceType?: AgoraRteVideoSourceType; videoState?: AgoraRteMediaPublishState }[], fromScene?: AgoraRteScene): Promise<void>
批量更新远端音频和视频发布状态
参数
参数名 | 描述 |
---|---|
流列表 |
房间对象