Class LocalCallFeed

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

CallFeed
- LocalCallFeed

Constructors

constructor

new LocalCallFeed(opts: LocalCallFeedOpts): LocalCallFeed
Parameters
- opts: LocalCallFeedOpts
Returns LocalCallFeed
Overrides CallFeed.constructor
- Defined in src/webrtc/localCallFeed.ts:38

Properties

`Protected` `Readonly` _id

_id: string

`Private` _purpose

_purpose: SDPStreamMetadataPurpose

`Protected` _stream

_stream: MediaStream

`Protected` _tracks

_tracks: LocalCallTrack[] = []

`Protected` `Optional` call

call?: MatrixCall

`Protected` client

client: MatrixClient

`Readonly` connected

connected: true = true

`Readonly` isLocal

isLocal: true = true

`Readonly` isRemote

isRemote: false = false

`Protected` `Optional` roomId

roomId?: string

speakingVolumeSamples

speakingVolumeSamples: number[]

Accessors

audioMuted

get audioMuted(): boolean
Returns boolean
Inherited from CallFeed.audioMuted
- Defined in src/webrtc/callFeed.ts:135

audioTrack

get audioTrack(): undefined | CallTrack
Returns undefined | CallTrack
Inherited from CallFeed.audioTrack
- Defined in src/webrtc/callFeed.ts:127

audioTracks

get audioTracks(): LocalCallTrack[]
Returns LocalCallTrack[]
Overrides CallFeed.audioTracks
- Defined in src/webrtc/localCallFeed.ts:57

deviceId

get deviceId(): undefined | string
Returns undefined | string
Overrides CallFeed.deviceId
- Defined in src/webrtc/localCallFeed.ts:89

disposed

