文档中心
灵动课堂
API 参考
StreamStore | agora classroom sdk
Edu Store API Reference for Web/Electron
Properties
Protected Readonly classroomStore
Protected Readonly logger
logger: Logger
muteRemoteAudioStream
mute
RemoteAudioStream: (stream: EduStream, muted: boolean, fromScene?: AgoraRteScene) => voidType declaration
- (stream: EduStream, muted: boolean, fromScene?: AgoraRteScene): void
Parameters
muted: boolean
Optional fromScene: AgoraRteScene
Returns void
muteRemoteVideoStreamMass
mute
RemoteVideoStreamMass: (streams: EduStream[], muted: boolean, fromScene?: AgoraRteScene) => undefined | Promise<string[]>Type declaration
- (streams: EduStream[], muted: boolean, fromScene?: AgoraRteScene): undefined | Promise<string[]>
Parameters
muted: boolean
Optional fromScene: AgoraRteScene
Returns undefined | Promise<string[]>
Accessors
_screenShareTokenAccessor
- get _screenShareTokenAccessor(): { shareStreamToken: undefined | string; streamUuid: undefined | string }
Returns { shareStreamToken: undefined | string; streamUuid: undefined | string }
shareStreamToken: undefined | string
streamUuid: undefined | string
localCameraStreamUuid
- get localCameraStreamUuid(): undefined | string
Returns undefined | string
localMicStreamUuid
- get localMicStreamUuid(): undefined | string
Returns undefined | string
localShareStreamUuid
- get localShareStreamUuid(): undefined | string
Returns undefined | string
shareStreamToken
- get shareStreamToken(): undefined | string
Returns undefined | string
shareStreamTokens
- get shareStreamTokens(): Map<string, string>
Returns Map<string, string>
streamByStreamUuid
- get streamByStreamUuid(): Map<string, EduStream>
streamByUserUuid
- get streamByUserUuid(): Map<string, Set<string>>
Returns Map<string, Set<string>>
streamVolumes
- get streamVolumes(): Map<string, number>
Returns Map<string, number>
Methods
destroyScreenShareStream
- destroyScreenShareStream(scene: AgoraRteScene): void
initializeScreenShareStream
- initializeScreenShareStream(scene: AgoraRteScene, streamUuid: string, rtcToken: string): void
Parameters
scene: AgoraRteScene
streamUuid: string
rtcToken: string
Returns void
muteRemoteVideoStream
- muteRemoteVideoStream(stream: EduStream, muted: boolean, fromScene?: AgoraRteScene): void
Parameters
muted: boolean
Optional fromScene: AgoraRteScene
Returns void
publishScreenShare
- publishScreenShare(fromScene?: AgoraRteScene, streamOptions?: Partial<AgoraStreamStates>): Promise<any>
Parameters
Optional fromScene: AgoraRteScene
Returns Promise<any>
publishScreenShareStateless
- publishScreenShareStateless(fromScene?: AgoraRteScene): Promise<any>
Parameters
Optional fromScene: AgoraRteScene
Returns Promise<any>
publishStreamToCdn
- publishStreamToCdn(fromScene?: AgoraRteScene): Promise<void>
Parameters
Optional fromScene: AgoraRteScene
Returns Promise<void>
setLatencyLevel
- setLatencyLevel(level: AgoraLatencyLevel, fromScene?: AgoraRteScene): Promise<void>
Parameters
level: AgoraLatencyLevel
Optional fromScene: AgoraRteScene
Returns Promise<void>
setRemoteVideoStreamType
- setRemoteVideoStreamType(streamUuid: string, remoteVideoStreamType: AGRemoteVideoStreamType, fromScene?: AgoraRteScene): Promise<void>
Parameters
streamUuid: string
remoteVideoStreamType: AGRemoteVideoStreamType
Optional fromScene: AgoraRteScene
Returns Promise<void>
setupRemoteVideo
- setupRemoteVideo(stream: EduStream, dom: HTMLElement, mirror: boolean, renderMode?: AGRenderMode, fromScene?: AgoraRteScene): void
Parameters
dom: HTMLElement
mirror: boolean
Optional renderMode: AGRenderMode
Optional fromScene: AgoraRteScene
Returns void
unpublishScreenShare
- unpublishScreenShare(fromScene?: AgoraRteScene): Promise<void>
Parameters
Optional fromScene: AgoraRteScene
Returns Promise<void>
unpublishScreenShareStateless
- unpublishScreenShareStateless(fromScene?: AgoraRteScene): Promise<void>
Parameters
Optional fromScene: AgoraRteScene
Returns Promise<void>
updateExpandedScopeAndStreams
- updateExpandedScopeAndStreams(state: 0 | 1, data: { userUuids: string[] }): Promise<void>
Parameters
state: 0 | 1
data: { userUuids: string[] }
Returns Promise<void>
updateLocalPublishState
- updateLocalPublishState(state: { audioState?: AgoraRteMediaPublishState; videoState?: AgoraRteMediaPublishState }, fromScene?: AgoraRteScene): Promise<void>
Parameters
state: { audioState?: AgoraRteMediaPublishState; videoState?: AgoraRteMediaPublishState }
Optional audioState?: AgoraRteMediaPublishState
Optional videoState?: AgoraRteMediaPublishState
Optional fromScene: AgoraRteScene
Returns Promise<void>
updateRemotePublishState
- updateRemotePublishState(userUuid: string, streamUuid: string, state: { audioState?: AgoraRteMediaPublishState; videoState?: AgoraRteMediaPublishState }, fromScene?: AgoraRteScene): Promise<void>
Parameters
userUuid: string
streamUuid: string
state: { audioState?: AgoraRteMediaPublishState; videoState?: AgoraRteMediaPublishState }
Optional audioState?: AgoraRteMediaPublishState
Optional videoState?: AgoraRteMediaPublishState
Optional fromScene: AgoraRteScene
Returns Promise<void>
StreamStore
类用于管理媒体流。