Class ScreenShare

Hierarchy

EventTarget<ScreenShareEventMap>
- ScreenShare

Index

Constructors

Properties

_listeners off on

Accessors

isSharing stream

Methods

_dispatchEvent _releaseStream addEventListener once removeAllEventListeners removeEventListener startStream stopStream

Constructors

constructor

new ScreenShare(): ScreenShare
Returns ScreenShare

Overrides EventTarget.constructor

Properties

`Protected` _listeners

_listeners: { streamStopped?: EventListener<{ args: [] }>[] } = {}

Type declaration

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

off

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

Type declaration

- <K>(type: K, callback: EventListener<ScreenShareEventMap[K]>): void
- Type Parameters
  - K extends "streamStopped"
  Parameters
  - type: K
  - callback: EventListener<ScreenShareEventMap[K]>
  Returns void

on

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

Type declaration

- <K>(type: K, callback: EventListener<ScreenShareEventMap[K]>): (() => void)
- Type Parameters
  - K extends "streamStopped"
  Parameters
  - type: K
  - callback: EventListener<ScreenShareEventMap[K]>
  Returns (() => void)
  - - (): void
    - Returns void

Accessors

isSharing

get isSharing(): boolean
Returns boolean

stream

get stream(): MediaStream
Returns MediaStream

Methods

`Protected` _dispatchEvent

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

Inherited from EventTarget._dispatchEvent

_releaseStream

_releaseStream(): void
Returns void

addEventListener

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

once

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

removeAllEventListeners

removeAllEventListeners(): void
Returns void

Inherited from EventTarget.removeAllEventListeners

removeEventListener

removeEventListener<K>(type: K, callback: EventListener<ScreenShareEventMap[K]>): void
Type Parameters
- K extends "streamStopped"
Parameters
- type: K
- callback: EventListener<ScreenShareEventMap[K]>
Returns void

Inherited from EventTarget.removeEventListener

startStream

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

stopStream

stopStream(): void
Returns void

Generated using TypeDoc