Skip to main content
Version: v1.5.0

Class: RemoteStageStream

A remote media stream in a stage

Hierarchy

Properties

id

id: string

Inherited from

StageStream.id


isMuted

isMuted: boolean

Inherited from

StageStream.isMuted


mediaStreamTrack

mediaStreamTrack: MediaStreamTrack

Inherited from

StageStream.mediaStreamTrack


participantInfo

participantInfo: StageParticipantInfo


streamType

streamType: StreamType

Inherited from

StageStream.streamType

Methods

cleanup

cleanup(): void

Returns

void

Inherited from

StageStream.cleanup


emit

emit<E>(event, ...args): void

Emit args for event E

Type parameters

NameType
Eextends string | number | symbol

Parameters

NameTypeDescription
eventEthe event name
...argsParameters<never[E]>-

Returns

void

Inherited from

StageStream.emit


off

off<E>(event, callback): void

De-register a callback for event E

Type parameters

NameType
Eextends string | number | symbol

Parameters

NameTypeDescription
eventEthe event to de-register the callback for
callbacknever[E]the callback to be de-registered

Returns

void

Inherited from

StageStream.off


on

on<E>(event, callback): void

Register a new callback for event E

Type parameters

NameType
Eextends string | number | symbol

Parameters

NameTypeDescription
eventEthe event to register the callback for
callbacknever[E]the callback to be invoked for the event

Returns

void

Inherited from

StageStream.on


removeAllListeners

removeAllListeners(): void

Remove all event listeners

Returns

void

Inherited from

StageStream.removeAllListeners


requestRTCStats

requestRTCStats(): Promise<undefined | RTCStatsReport>

Get the RTC Stats report for this media source

Returns

Promise<undefined | RTCStatsReport>

Inherited from

StageStream.requestRTCStats


setGetStats

setGetStats(getStats): void

Parameters

NameType
getStatsGetStatsFunction

Returns

void

Inherited from

StageStream.setGetStats


setMuted

setMuted(mute): void

Parameters

NameType
muteboolean

Returns

void