Class CallFeed`Abstract`

CallFeed is a wrapper around a MediaStream. It includes useful information such as the userId and deviceId of the stream's sender, mute state, volume activity etc. This class would be usually used to display the video tiles in the UI.

Hierarchy

TypedEventEmitter<CallFeedEvent, EventHandlerMap>
- CallFeed
  - LocalCallFeed
  - RemoteCallFeed

Constructors

constructor

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

Properties

`Private` _disposed

_disposed: boolean = false

`Private` _height

_height: number = 0

`Protected` `Readonly` _id

_id: string

`Private` _isVisible

_isVisible: boolean = false

`Protected` `Optional` _stream

_stream?: MediaStream

`Protected` _tracks

_tracks: CallTrack[] = []

`Private` _width

_width: number = 0

`Private` `Optional` analyser

analyser?: AnalyserNode

`Private` `Optional` audioContext

audioContext?: AudioContext

`Private` `Optional` audioSourceNode

audioSourceNode?: MediaStreamAudioSourceNode

`Protected` client

client: MatrixClient

`Private` `Optional` frequencyBinCount

frequencyBinCount?: Float32Array

`Abstract` isLocal

isLocal: boolean

`Abstract` isRemote

isRemote: boolean

`Private` localVolume

localVolume: number = 1

`Private` measuringVolumeActivity

measuringVolumeActivity: boolean = false

`Protected` `Optional` roomId

roomId?: string

`Private` speaking

speaking: boolean = false

`Private` speakingThreshold

speakingThreshold: number = SPEAKING_THRESHOLD

speakingVolumeSamples

speakingVolumeSamples: number[]

`Private` `Optional` volumeLooperTimeout

volumeLooperTimeout?: Timeout

Accessors

audioMuted

get audioMuted(): boolean
Returns boolean
- Defined in src/webrtc/callFeed.ts:138

audioTrack

get audioTrack(): undefined | CallTrack
Returns undefined | CallTrack
- Defined in src/webrtc/callFeed.ts:130

audioTracks

get audioTracks(): CallTrack[]
Returns CallTrack[]
- Defined in src/webrtc/callFeed.ts:122

`Abstract` connected

get connected(): boolean
Returns boolean
- Defined in src/webrtc/callFeed.ts:66

`Abstract` deviceId

get deviceId(): undefined | string
Returns undefined | string
- Defined in src/webrtc/callFeed.ts:68

disposed

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

`Private` hasAudioTrack

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

height

get height(): undefined | number
Returns undefined | number
- Defined in src/webrtc/callFeed.ts:118

`Abstract` id

get id(): string
Returns string
- Defined in src/webrtc/callFeed.ts:64

isVisible

get isVisible(): boolean
Returns boolean
- Defined in src/webrtc/callFeed.ts:110

`Abstract` purpose

get purpose(): SDPStreamMetadataPurpose
Returns SDPStreamMetadataPurpose
- Defined in src/webrtc/callFeed.ts:65

stream

get stream(): undefined | MediaStream
Returns undefined | MediaStream
- Defined in src/webrtc/callFeed.ts:106

`Protected` tracks

get tracks(): CallTrack[]
Returns CallTrack[]
- Defined in src/webrtc/callFeed.ts:150

`Abstract` userId

get userId(): string
Returns string
- Defined in src/webrtc/callFeed.ts:67

videoMuted

get videoMuted(): boolean
Returns boolean
- Defined in src/webrtc/callFeed.ts:142

videoTrack

get videoTrack(): undefined | CallTrack
Returns undefined | CallTrack
- Defined in src/webrtc/callFeed.ts:134

videoTracks

get videoTracks(): CallTrack[]
Returns CallTrack[]
- Defined in src/webrtc/callFeed.ts:126

width

get width(): undefined | number
Returns undefined | number
- Defined in src/webrtc/callFeed.ts:114

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:49

dispose

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

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

eventNames

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

getLocalVolume

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

getMember

getMember(): null | RoomMember
Returns callRoom member

Returns
member of the callRoom

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

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
- Defined in src/webrtc/callFeed.ts:247

isSpeaking

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

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
- Defined in src/webrtc/callFeed.ts:257

listenerCount

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

listeners

listeners(event: EventEmitterEvents | CallFeedEvent): Function[]
Parameters
- event: EventEmitterEvents | CallFeedEvent
Returns Function[]
Inherited from TypedEventEmitter.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
- Defined in src/webrtc/callFeed.ts:269

setIsVisible

setIsVisible(isVisible: boolean): void
Parameters
- isVisible: boolean
Returns void
- Defined in src/webrtc/callFeed.ts:320

setLocalVolume

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

setResolution

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

setSpeakingThreshold

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

`Protected` startMeasuringVolume

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

Returns void
- Defined in src/webrtc/callFeed.ts:171

`Protected` updateStream

updateStream(oldStream?: MediaStream, newStream?: MediaStream): void
Parameters
- Optional oldStream: MediaStream
- Optional newStream: MediaStream
Returns void
- Defined in src/webrtc/callFeed.ts:154

Class CallFeedAbstract

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

opts: ICallFeedOpts

Returns CallFeed

Properties

Private _disposed

Private _height

Protected Readonly _id

Private _isVisible

Protected Optional _stream

Protected _tracks

Private _width

Private Optional analyser

Private Optional audioContext

Private Optional audioSourceNode

Protected client

Private Optional frequencyBinCount

Abstract isLocal

Abstract isRemote

Private localVolume

Private measuringVolumeActivity

Protected Optional roomId

Private speaking

Private speakingThreshold

speakingVolumeSamples

Private Optional volumeLooperTimeout

Accessors

audioMuted

Returns boolean

audioTrack

Returns undefined | CallTrack

audioTracks

Returns CallTrack[]

Abstract connected

Returns boolean

Abstract deviceId

Returns undefined | string

disposed

Returns boolean

Parameters

value: boolean

Returns void

Private hasAudioTrack

Returns boolean

height

Returns undefined | number

Abstract id

Returns string

isVisible

Returns boolean

Abstract purpose

Returns SDPStreamMetadataPurpose

stream

Returns undefined | MediaStream

Protected tracks

Returns CallTrack[]

Abstract userId

Returns string

videoMuted

Returns boolean

videoTrack

Returns undefined | CallTrack

videoTracks

Returns CallTrack[]

width

Returns undefined | number

Methods

addListener

Type Parameters

T extends EventEmitterEvents | CallFeedEvent

Parameters

event: T

Class CallFeed`Abstract`

`Private` _disposed

`Private` _height

`Protected` `Readonly` _id

`Private` _isVisible

`Protected` `Optional` _stream

`Protected` _tracks

`Private` _width

`Private` `Optional` analyser

`Private` `Optional` audioContext

`Private` `Optional` audioSourceNode

`Protected` client

`Private` `Optional` frequencyBinCount

`Abstract` isLocal

`Abstract` isRemote

`Private` localVolume

`Private` measuringVolumeActivity

`Protected` `Optional` roomId

`Private` speaking

`Private` speakingThreshold

`Private` `Optional` volumeLooperTimeout

`Abstract` connected

`Abstract` deviceId

`Private` hasAudioTrack

`Abstract` id

`Abstract` purpose

`Protected` tracks

`Abstract` userId

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

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