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
Properties
id
id:
string
Inherited from
isMuted
isMuted:
boolean
Inherited from
mediaStreamTrack
mediaStreamTrack:
MediaStreamTrack
Inherited from
StageStream . mediaStreamTrack
participantInfo
participantInfo:
StageParticipantInfo
streamType
streamType:
StreamType
Inherited from
Methods
cleanup()
cleanup():
void
Prevents the getStats closure from preventing garbage collection for
Returns
void
Inherited from
off()
off<
E>(event,callback):void
De-register a callback for event E
Type Parameters
• E extends string | number | symbol
Parameters
• event: E
the event to de-register the callback for
• callback: never[E]
the callback to be de-registered
Returns
void
Inherited from
on()
on<
E>(event,callback):void
Register a new callback for event E
Type Parameters
• E extends string | number | symbol
Parameters
• event: E
the event to register the callback for
• callback: never[E]
the callback to be invoked for the event
Returns
void
Inherited from
requestRTCStats()
requestRTCStats():
Promise<undefined|RTCStatsReport>
Get the RTC Stats report for this media source
Returns
Promise<undefined | RTCStatsReport>
Inherited from
setMuted()
setMuted(
mute):void
Mute or unmute a participant remotely
Parameters
• mute: boolean
Mute or unmute
Returns
void