Interface FishjamProviderProps

interface FishjamProviderProps {
    audioConfig?: StreamConfig;
    bandwidthLimits?: Partial<BandwidthLimits>;
    children?: ReactNode;
    constraints?: Pick<MediaStreamConstraints, "audio" | "video">;
    persistLastDevice?: boolean | PersistLastDeviceHandlers;
    reconnect?: boolean | ReconnectConfig;
    videoConfig?: StreamConfig;
}

Hierarchy

  • PropsWithChildren
    • FishjamProviderProps

Properties

audioConfig? bandwidthLimits? children? constraints? persistLastDevice? reconnect? videoConfig?

Properties

OptionalaudioConfig

audioConfig?: StreamConfig

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

OptionalbandwidthLimits

bandwidthLimits?: Partial<BandwidthLimits>

Adjust max bandwidth limit for a single stream and simulcast.

Optionalchildren

children?: ReactNode

Optionalconstraints

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

Set preferred constraints.

Param: constraints

The media stream constraints as defined by the Web API.

See

MediaStreamConstraints

OptionalpersistLastDevice

persistLastDevice?: boolean | PersistLastDeviceHandlers

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.

Optionalreconnect

reconnect?: boolean | ReconnectConfig

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

OptionalvideoConfig

videoConfig?: StreamConfig

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

Settings

Member Visibility

On This Page

Properties