Skip to main content
Version: v1.17.0

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

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

LocalStageStream

Overrides

StageStream . constructor

Properties

id

id: string

Inherited from

StageStream . id


isMuted

isMuted: boolean

Inherited from

StageStream . isMuted


mediaConfig?

optional mediaConfig: StageStreamConfiguration


mediaStreamTrack

mediaStreamTrack: MediaStreamTrack

Inherited from

StageStream . mediaStreamTrack


streamType

streamType: StreamType

Inherited from

StageStream . streamType

Methods

cleanup()

cleanup(): void

Prevents the getStats closure from preventing garbage collection for

Returns

void

Inherited from

StageStream . cleanup


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

StageStream . off


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

StageStream . on


requestRTCStats()

requestRTCStats(): Promise\<undefined | RTCStatsReport>

Get the RTC Stats report for this media source

Returns

Promise\<undefined | RTCStatsReport>

Inherited from

StageStream . requestRTCStats


setMuted()

setMuted(mute): void

Updates the mute state of this LocalStageStream

Parameters

mute: boolean

The desired mute state of this LocalStageStream

Returns

void