Class Client<PeerMetadata, TrackMetadata>

Type Parameters

PeerMetadata
TrackMetadata

Hierarchy

TypedEventEmitter<Required<ClientEvents<PeerMetadata, TrackMetadata>>, this>
- Client

Constructors

constructor

new Client<PeerMetadata, TrackMetadata>(config?): Client<PeerMetadata, TrackMetadata>
Type Parameters
- PeerMetadata
- TrackMetadata
Parameters
- Optional config: ReactClientCreteConfig<PeerMetadata, TrackMetadata>
Returns Client<PeerMetadata, TrackMetadata>
Overrides (EventEmitter as { new <PeerMetadata, TrackMetadata>(): TypedEmitter<Required<ClientEvents<PeerMetadata, TrackMetadata>>>; })<PeerMetadata, TrackMetadata>.constructor
- Defined in src/Client.ts:333

Properties

bandwidthEstimation

bandwidthEstimation: bigint = ...

components

components: Record<string, PeerState<PeerMetadata, TrackMetadata>> = {}

componentsTracks

componentsTracks: Record<string, TrackWithOrigin<PeerMetadata, TrackMetadata>> = {}

`Private` currentCameraTrackId

currentCameraTrackId: null | string = null

`Private` currentMicrophoneTrackId

currentMicrophoneTrackId: null | string = null

`Private` currentScreenShareTrackId

currentScreenShareTrackId: null | string = null

`Readonly` deviceManager

deviceManager: DeviceManager

devices

devices: Devices<TrackMetadata>

local

local: null | PeerState<PeerMetadata, TrackMetadata> = null

media

media: null | MediaState = null

peers

peers: Record<string, PeerState<PeerMetadata, TrackMetadata>> = {}

peersTracks

peersTracks: Record<string, TrackWithOrigin<PeerMetadata, TrackMetadata>> = {}

reconnectionStatus

reconnectionStatus: ReconnectionStatus = "idle"

`Readonly` screenShareManager

screenShareManager: ScreenShareManager

status

status: PeerStatus = null

`Private` `Readonly` tsClient

tsClient: FishjamClient<PeerMetadata, TrackMetadata>

Methods

addListener

addListener<E>(event, listener): this
Type Parameters
- E extends keyof ClientEvents<PeerMetadata, TrackMetadata>
Parameters
- event: E
- listener: Required<ClientEvents<PeerMetadata, TrackMetadata>>[E]
Returns this
Inherited from (EventEmitter as { new <PeerMetadata, TrackMetadata>(): TypedEmitter<Required<ClientEvents<PeerMetadata, TrackMetadata>>>; }).addListener
- Defined in node_modules/typed-emitter/index.d.ts:22

addTrack

addTrack(track, trackMetadata?, simulcastConfig?, maxBandwidth?): Promise<string>
Parameters
- track: MediaStreamTrack
- Optional trackMetadata: TrackMetadata
- simulcastConfig: SimulcastConfig = ...
- maxBandwidth: TrackBandwidthLimit = 0
Returns Promise<string>
- Defined in src/Client.ts:767

connect

connect(config): void
Parameters
- config: ConnectConfig<PeerMetadata>
Returns void
- Defined in src/Client.ts:757

disableTrackEncoding

disableTrackEncoding(trackId, encoding): void
Parameters
- trackId: string
- encoding: TrackEncoding
Returns void
- Defined in src/Client.ts:814

disconnect

disconnect(): void
Returns void
- Defined in src/Client.ts:762

emit

emit<E>(event, ...args): boolean
Type Parameters
- E extends keyof ClientEvents<PeerMetadata, TrackMetadata>
Parameters
- event: E
- Rest ...args: Parameters<Required<ClientEvents<PeerMetadata, TrackMetadata>>[E]>
Returns boolean
Inherited from (EventEmitter as { new <PeerMetadata, TrackMetadata>(): TypedEmitter<Required<ClientEvents<PeerMetadata, TrackMetadata>>>; }).emit
- Defined in node_modules/typed-emitter/index.d.ts:32

enableTrackEncoding

enableTrackEncoding(trackId, encoding): void
Parameters
- trackId: string
- encoding: TrackEncoding
Returns void
- Defined in src/Client.ts:810

eventNames

eventNames(): (string | symbol)[]
Returns (string | symbol)[]
Inherited from (EventEmitter as { new <PeerMetadata, TrackMetadata>(): TypedEmitter<Required<ClientEvents<PeerMetadata, TrackMetadata>>>; }).eventNames
- Defined in node_modules/typed-emitter/index.d.ts:34

getBandwidthEstimation

getBandwidthEstimation(): bigint
Returns bigint
- Defined in src/Client.ts:794

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from (EventEmitter as { new <PeerMetadata, TrackMetadata>(): TypedEmitter<Required<ClientEvents<PeerMetadata, TrackMetadata>>>; }).getMaxListeners
- Defined in node_modules/typed-emitter/index.d.ts:39

`Private` getRemoteTrack