get disposed(): boolean
Returns boolean
Inherited from CallFeed.disposed
- Defined in src/webrtc/callFeed.ts:293
set disposed(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from CallFeed.disposed
- Defined in src/webrtc/callFeed.ts:297

`Private` hasAudioTrack

get hasAudioTrack(): boolean
Returns boolean
Inherited from CallFeed.hasAudioTrack
- Defined in src/webrtc/callFeed.ts:143

height

get height(): undefined | number
Returns undefined | number
Inherited from CallFeed.height
- Defined in src/webrtc/callFeed.ts:115

id

get id(): string
Returns string
Overrides CallFeed.id
- Defined in src/webrtc/localCallFeed.ts:49

isVisible

get isVisible(): boolean
Returns boolean
Inherited from CallFeed.isVisible
- Defined in src/webrtc/callFeed.ts:107

metadata

get metadata(): SDPStreamMetadataObject
Returns SDPStreamMetadataObject
- Defined in src/webrtc/localCallFeed.ts:65

purpose

get purpose(): SDPStreamMetadataPurpose
Returns SDPStreamMetadataPurpose
Overrides CallFeed.purpose
- Defined in src/webrtc/localCallFeed.ts:81

stream

get stream(): undefined | MediaStream
Returns undefined | MediaStream
Inherited from CallFeed.stream
- Defined in src/webrtc/callFeed.ts:103

streamId

get streamId(): undefined | string
Returns undefined | string
Overrides CallFeed.streamId
- Defined in src/webrtc/localCallFeed.ts:93

tracks

get tracks(): LocalCallTrack[]
Returns LocalCallTrack[]
Overrides CallFeed.tracks
- Defined in src/webrtc/localCallFeed.ts:53

userId

get userId(): string
Returns string
Overrides CallFeed.userId
- Defined in src/webrtc/localCallFeed.ts:85

videoMuted

get videoMuted(): boolean
Returns boolean
Inherited from CallFeed.videoMuted
- Defined in src/webrtc/callFeed.ts:139

videoTrack

get videoTrack(): undefined | CallTrack
Returns undefined | CallTrack
Inherited from CallFeed.videoTrack
- Defined in src/webrtc/callFeed.ts:131

videoTracks

get videoTracks(): LocalCallTrack[]
Returns LocalCallTrack[]
Overrides CallFeed.videoTracks
- Defined in src/webrtc/localCallFeed.ts:61

width

get width(): undefined | number
Returns undefined | number
Inherited from CallFeed.width
- Defined in src/webrtc/callFeed.ts:111

Methods

addListener

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

clone

clone(): LocalCallFeed
Returns LocalCallFeed
- Defined in src/webrtc/localCallFeed.ts:119

dispose

dispose(): void
Returns void
Inherited from CallFeed.dispose
- Defined in src/webrtc/callFeed.ts:282

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 CallFeed.emit
- Defined in src/models/typed-event-emitter.ts:56
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 CallFeed.emit
- Defined in src/models/typed-event-emitter.ts:57

eventNames

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

getLocalVolume

getLocalVolume(): number
Returns number
Inherited from CallFeed.getLocalVolume
- Defined in src/webrtc/callFeed.ts:301

getMember

getMember(): null | RoomMember
Returns callRoom member

Returns
member of the callRoom

Returns null | RoomMember
Inherited from CallFeed.getMember
- Defined in src/webrtc/callFeed.ts:233

isAudioMuted

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

Deprecated
use audioMuted instead

Returns
is audio muted?

Returns boolean
Inherited from CallFeed.isAudioMuted
- Defined in src/webrtc/callFeed.ts:244

isSpeaking

isSpeaking(): boolean
Returns boolean
Inherited from CallFeed.isSpeaking
- Defined in src/webrtc/callFeed.ts:258

isVideoMuted

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

Deprecated
use videoMuted instead

Returns
is video muted?

Returns boolean
Inherited from CallFeed.isVideoMuted
- Defined in src/webrtc/callFeed.ts:254

listenerCount

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

listeners

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

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
Inherited from CallFeed.measureVolumeActivity
- Defined in src/webrtc/callFeed.ts:266

publish

publish(call: MatrixCall): void
Parameters
- call: MatrixCall
Returns void
- Defined in src/webrtc/localCallFeed.ts:181

rawListeners

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

removeAllListeners

removeAllListeners(event?: EventEmitterEvents | CallFeedEvent): LocalCallFeed
Parameters
- Optional event: EventEmitterEvents | CallFeedEvent
Returns LocalCallFeed
Inherited from CallFeed.removeAllListeners
- Defined in src/models/typed-event-emitter.ts:100

removeListener

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

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/localCallFeed.ts:103

setIsVisible

setIsVisible(isVisible: boolean): void
Parameters
- isVisible: boolean
Returns void
Inherited from CallFeed.setIsVisible
- Defined in src/webrtc/callFeed.ts:317

setLocalVolume

setLocalVolume(localVolume: number): void
Parameters
- localVolume: number
Returns void
Inherited from CallFeed.setLocalVolume
- Defined in src/webrtc/callFeed.ts:305

setNewStream

setNewStream(newStream: MediaStream): void
Parameters
- newStream: MediaStream
Returns void
- Defined in src/webrtc/localCallFeed.ts:142

setResolution

setResolution(width: number, height: number): void
Parameters
- width: number
- height: number
Returns void
Inherited from CallFeed.setResolution
- Defined in src/webrtc/callFeed.ts:310

setSpeakingThreshold

setSpeakingThreshold(threshold: number): void
Parameters
- threshold: number
Returns void
Inherited from CallFeed.setSpeakingThreshold
- Defined in src/webrtc/callFeed.ts:278

`Protected` startMeasuringVolume

startMeasuringVolume(): void
Sets up the volume measuring and/or starts the measuring loop

Returns void
Inherited from CallFeed.startMeasuringVolume
- Defined in src/webrtc/callFeed.ts:168

unpublish

unpublish(): void
Returns void
- Defined in src/webrtc/localCallFeed.ts:188

`Protected` updateStream

updateStream(oldStream?: MediaStream, newStream?: MediaStream): void
Parameters
- Optional oldStream: MediaStream
- Optional newStream: MediaStream
Returns void
Overrides CallFeed.updateStream
- Defined in src/webrtc/localCallFeed.ts:146

Class LocalCallFeed

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

opts: LocalCallFeedOpts

Returns LocalCallFeed

Properties

Protected Readonly _id

Private _purpose

Protected _stream

Protected _tracks

Protected Optional call

Protected client

Readonly connected

Readonly isLocal

Readonly isRemote

Protected Optional roomId

speakingVolumeSamples

Accessors

audioMuted

Returns boolean

audioTrack

Returns undefined | CallTrack

audioTracks

Returns LocalCallTrack[]

deviceId

Returns undefined | string

disposed

Returns boolean

Parameters

value: boolean

Returns void

Private hasAudioTrack

Returns boolean

height

Returns undefined | number

id

Returns string

isVisible

Returns boolean

metadata

Returns SDPStreamMetadataObject

purpose

Returns SDPStreamMetadataPurpose

stream

Returns undefined | MediaStream

streamId

Returns undefined | string

tracks

Returns LocalCallTrack[]

userId

Returns string

videoMuted

Returns boolean

videoTrack

Returns undefined | CallTrack

videoTracks

Returns LocalCallTrack[]

width

Returns undefined | number

Methods

addListener

Type Parameters

T extends EventEmitterEvents | CallFeedEvent

Parameters

event: T

listener: Listener<CallFeedEvent, EventHandlerMap, T>

Returns LocalCallFeed

clone

Returns LocalCallFeed

dispose

Returns void

emit

Type Parameters

`Protected` `Readonly` _id

`Private` _purpose

`Protected` _stream

`Protected` _tracks

`Protected` `Optional` call

`Protected` client

`Readonly` connected

`Readonly` isLocal

`Readonly` isRemote

`Protected` `Optional` roomId

`Private` hasAudioTrack

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

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