Class StreamStore

StreamStore 类用于管理媒体流。

Accessors

localCameraStreamUuid

get localCameraStreamUuid(): undefined | string

本地摄像头视频流 UUID

localMicStreamUuid

get localMicStreamUuid(): undefined | string

本地麦克风音频流 UUID

localShareStreamUuid

get localShareStreamUuid(): undefined | string

本地屏幕共享视频流 UUID

shareStreamToken

get shareStreamToken(): undefined | string

本地屏幕共享 Token

shareStreamTokens

get shareStreamTokens(): Map<string, string>

屏幕共享 Tokens key: 流 UUID value: RTC Token

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

destroyScreenShareStream

destroyScreenShareStream(scene: AgoraRteScene): void

销毁屏幕共享流

参数

参数名	描述
scene: AgoraRteScene	房间对象

返回值

void

initializeScreenShareStream

initializeScreenShareStream(scene: AgoraRteScene, streamUuid: string, rtcToken: string): void

初始化屏幕共享流

参数

参数名	描述
scene: AgoraRteScene	房间对象
streamUuid: string	流 UUID
rtcToken: string	RTC Token

返回值

void

muteRemoteAudioStream

muteRemoteAudioStream(stream: EduStream, muted: boolean, fromScene?: AgoraRteScene): void

订阅/取消远端音频流

参数

参数名	描述
stream: EduStream	流对象
muted: boolean	是否订阅
fromScene: AgoraRteScene	流所在的房间对象，不传默认为当前房间

返回值

void

muteRemoteVideoStream

muteRemoteVideoStream(stream: EduStream, muted: boolean, fromScene?: AgoraRteScene): void

订阅/取消远端视频流

参数

参数名	描述
stream: EduStream	流对象
muted: boolean	是否订阅
fromScene: AgoraRteScene	流所在的房间对象，不传默认为当前房间

返回值

void

muteRemoteVideoStreamMass

muteRemoteVideoStreamMass(streams: EduStream[], muted: boolean, fromScene?: AgoraRteScene): undefined | Promise<string[]>

批量订阅

参数

参数名	描述
streams: EduStream[]	流对象列表
muted: boolean	是否订阅
fromScene: AgoraRteScene	流所在的房间对象，不传默认为当前房间

返回值

undefined | Promise<string[]>

publishScreenShare

publishScreenShare(fromScene?: AgoraRteScene, streamOptions?: Partial<AgoraStreamStates>): Promise<any>

为本地用户创建一条屏幕共享流，返回已创建的流ID与Token。 此方法只允许房间内创建一路屏幕共享流，若房间内需要同时存在多路屏幕流，请使用 publishScreenShareStateless

参数

参数名	描述
fromScene: AgoraRteScene	流所在的房间对象，不传默认为当前房间
streamOptions: Partial<AgoraStreamStates>	发流选项

返回值

Promise<any>

publishScreenShareStateless

publishScreenShareStateless(fromScene?: AgoraRteScene): Promise<any>

为本地用户创建一条屏幕共享流，返回已创建的流ID与Token。 此方法允许房间内创建多路屏幕共享流

参数

参数名	描述
fromScene: AgoraRteScene	流所在的房间对象，不传默认为当前房间

返回值

Promise<any>

publishStreamToCdn

publishStreamToCdn(fromScene?: AgoraRteScene): Promise<void>

旁路推流，将当前已发布的流推送到CDN

参数

参数名	描述
fromScene: AgoraRteScene	流所在的房间对象，不传默认为当前房间

返回值

Promise<void>

setLatencyLevel

setLatencyLevel(level: AgoraLatencyLevel, fromScene?: AgoraRteScene): Promise<void>

设置延时等级（仅可在当前端没有发布音视频流的情况下使用）

参数

参数名	描述
level: AgoraLatencyLevel	流的延时等级
fromScene: AgoraRteScene	流所在的房间对象，不传默认为当前房间

返回值

Promise<void>

setRemoteVideoStreamType

