Class MediaHandler

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<LocalStreamsChanged, MediaHandlerEventHandlerMap>
- MediaHandler

Constructors

constructor

new MediaHandler(client: MatrixClient): MediaHandler
Parameters
- client: MatrixClient
Returns MediaHandler
Overrides TypedEventEmitter.constructor
- Defined in src/webrtc/mediaHandler.ts:63

Properties

`Private` `Optional` audioInput

audioInput?: string

`Private` `Optional` audioSettings

audioSettings?: AudioSettings

`Private` client

client: MatrixClient

`Private` `Optional` getMediaStreamPromise

getMediaStreamPromise?: Promise<MediaStream>

`Private` `Optional` localUserMediaStream

localUserMediaStream?: MediaStream

screensharingStreams

screensharingStreams: MediaStream[] = []

userMediaStreams

userMediaStreams: MediaStream[] = []

`Private` `Optional` videoInput

videoInput?: string

Methods

addListener

addListener<T>(event: T, listener: Listener<LocalStreamsChanged, MediaHandlerEventHandlerMap, T>): MediaHandler
Type Parameters
- T extends EventEmitterEvents | LocalStreamsChanged
Parameters
- event: T
- listener: Listener<LocalStreamsChanged, MediaHandlerEventHandlerMap, T>
Returns MediaHandler
Inherited from TypedEventEmitter.addListener
- Defined in src/models/typed-event-emitter.ts:49

emit

emit<T>(event: T, ...args: Parameters<MediaHandlerEventHandlerMap[T]>): boolean
Type Parameters
- T extends LocalStreamsChanged
Parameters
- event: T
- Rest ...args: Parameters<MediaHandlerEventHandlerMap[T]>
Returns boolean
Inherited from TypedEventEmitter.emit
- Defined in src/models/typed-event-emitter.ts:56
emit<T>(event: T, ...args: Parameters<MediaHandlerEventHandlerMap[T]>): boolean
Type Parameters
- T extends LocalStreamsChanged
Parameters
- event: T
- Rest ...args: Parameters<MediaHandlerEventHandlerMap[T]>
Returns boolean
Inherited from TypedEventEmitter.emit
- Defined in src/models/typed-event-emitter.ts:57

`Private` getScreenshareContraints

getScreenshareContraints(opts: IScreensharingOpts): DesktopCapturerConstraints
Parameters
- opts: IScreensharingOpts
Returns DesktopCapturerConstraints
- Defined in src/webrtc/mediaHandler.ts:450

getScreensharingStream

getScreensharingStream(opts?: IScreensharingOpts, reusable?: boolean): Promise<MediaStream>
Returns
based on passed parameters
Parameters
- opts: IScreensharingOpts = {}
- reusable: boolean = true
  
  is allowed to be reused by the MediaHandler
Returns Promise<MediaStream>
- Defined in src/webrtc/mediaHandler.ts:346

`Private` getUserMediaContraints

getUserMediaContraints(audio: boolean, video: boolean): MediaStreamConstraints
Parameters
- audio: boolean
- video: boolean
Returns MediaStreamConstraints
- Defined in src/webrtc/mediaHandler.ts:423

getUserMediaStream

getUserMediaStream(audio: boolean, video: boolean, reusable?: boolean): Promise<MediaStream>
Returns
based on passed parameters
Parameters
- audio: boolean
  
  should have an audio track
- video: boolean
  
  should have a video track
- reusable: boolean = true
  
  is allowed to be reused by the MediaHandler
Returns Promise<MediaStream>
- Defined in src/webrtc/mediaHandler.ts:213

`Private` getUserMediaStreamInternal

getUserMediaStreamInternal(audio: boolean, video: boolean, reusable: boolean): Promise<MediaStream>
Parameters
- audio: boolean
- video: boolean
- reusable: boolean
Returns Promise<MediaStream>
- Defined in src/webrtc/mediaHandler.ts:226

hasAudioDevice

hasAudioDevice(): Promise<boolean>
Returns Promise<boolean>
- Defined in src/webrtc/mediaHandler.ts:187

hasVideoDevice

hasVideoDevice(): Promise<boolean>
Returns Promise<boolean>
- Defined in src/webrtc/mediaHandler.ts:197

restoreMediaSettings

