Fishjam Web SDK - v0.18.0
    Preparing search index...
    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
    Index

    Properties

    audioConfig?: StreamConfig

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

    bandwidthLimits?: Partial<BandwidthLimits>

    Adjust max bandwidth limit for a single stream and simulcast.

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

    Set preferred constraints.

    The media stream constraints as defined by the Web API.

    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.

    reconnect?: boolean | ReconnectConfig

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

    videoConfig?: StreamConfig

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