setRemoteVideoStreamType(streamUuid: string, remoteVideoStreamType: AGRemoteVideoStreamType, fromScene?: AgoraRteScene): Promise<void>

设置远端视频质量

参数

参数名	描述
streamUuid: string	要设置的流的 UUID
remoteVideoStreamType: AGRemoteVideoStreamType	要设置的流类型
fromScene: AgoraRteScene	流所在的房间对象，不传默认为当前房间

返回值

Promise<void>

setupRemoteVideo

setupRemoteVideo(stream: EduStream, dom: HTMLElement, mirror: boolean, renderMode?: AGRenderMode, fromScene?: AgoraRteScene): void

渲染远端视频

参数

参数名	描述
stream: EduStream	流对象
dom: HTMLElement	渲染节点
mirror: boolean	是否镜像
renderMode: AGRenderMode	填充方式
fromScene: AgoraRteScene	流所在的房间对象，不传默认为当前房间

返回值

void

unpublishScreenShare

unpublishScreenShare(fromScene?: AgoraRteScene): Promise<void>

取消发布屏幕共享流

参数

参数名	描述
fromScene: AgoraRteScene	流所在的房间对象，不传默认为当前房间

返回值

Promise<void>

unpublishScreenShareStateless

unpublishScreenShareStateless(fromScene?: AgoraRteScene): Promise<void>

取消发布屏幕共享流

参数

参数名	描述
fromScene: AgoraRteScene	流所在的房间对象，不传默认为当前房间

返回值

Promise<void>

updateExpandedScopeAndStreams

updateExpandedScopeAndStreams(state: 0 | 1, data: { userUuids: string[] }): Promise<void>

更新视频墙开关状态和发流用户列表

参数

参数名	描述
state: 0 | 1	1 开启视频墙 0 关闭视频墙
data: { userUuids: string[] }	userUuids 发流用户列表 userUuids: string[]

返回值

Promise<void>

updateLocalPublishState

updateLocalPublishState(state: { audioState?: AgoraRteMediaPublishState; videoState?: AgoraRteMediaPublishState }, fromScene?: AgoraRteScene): Promise<void>

更新本地音频和视频发布状态

参数

参数名	描述
state: { audioState?: AgoraRteMediaPublishState; videoState?: AgoraRteMediaPublishState }	音频和视频发布状态 Optional audioState?: AgoraRteMediaPublishState Optional videoState?: AgoraRteMediaPublishState
fromScene: AgoraRteScene	流所在的房间对象，不传默认为当前房间

返回值

Promise<void>

updateRemotePublishState

updateRemotePublishState(userUuid: string, streamUuid: string, state: { audioState?: AgoraRteMediaPublishState; videoState?: AgoraRteMediaPublishState }, fromScene?: AgoraRteScene): Promise<void>

更新远端音频和视频发布状态

参数

参数名	描述
userUuid: string	用户 ID
streamUuid: string	流 ID
state: { audioState?: AgoraRteMediaPublishState; videoState?: AgoraRteMediaPublishState }	音频和视频发布状态 Optional audioState?: AgoraRteMediaPublishState Optional videoState?: AgoraRteMediaPublishState
fromScene: AgoraRteScene	流所在的房间对象，不传默认为当前房间

返回值

Promise<void>

updateRemotePublishStateBatch

updateRemotePublishStateBatch(streams: { audioSourceType?: AgoraRteAudioSourceType; audioState?: AgoraRteMediaPublishState; streamUuid: string; userUuid: string; videoSourceType?: AgoraRteVideoSourceType; videoState?: AgoraRteMediaPublishState }[], fromScene?: AgoraRteScene): Promise<void>

批量更新远端音频和视频发布状态

参数

参数名	描述
streams: { audioSourceType?: AgoraRteAudioSourceType; audioState?: AgoraRteMediaPublishState; streamUuid: string; userUuid: string; videoSourceType?: AgoraRteVideoSourceType; videoState?: AgoraRteMediaPublishState }[]	流列表
fromScene: AgoraRteScene

返回值

Promise<void>