restoreMediaSettings(audioInput: string, videoInput: string): void
Parameters
- audioInput: string
- videoInput: string
Returns void
- Defined in src/webrtc/mediaHandler.ts:67

setAudioInput

setAudioInput(deviceId: string): Promise<void>
Set an audio input device to use for MatrixCalls
Parameters
- deviceId: string
  
  the identifier for the device undefined treated as unset
Returns Promise<void>
- Defined in src/webrtc/mediaHandler.ts:77

setAudioSettings

setAudioSettings(opts: AudioSettings): Promise<void>
Set audio settings for MatrixCalls
Parameters
- opts: AudioSettings
  
  audio options to set
Returns Promise<void>
- Defined in src/webrtc/mediaHandler.ts:90

setMediaInputs

setMediaInputs(audioInput: string, videoInput: string): Promise<void>
Set media input devices to use for MatrixCalls
Parameters
- audioInput: string
  
  the identifier for the audio device
- videoInput: string
  
  the identifier for the video device undefined treated as unset
Returns Promise<void>
- Defined in src/webrtc/mediaHandler.ts:117

setVideoInput

setVideoInput(deviceId: string): Promise<void>
Set a video input device to use for MatrixCalls
Parameters
- deviceId: string
  
  the identifier for the device undefined treated as unset
Returns Promise<void>
- Defined in src/webrtc/mediaHandler.ts:102

stopAllStreams

stopAllStreams(): void
Stops all local media tracks

Returns void
- Defined in src/webrtc/mediaHandler.ts:402

stopScreensharingStream

stopScreensharingStream(mediaStream: MediaStream): void
Stops all tracks on the provided screensharing stream
Parameters
- mediaStream: MediaStream
Returns void
- Defined in src/webrtc/mediaHandler.ts:383

stopUserMediaStream

stopUserMediaStream(mediaStream: MediaStream): void
Stops all tracks on the provided usermedia stream
Parameters
- mediaStream: MediaStream
Returns void
- Defined in src/webrtc/mediaHandler.ts:318

updateLocalUsermediaStreams

updateLocalUsermediaStreams(): Promise<void>
Returns Promise<void>
- Defined in src/webrtc/mediaHandler.ts:127

Class MediaHandler

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: MatrixClient

Returns MediaHandler

Properties

Private Optional audioInput

Private Optional audioSettings

Private client

Private Optional getMediaStreamPromise

Private Optional localUserMediaStream

screensharingStreams

userMediaStreams

Private Optional videoInput

Methods

addListener

Type Parameters

T extends EventEmitterEvents | LocalStreamsChanged

Parameters

event: T

listener: Listener<LocalStreamsChanged, MediaHandlerEventHandlerMap, T>

Returns MediaHandler

emit

Type Parameters

T extends LocalStreamsChanged

Parameters

event: T

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

Returns boolean

Type Parameters

T extends LocalStreamsChanged

Parameters

event: T

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

Returns boolean

Private getScreenshareContraints

Parameters

opts: IScreensharingOpts

Returns DesktopCapturerConstraints

getScreensharingStream

Returns

Parameters

opts: IScreensharingOpts = {}

reusable: boolean = true

Returns Promise<MediaStream>

Private getUserMediaContraints

Parameters

audio: boolean

video: boolean

Returns MediaStreamConstraints

getUserMediaStream

Returns

Parameters

audio: boolean

video: boolean

reusable: boolean = true

Returns Promise<MediaStream>

Private getUserMediaStreamInternal

Parameters

audio: boolean

video: boolean

reusable: boolean

Returns Promise<MediaStream>

hasAudioDevice

Returns Promise<boolean>

hasVideoDevice

Returns Promise<boolean>

listenerCount

Parameters

event: EventEmitterEvents | LocalStreamsChanged

Returns number

listeners

Parameters

event: EventEmitterEvents | LocalStreamsChanged

`Private` `Optional` audioInput

`Private` `Optional` audioSettings

`Private` client

`Private` `Optional` getMediaStreamPromise

`Private` `Optional` localUserMediaStream

`Private` `Optional` videoInput

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

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

`Private` getScreenshareContraints

`Private` getUserMediaContraints

`Private` getUserMediaStreamInternal

`Optional` event: EventEmitterEvents | LocalStreamsChanged