Class: RemoteStageStream

A RemoteStageStream is a wrapper for media coming from remote participants. It gives you the ability to perform various actions like mute and unmute participants.

Extends

• TypedEmitter<RemoteStageStreamEventMap>

Implements

• StageStream<RemoteStageStreamEventMap>

Accessors

id

get id(): string

Returns

string

Implementation of

StageStream . id

---

isAdapting

get isAdapting(): boolean

Returns

boolean

---

isMuted

get isMuted(): boolean

set isMuted(muted): void

Parameters

• muted: boolean

Returns

boolean

Implementation of

StageStream . isMuted

---

mediaStreamTrack

get mediaStreamTrack(): MediaStreamTrack

Returns

MediaStreamTrack

Implementation of

StageStream . mediaStreamTrack

---

participantInfo

get participantInfo(): StageParticipantInfo

Returns

StageParticipantInfo

---

streamType

get streamType(): StreamType

Returns

StreamType

Implementation of

StageStream . streamType

Methods

cleanup()

cleanup(): void

Cleans up the Stage Stream so no additional events will fire.

Returns

void

Implementation of

StageStream . cleanup

---

getHighestQualityLayer()

getHighestQualityLayer(): undefined | StageStreamLayer

Returns

undefined | StageStreamLayer

---

getLowestQualityLayer()

getLowestQualityLayer(): undefined | StageStreamLayer

Returns

undefined | StageStreamLayer

---

getStats()

getStats(): Promise<undefined | RTCStatsReport>

This API is the previous internal API and now just defers internally to the requestRTCStats.

Returns

Promise<undefined | RTCStatsReport>

Implementation of

StageStream . getStats

Deprecated

---

off()

off<E>(event, callback, context?): void

De-register a callback for event E

Type Parameters

• E extends keyof RemoteStageStreamEventMap

Parameters

• event: E

the event to de-register the callback for

• callback: RemoteStageStreamEventMap[E]

the callback to be de-registered

• context?: any

Returns

void

Implementation of

StageStream . off

Inherited from

TypedEmitter.off

---

on()

on<E>(event, callback, context?): void

Register a new callback for event E

Type Parameters

• E extends keyof RemoteStageStreamEventMap

Parameters

• event: E

the event to register the callback for

• callback: RemoteStageStreamEventMap[E]

the callback to be invoked for the event

• context?: any

Returns

void

Implementation of

StageStream . on

Inherited from

TypedEmitter.on

---

requestRTCStats()

requestRTCStats(): Promise<undefined | RTCStatsReport>

Get the RTC Stats report for this media source

Returns

Promise<undefined | RTCStatsReport>

Implementation of

StageStream . requestRTCStats

---

setGetStats()

setGetStats(): void

Returns

void

Implementation of

StageStream.setGetStats

---

setMuted()

setMuted(mute): void

Mute or unmute a participant remotely

Parameters

• mute: boolean

Mute or unmute

Returns

void