Class: LocalStageStream
A LocalStageStream is a wrapper for media coming from local participants. It gives you the ability to perform various actions like mute and unmute participants.
Extends
StageStream<LocalStageStreamEventMap>
Constructors
new LocalStageStream()
new LocalStageStream(
track,config?):LocalStageStream
Creates an instance of a LocalStageStream
Parameters
• track: MediaStreamTrack
The [[MediaStreamTrack]] that this LocalStageStream wraps
• config?: StageVideoConfiguration | StageAudioConfiguration
Optional video or audio configuration on the stage
Returns
Overrides
Properties
id
id:
string
Inherited from
isMuted
isMuted:
boolean
Inherited from
mediaConfig?
optionalmediaConfig:StageStreamConfiguration
mediaStreamTrack
mediaStreamTrack:
MediaStreamTrack
Inherited from
StageStream . mediaStreamTrack
streamType
streamType:
StreamType
Inherited from
Methods
cleanup()
cleanup():
void
Prevents the getStats closure from preventing garbage collection for
Returns
void
Inherited from
getStats()
getStats():
Promise<undefined|RTCStatsReport>
This API is the previous internal API and now just defers internally to the requestRTCStats.
Returns
Promise<undefined | RTCStatsReport>
Inherited from
Deprecated
off()
off<
E>(event,callback,context?):void
De-register a callback for event E
Type Parameters
• E extends LOCAL_STREAM_MUTE_CHANGED
Parameters
• event: E
the event to de-register the callback for
• callback: LocalStageStreamEventMap[E]
the callback to be de-registered
• context?: any
Returns
void
Inherited from
on()
on<
E>(event,callback,context?):void
Register a new callback for event E
Type Parameters
• E extends LOCAL_STREAM_MUTE_CHANGED
Parameters
• event: E
the event to register the callback for
• callback: LocalStageStreamEventMap[E]
the callback to be invoked for the event
• context?: any
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
Updates the mute state of this LocalStageStream
Parameters
• mute: boolean
The desired mute state of this LocalStageStream
Returns
void