Skip to main content
Version: Next

Interface: FishjamProviderProps

Defined in: react-client/src/FishjamProvider.tsx:27

Extends​

  • PropsWithChildren

Properties​

audioConfig?​

optional audioConfig: StreamConfig

Defined in: react-client/src/FishjamProvider.tsx:55

Configure whether to use audio simulcast and which quality layers to send if so.


bandwidthLimits?​

optional bandwidthLimits: Partial<BandwidthLimits>

Defined in: react-client/src/FishjamProvider.tsx:47

Adjust max bandwidth limit for a single stream and simulcast.


constraints?​

optional constraints: Pick<MediaStreamConstraints, "audio" | "video">

Defined in: react-client/src/FishjamProvider.tsx:38

Set preferred constraints.

Param​

The media stream constraints as defined by the Web API.

See​

MediaStreamConstraints


debug?​

optional debug: boolean

Defined in: react-client/src/FishjamProvider.tsx:63

Enables Fishjam SDK's debug logs in the console.


fishjamClient?​

optional fishjamClient: FishjamClient<GenericMetadata, GenericMetadata>

Defined in: react-client/src/FishjamProvider.tsx:67

Allows to provide your own FishjamClient instance from ts-client.


fishjamId​

fishjamId: string

Defined in: react-client/src/FishjamProvider.tsx:59

You can get you Fishjam ID at https://fishjam.io/app


persistLastDevice?​

optional persistLastDevice: boolean | PersistLastDeviceHandlers

Defined in: react-client/src/FishjamProvider.tsx:43

Decide if you want Fishjam SDK to persist last used device in the local storage. You can also provide your getter and setter by using the PersistLastDeviceHandlers interface.


reconnect?​

optional reconnect: boolean | ReconnectConfig

Defined in: react-client/src/FishjamProvider.tsx:32

Use ReconnectConfig to adjust reconnection policy to your needs or set false it. Set to true by default.


videoConfig?​

optional videoConfig: StreamConfig

Defined in: react-client/src/FishjamProvider.tsx:51

Configure whether to use video simulcast and which quality layers to send if so.