getRemoteTrack(remoteOrLocalTrackId): null | Track<TrackMetadata>
Parameters
- remoteOrLocalTrackId: null | string
Returns null | Track<TrackMetadata>
- Defined in src/Client.ts:838

getStatistics

getStatistics(selector?): Promise<RTCStatsReport>
Parameters
- Optional selector: null | MediaStreamTrack
Returns Promise<RTCStatsReport>
- Defined in src/Client.ts:790

isReconnecting

isReconnecting(): boolean
Returns boolean
- Defined in src/Client.ts:826

listenerCount

listenerCount<E>(event): number
Type Parameters
- E extends keyof ClientEvents<PeerMetadata, TrackMetadata>
Parameters
- event: E
Returns number
Inherited from (EventEmitter as { new <PeerMetadata, TrackMetadata>(): TypedEmitter<Required<ClientEvents<PeerMetadata, TrackMetadata>>>; }).listenerCount
- Defined in node_modules/typed-emitter/index.d.ts:37

listeners

listeners<E>(event): Required<ClientEvents<PeerMetadata, TrackMetadata>>[E][]
Type Parameters
- E extends keyof ClientEvents<PeerMetadata, TrackMetadata>
Parameters
- event: E
Returns Required<ClientEvents<PeerMetadata, TrackMetadata>>[E][]
Inherited from (EventEmitter as { new <PeerMetadata, TrackMetadata>(): TypedEmitter<Required<ClientEvents<PeerMetadata, TrackMetadata>>>; }).listeners
- Defined in node_modules/typed-emitter/index.d.ts:36

off

off<E>(event, listener): this
Type Parameters
- E extends keyof ClientEvents<PeerMetadata, TrackMetadata>
Parameters
- event: E
- listener: Required<ClientEvents<PeerMetadata, TrackMetadata>>[E]
Returns this
Inherited from (EventEmitter as { new <PeerMetadata, TrackMetadata>(): TypedEmitter<Required<ClientEvents<PeerMetadata, TrackMetadata>>>; }).off
- Defined in node_modules/typed-emitter/index.d.ts:28

on

on<E>(event, listener): this
Type Parameters
- E extends keyof ClientEvents<PeerMetadata, TrackMetadata>
Parameters
- event: E
- listener: Required<ClientEvents<PeerMetadata, TrackMetadata>>[E]
Returns this
Inherited from (EventEmitter as { new <PeerMetadata, TrackMetadata>(): TypedEmitter<Required<ClientEvents<PeerMetadata, TrackMetadata>>>; }).on
- Defined in node_modules/typed-emitter/index.d.ts:23

once

once<E>(event, listener): this
Type Parameters
- E extends keyof ClientEvents<PeerMetadata, TrackMetadata>
Parameters
- event: E
- listener: Required<ClientEvents<PeerMetadata, TrackMetadata>>[E]
Returns this
Inherited from (EventEmitter as { new <PeerMetadata, TrackMetadata>(): TypedEmitter<Required<ClientEvents<PeerMetadata, TrackMetadata>>>; }).once
- Defined in node_modules/typed-emitter/index.d.ts:24

prependListener

prependListener<E>(event, listener): this
Type Parameters
- E extends keyof ClientEvents<PeerMetadata, TrackMetadata>
Parameters
- event: E
- listener: Required<ClientEvents<PeerMetadata, TrackMetadata>>[E]
Returns this
Inherited from (EventEmitter as { new <PeerMetadata, TrackMetadata>(): TypedEmitter<Required<ClientEvents<PeerMetadata, TrackMetadata>>>; }).prependListener
- Defined in node_modules/typed-emitter/index.d.ts:25

prependOnceListener

prependOnceListener<E>(event, listener): this
Type Parameters
- E extends keyof ClientEvents<PeerMetadata, TrackMetadata>
Parameters
- event: E
- listener: Required<ClientEvents<PeerMetadata, TrackMetadata>>[E]
Returns this
Inherited from (EventEmitter as { new <PeerMetadata, TrackMetadata>(): TypedEmitter<Required<ClientEvents<PeerMetadata, TrackMetadata>>>; }).prependOnceListener
- Defined in node_modules/typed-emitter/index.d.ts:26

rawListeners

rawListeners<E>(event): Required<ClientEvents<PeerMetadata, TrackMetadata>>[E][]
Type Parameters
- E extends keyof ClientEvents<PeerMetadata, TrackMetadata>
Parameters
- event: E
Returns Required<ClientEvents<PeerMetadata, TrackMetadata>>[E][]
Inherited from (EventEmitter as { new <PeerMetadata, TrackMetadata>(): TypedEmitter<Required<ClientEvents<PeerMetadata, TrackMetadata>>>; }).rawListeners
- Defined in node_modules/typed-emitter/index.d.ts:35

removeAllListeners

