Class LocalStream

Hierarchy

EventTarget<LocalStreamEventMap>
- LocalStream

Index

Constructors

constructor

new LocalStream(_deviceManager: DeviceManager, _mediaConstraints?: MediaConstraints): LocalStream
Parameters
- _deviceManager: DeviceManager
- _mediaConstraints: MediaConstraints = ...
Returns LocalStream

Overrides EventTarget.constructor

Properties

`Protected` _listeners

_listeners: { audioOutputChanged?: EventListener<{ args: [] }>[]; screenShareStreamStopped?: EventListener<{ args: [] }>[]; streamChanged?: EventListener<{ args: [MediaStream] }>[] } = {}

Type declaration

Optional audioOutputChanged?: EventListener<{ args: [] }>[]
Optional screenShareStreamStopped?: EventListener<{ args: [] }>[]
Optional streamChanged?: EventListener<{ args: [MediaStream] }>[]

off

off: (<K>(type: K, callback: EventListener<LocalStreamEventMap[K]>) => void) = ...

Type declaration

- <K>(type: K, callback: EventListener<LocalStreamEventMap[K]>): void
- Type Parameters
  - K extends keyof LocalStreamEventMap
  Parameters
  - type: K
  - callback: EventListener<LocalStreamEventMap[K]>
  Returns void

on

on: (<K>(type: K, callback: EventListener<LocalStreamEventMap[K]>) => (() => void)) = ...

Type declaration

- <K>(type: K, callback: EventListener<LocalStreamEventMap[K]>): (() => void)
- Type Parameters
  - K extends keyof LocalStreamEventMap
  Parameters
  - type: K
  - callback: EventListener<LocalStreamEventMap[K]>
  Returns (() => void)
  - - (): void
    - Returns void

Accessors

hasPermission

get hasPermission(): boolean
Returns boolean

isScreenSharing

get isScreenSharing(): boolean
Returns boolean

localStream

get localStream(): MediaStream
Returns MediaStream

mediaConstraints

set mediaConstraints(constraints: MediaConstraints): void
Parameters
- constraints: MediaConstraints
Returns void

mergedStream

get mergedStream(): MediaStream
Returns MediaStream

screenStream

get screenStream(): MediaStream
Returns MediaStream

Methods

`Protected` _dispatchEvent

_dispatchEvent<K>(type: K, ...args: ArgsType<LocalStreamEventMap[K]>): void
Type Parameters
- K extends keyof LocalStreamEventMap
Parameters
- type: K
- Rest ...args: ArgsType<LocalStreamEventMap[K]>
Returns void

Inherited from EventTarget._dispatchEvent

addEventListener

addEventListener<K>(type: K, callback: EventListener<LocalStreamEventMap[K]>): (() => void)
Type Parameters
- K extends keyof LocalStreamEventMap
Parameters
- type: K
- callback: EventListener<LocalStreamEventMap[K]>
Returns (() => void)
- - (): void
  - Returns void
Inherited from EventTarget.addEventListener

getLocalMediaStream

getLocalMediaStream(): MediaStream
Returns MediaStream

once

once<K>(type: K, givenCb: EventListener<LocalStreamEventMap[K]>): (() => void)
Type Parameters
- K extends keyof LocalStreamEventMap
Parameters
- type: K
- givenCb: EventListener<LocalStreamEventMap[K]>
Returns (() => void)
- - (): void
  - Returns void
Inherited from EventTarget.once

release

release(): void
Returns void

removeAllEventListeners

removeAllEventListeners(): void
Returns void

Inherited from EventTarget.removeAllEventListeners

removeEventListener

removeEventListener<K>(type: K, callback: EventListener<LocalStreamEventMap[K]>): void
Type Parameters
- K extends keyof LocalStreamEventMap
Parameters
- type: K
- callback: EventListener<LocalStreamEventMap[K]>
Returns void

Inherited from EventTarget.removeEventListener

revokeMediaAccess

revokeMediaAccess(): void
Returns void

stopScreenShare

stopScreenShare(): void
Returns void

useScreenStream

useScreenStream(): Promise<void>
Returns Promise<void>

Class LocalStream

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

_deviceManager: DeviceManager

_mediaConstraints: MediaConstraints = ...

Returns LocalStream

Properties

Protected _listeners

Type declaration

Optional audioOutputChanged?: EventListener<{ args: [] }>[]

Optional screenShareStreamStopped?: EventListener<{ args: [] }>[]

Optional streamChanged?: EventListener<{ args: [MediaStream] }>[]

off

Type declaration

Type Parameters

K extends keyof LocalStreamEventMap

Parameters

type: K

callback: EventListener<LocalStreamEventMap[K]>

Returns void

on

Type declaration

Type Parameters

K extends keyof LocalStreamEventMap

Parameters

type: K

callback: EventListener<LocalStreamEventMap[K]>

Returns (() => void)

Returns void

Accessors

hasPermission

Returns boolean

isScreenSharing

Returns boolean

localStream

Returns MediaStream

mediaConstraints

Parameters

constraints: MediaConstraints

Returns void

mergedStream

Returns MediaStream

screenStream

Returns MediaStream

Methods

Protected _dispatchEvent

Type Parameters

K extends keyof LocalStreamEventMap

Parameters

type: K

Rest ...args: ArgsType<LocalStreamEventMap[K]>

Returns void

addEventListener

Type Parameters

K extends keyof LocalStreamEventMap

Parameters

type: K

callback: EventListener<LocalStreamEventMap[K]>

Returns (() => void)

Returns void

getLocalMediaStream

Returns MediaStream

once

Type Parameters

K extends keyof LocalStreamEventMap

Parameters

type: K

givenCb: EventListener<LocalStreamEventMap[K]>

Returns (() => void)

Returns void

release

Returns void

removeAllEventListeners

`Protected` _listeners

`Optional` audioOutputChanged?: EventListener<{ args: [] }>[]

`Optional` screenShareStreamStopped?: EventListener<{ args: [] }>[]

`Optional` streamChanged?: EventListener<{ args: [MediaStream] }>[]

`Protected` _dispatchEvent

`Rest` ...args: ArgsType<LocalStreamEventMap[K]>