Class CallFeed

Typed Event Emitter class which can act as a Base Model for all our model and communication events. This makes it much easier for us to distinguish between events, as we now need to properly type this, so that our events are not stringly-based and prone to silly typos.

Hierarchy

TypedEventEmitter<CallFeedEvent, EventHandlerMap>
- CallFeed

Constructors

constructor

new CallFeed(opts: ICallFeedOpts): CallFeed
Parameters
- opts: ICallFeedOpts
Returns CallFeed
Overrides TypedEventEmitter.constructor
- Defined in src/webrtc/callFeed.ts:83

Properties

`Private` _disposed

_disposed: boolean = false

`Private` `Optional` analyser

analyser?: AnalyserNode

`Private` `Optional` audioContext

audioContext?: AudioContext

`Private` audioMuted

audioMuted: boolean

`Private` client

client: MatrixClient

`Private` `Optional` frequencyBinCount

frequencyBinCount?: Float32Array

`Private` localVolume

localVolume: number = 1

`Private` measuringVolumeActivity

measuringVolumeActivity: boolean = false

purpose

purpose: SDPStreamMetadataPurpose

`Private` `Optional` roomId

roomId?: string

sdpMetadataStreamId

sdpMetadataStreamId: string

`Private` speaking

speaking: boolean = false

`Private` speakingThreshold

speakingThreshold: number = SPEAKING_THRESHOLD

speakingVolumeSamples

speakingVolumeSamples: number[]

stream

stream: MediaStream

userId

userId: string

`Private` videoMuted

videoMuted: boolean

`Private` `Optional` volumeLooperTimeout

volumeLooperTimeout?: Timeout

Accessors

disposed