removeAllListeners<E>(event?): this
Type Parameters
- E extends keyof ClientEvents<PeerMetadata, TrackMetadata>
Parameters
- Optional event: E
Returns this
Inherited from (EventEmitter as { new <PeerMetadata, TrackMetadata>(): TypedEmitter<Required<ClientEvents<PeerMetadata, TrackMetadata>>>; }).removeAllListeners
- Defined in node_modules/typed-emitter/index.d.ts:29

removeListener

removeListener<E>(event, listener): this
Type Parameters
- E extends keyof ClientEvents<PeerMetadata, TrackMetadata>
Parameters
- event: E
- listener: Required<ClientEvents<PeerMetadata, TrackMetadata>>[E]
Returns this
Inherited from (EventEmitter as { new <PeerMetadata, TrackMetadata>(): TypedEmitter<Required<ClientEvents<PeerMetadata, TrackMetadata>>>; }).removeListener
- Defined in node_modules/typed-emitter/index.d.ts:30

removeTrack

removeTrack(trackId): Promise<void>
Parameters
- trackId: string
Returns Promise<void>
- Defined in src/Client.ts:778

replaceTrack

replaceTrack(trackId, newTrack, newTrackMetadata?): Promise<void>
Parameters
- trackId: string
- newTrack: null | MediaStreamTrack
- Optional newTrackMetadata: TrackMetadata
Returns Promise<void>
- Defined in src/Client.ts:782

setDeviceManagerConfig

setDeviceManagerConfig(config): void
Parameters
- config: DeviceManagerConfig
Returns void
- Defined in src/Client.ts:739

setEncodingBandwidth

setEncodingBandwidth(trackId, rid, bandwidth): Promise<boolean>
Parameters
- trackId: string
- rid: string
- bandwidth: number
Returns Promise<boolean>
- Defined in src/Client.ts:802

setMaxListeners

setMaxListeners(maxListeners): this
Parameters
- maxListeners: number
Returns this
Inherited from (EventEmitter as { new <PeerMetadata, TrackMetadata>(): TypedEmitter<Required<ClientEvents<PeerMetadata, TrackMetadata>>>; }).setMaxListeners
- Defined in node_modules/typed-emitter/index.d.ts:40

setScreenManagerConfig

setScreenManagerConfig(config): void
Parameters
- config: ScreenShareManagerConfig
Returns void
- Defined in src/Client.ts:735

setTargetTrackEncoding

setTargetTrackEncoding(trackId, encoding): void
Parameters
- trackId: string
- encoding: TrackEncoding
Returns void
- Defined in src/Client.ts:806

setTrackBandwidth

setTrackBandwidth(trackId, bandwidth): Promise<boolean>
Parameters
- trackId: string
- bandwidth: number
Returns Promise<boolean>
- Defined in src/Client.ts:798

`Private` stateToSnapshot

stateToSnapshot(): void
Returns void
- Defined in src/Client.ts:851

`Private` trackContextToTrack

trackContextToTrack(track): Track<TrackMetadata>
Parameters
- track: TrackContext<PeerMetadata, TrackMetadata>
Returns Track<TrackMetadata>
- Defined in src/Client.ts:743

updatePeerMetadata

updatePeerMetadata(peerMetadata): void
Parameters
- peerMetadata: PeerMetadata
Returns void
- Defined in src/Client.ts:818

updateTrackMetadata

updateTrackMetadata(trackId, trackMetadata): void
Parameters
- trackId: string
- trackMetadata: TrackMetadata
Returns void
- Defined in src/Client.ts:822

Class Client<PeerMetadata, TrackMetadata>

Type Parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Client<PeerMetadata, TrackMetadata>

Properties

bandwidthEstimation

components

componentsTracks

Private currentCameraTrackId

Private currentMicrophoneTrackId

Private currentScreenShareTrackId

Readonly deviceManager

devices

local

media

peers

peersTracks

reconnectionStatus

Readonly screenShareManager

status

Private Readonly tsClient

Methods

addListener

Type Parameters

Parameters

Returns this

addTrack

Parameters

Returns Promise<string>

connect

Parameters

Returns void

disableTrackEncoding

Parameters

Returns void

disconnect

Returns void

emit

Type Parameters

Parameters

Returns boolean

enableTrackEncoding

Parameters

Returns void

eventNames

Returns (string | symbol)[]

getBandwidthEstimation

Returns bigint

getMaxListeners

Returns number

Private getRemoteTrack

Parameters

Returns null | Track<TrackMetadata>

getStatistics

Parameters

Returns Promise<RTCStatsReport>

isReconnecting

Returns boolean

listenerCount

Type Parameters

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns Required<ClientEvents<PeerMetadata, TrackMetadata>>[E][]

off

Type Parameters

Parameters

Returns this

on

Type Parameters

`Private` currentCameraTrackId

`Private` currentMicrophoneTrackId

`Private` currentScreenShareTrackId

`Readonly` deviceManager

`Readonly` screenShareManager

`Private` `Readonly` tsClient

`Private` getRemoteTrack

`Private` stateToSnapshot

`Private` trackContextToTrack