get disposed(): boolean
Returns boolean
- Defined in src/webrtc/callFeed.ts:304
set disposed(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/webrtc/callFeed.ts:308

`Private` hasAudioTrack

get hasAudioTrack(): boolean
Returns boolean
- Defined in src/webrtc/callFeed.ts:103

Methods

addListener

addListener<T>(event: T, listener: Listener<CallFeedEvent, EventHandlerMap, T>): CallFeed
Type Parameters
- T extends EventEmitterEvents | CallFeedEvent
Parameters
- event: T
- listener: Listener<CallFeedEvent, EventHandlerMap, T>
Returns CallFeed
Inherited from TypedEventEmitter.addListener
- Defined in src/models/typed-event-emitter.ts:51

clone

clone(): CallFeed
Returns CallFeed
- Defined in src/webrtc/callFeed.ts:270

dispose

dispose(): void
Returns void
- Defined in src/webrtc/callFeed.ts:292

emit

emit<T>(event: T, ...args: Parameters<EventHandlerMap[T]>): boolean
Type Parameters
- T extends CallFeedEvent
Parameters
- event: T
- Rest ...args: Parameters<EventHandlerMap[T]>
Returns boolean
Inherited from TypedEventEmitter.emit
- Defined in src/models/typed-event-emitter.ts:58
emit<T>(event: T, ...args: Parameters<EventHandlerMap[T]>): boolean
Type Parameters
- T extends CallFeedEvent
Parameters
- event: T
- Rest ...args: Parameters<EventHandlerMap[T]>
Returns boolean
Inherited from TypedEventEmitter.emit
- Defined in src/models/typed-event-emitter.ts:59

eventNames

eventNames(): (EventEmitterEvents | CallFeedEvent)[]
Returns (EventEmitterEvents | CallFeedEvent)[]
Inherited from TypedEventEmitter.eventNames
- Defined in src/models/typed-event-emitter.ts:64

getLocalVolume

getLocalVolume(): number
Returns number
- Defined in src/webrtc/callFeed.ts:312

getMember

getMember(): null | RoomMember
Returns callRoom member

Returns
member of the callRoom

Returns null | RoomMember
- Defined in src/webrtc/callFeed.ts:149

`Private` initVolumeMeasuring

initVolumeMeasuring(): void
Returns void
- Defined in src/webrtc/callFeed.ts:127

isAudioMuted

isAudioMuted(): boolean
Returns true if audio is muted or if there are no audio tracks, otherwise returns false

Returns
is audio muted?

Returns boolean
- Defined in src/webrtc/callFeed.ts:167

isLocal

isLocal(): boolean
Returns true if CallFeed is local, otherwise returns false

Returns
is local?

Returns boolean
- Defined in src/webrtc/callFeed.ts:158

isSpeaking

isSpeaking(): boolean
Returns boolean
- Defined in src/webrtc/callFeed.ts:181

isVideoMuted

isVideoMuted(): boolean
Returns true video is muted or if there are no video tracks, otherwise returns false

Returns
is video muted?

Returns boolean
- Defined in src/webrtc/callFeed.ts:176

listenerCount

listenerCount(event: EventEmitterEvents | CallFeedEvent): number
Parameters
- event: EventEmitterEvents | CallFeedEvent
Returns number
Inherited from TypedEventEmitter.listenerCount
- Defined in src/models/typed-event-emitter.ts:68

listeners

listeners(event: EventEmitterEvents | CallFeedEvent): Function[]
Parameters
- event: EventEmitterEvents | CallFeedEvent
Returns Function[]
Inherited from TypedEventEmitter.listeners
- Defined in src/models/typed-event-emitter.ts:72

measureVolumeActivity

measureVolumeActivity(enabled: boolean): void
Starts emitting volume_changed events where the emitter value is in decibels
Parameters
- enabled: boolean
  
  emit volume changes
Returns void
- Defined in src/webrtc/callFeed.ts:217

off

off<T>(event: T, listener: Listener<CallFeedEvent, EventHandlerMap, T>): CallFeed
Type Parameters
- T extends EventEmitterEvents | CallFeedEvent
Parameters
- event: T
- listener: Listener<CallFeedEvent, EventHandlerMap, T>
Returns CallFeed
Inherited from TypedEventEmitter.off
- Defined in src/models/typed-event-emitter.ts:76

on

on<T>(event: T, listener: Listener<CallFeedEvent, EventHandlerMap, T>): CallFeed
Type Parameters
- T extends EventEmitterEvents | CallFeedEvent
Parameters
- event: T
- listener: Listener<CallFeedEvent, EventHandlerMap, T>
Returns CallFeed
Inherited from TypedEventEmitter.on
- Defined in src/models/typed-event-emitter.ts:83

`Private` onAddTrack

onAddTrack(): void
Returns void
- Defined in src/webrtc/callFeed.ts:141

setAudioVideoMuted

setAudioVideoMuted(audioMuted: null | boolean, videoMuted: null | boolean): void
Set one or both of feed's internal audio and video video mute state Either value may be null to leave it as-is
Parameters
- audioMuted: null | boolean
  
  is the feed's audio muted?
- videoMuted: null | boolean
  
  is the feed's video muted?
Returns void
- Defined in src/webrtc/callFeed.ts:202

setLocalVolume

setLocalVolume(localVolume: number): void
Parameters
- localVolume: number
Returns void
- Defined in src/webrtc/callFeed.ts:316

setNewStream

setNewStream(newStream: MediaStream): void
Replaces the current MediaStream with a new one. The stream will be different and new stream as remore parties are concerned, but this can be used for convenience locally to set up volume listeners automatically on the new stream etc.
Parameters
- newStream: MediaStream
  
  new stream with which to replace the current one
Returns void
- Defined in src/webrtc/callFeed.ts:192

setSpeakingThreshold

setSpeakingThreshold(threshold: number): void
Parameters
- threshold: number
Returns void
- Defined in src/webrtc/callFeed.ts:230

`Private` updateStream

updateStream(oldStream: null | MediaStream, newStream: MediaStream): void
Parameters
- oldStream: null | MediaStream
- newStream: MediaStream
Returns void
- Defined in src/webrtc/callFeed.ts:107

`Private` volumeLooper

volumeLooper(): void
Returns void
- Defined in src/webrtc/callFeed.ts:234

Class CallFeed

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

opts: ICallFeedOpts

Returns CallFeed

Properties

Private _disposed

Private Optional analyser

Private Optional audioContext

Private audioMuted

Private client

Private Optional frequencyBinCount

Private localVolume

Private measuringVolumeActivity

purpose

Private Optional roomId

sdpMetadataStreamId

Private speaking

Private speakingThreshold

speakingVolumeSamples

stream

userId

Private videoMuted

Private Optional volumeLooperTimeout

Accessors

disposed

Returns boolean

Parameters

value: boolean

Returns void

Private hasAudioTrack

Returns boolean

Methods

addListener

Type Parameters

T extends EventEmitterEvents | CallFeedEvent

Parameters

event: T

listener: Listener<CallFeedEvent, EventHandlerMap, T>

Returns CallFeed

clone

Returns CallFeed

dispose

Returns void

emit

Type Parameters

T extends CallFeedEvent

Parameters

event: T

Rest ...args: Parameters<EventHandlerMap[T]>

Returns boolean

Type Parameters

T extends CallFeedEvent

Parameters

event: T

Rest ...args: Parameters<EventHandlerMap[T]>

Returns boolean

eventNames

Returns (EventEmitterEvents | CallFeedEvent)[]

getLocalVolume

Returns number

getMember

Returns

Returns null | RoomMember

Private initVolumeMeasuring

Returns void

isAudioMuted

Returns

Returns boolean

isLocal

Returns

Returns boolean

isSpeaking

`Private` _disposed

`Private` `Optional` analyser

`Private` `Optional` audioContext

`Private` audioMuted

`Private` client

`Private` `Optional` frequencyBinCount

`Private` localVolume

`Private` measuringVolumeActivity

`Private` `Optional` roomId

`Private` speaking

`Private` speakingThreshold

`Private` videoMuted

`Private` `Optional` volumeLooperTimeout

`Private` hasAudioTrack

`Rest` ...args: Parameters<EventHandlerMap[T]>

`Rest` ...args: Parameters<EventHandlerMap[T]>

`Private` initVolumeMeasuring

`Private` onAddTrack

`Optional` event: EventEmitterEvents | CallFeedEvent