Function useBackgroundModal

Returns {
    isBackgroundModalVisible: Ref<boolean, boolean>;
    backgroundModalParameters: ComputedRef<{
        customImage?: string;
        selectedImage?: string;
        segmentVideo?: null | {};
        selfieSegmentation?: null | {
            setOptions(options: Record<string, unknown>): void;
            initialize(): Promise<void>;
            onResults(callback: ((results: SelfieSegmentationResults) => void)): void;
            send(input: SelfieSegmentationInput): Promise<void>;
        };
        pauseSegmentation?: boolean;
        processedStream?: null | {};
        keepBackground?: boolean;
        backgroundHasChanged?: boolean;
        virtualStream?: null | {};
        mainCanvas?: null | HTMLCanvasElement;
        prevKeepBackground?: boolean;
        appliedBackground?: boolean;
        autoClickBackground?: boolean;
        videoAlreadyOn?: boolean;
        audioOnlyRoom?: boolean;
        islevel?: string;
        localStreamVideo?: null | {};
        recordStarted?: boolean;
        recordResumed?: boolean;
        recordPaused?: boolean;
        recordStopped?: boolean;
        recordingMediaOptions?: string;
        mediaDevices?: {};
        vidCons?: any;
        frameRate?: number;
        targetResolution?: string;
        videoProducer?: any;
        transportCreated?: boolean;
        videoParams?: Record<string, unknown>;
        showAlert?: any;
        updateCustomImage?: ((image: string) => void);
        updateSelectedImage?: ((image: string) => void);
        updateSegmentVideo?: ((stream: null | MediaStream) => void);
        updateSelfieSegmentation?: ((segmentation: null | SelfieSegmentation) => void);
        updatePauseSegmentation?: ((pause: boolean) => void);
        updateProcessedStream?: ((stream: null | MediaStream) => void);
        updateKeepBackground?: ((keep: boolean) => void);
        updateBackgroundHasChanged?: ((changed: boolean) => void);
        updateVirtualStream?: ((stream: null | MediaStream) => void);
        updatePrevKeepBackground?: ((prev: boolean) => void);
        updateAppliedBackground?: ((applied: boolean) => void);
        updateVideoParams?: ((params: Record<string, unknown>) => void);
        updateAutoClickBackground?: ((auto: boolean) => void);
        createSendTransport?: ((options: Record<string, unknown>) => Promise<void>);
        connectSendTransportVideo?: ((options: Record<string, unknown>) => Promise<void>);
        disconnectSendTransportVideo?: ((options: Record<string, unknown>) => Promise<void>);
        onScreenChanges?: ((options: Record<string, unknown>) => Promise<void>);
        sleep?: ((options: {
            ms: number;
        }) => Promise<void>);
        getUpdatedAllParams?: (() => BackgroundModalParameters);
    }>;
    toggleBackgroundModal: ((next?: Partial<BackgroundModalParameters>) => void);
    openBackgroundModal: ((next?: Partial<BackgroundModalParameters>) => void);
    closeBackgroundModal: (() => void);
}

• isBackgroundModalVisible: Ref<boolean, boolean>

• backgroundModalParameters: ComputedRef<{
      customImage?: string;
      selectedImage?: string;
      segmentVideo?: null | {};
      selfieSegmentation?: null | {
          setOptions(options: Record<string, unknown>): void;
          initialize(): Promise<void>;
          onResults(callback: ((results: SelfieSegmentationResults) => void)): void;
          send(input: SelfieSegmentationInput): Promise<void>;
      };
      pauseSegmentation?: boolean;
      processedStream?: null | {};
      keepBackground?: boolean;
      backgroundHasChanged?: boolean;
      virtualStream?: null | {};
      mainCanvas?: null | HTMLCanvasElement;
      prevKeepBackground?: boolean;
      appliedBackground?: boolean;
      autoClickBackground?: boolean;
      videoAlreadyOn?: boolean;
      audioOnlyRoom?: boolean;
      islevel?: string;
      localStreamVideo?: null | {};
      recordStarted?: boolean;
      recordResumed?: boolean;
      recordPaused?: boolean;
      recordStopped?: boolean;
      recordingMediaOptions?: string;
      mediaDevices?: {};
      vidCons?: any;
      frameRate?: number;
      targetResolution?: string;
      videoProducer?: any;
      transportCreated?: boolean;
      videoParams?: Record<string, unknown>;
      showAlert?: any;
      updateCustomImage?: ((image: string) => void);
      updateSelectedImage?: ((image: string) => void);
      updateSegmentVideo?: ((stream: null | MediaStream) => void);
      updateSelfieSegmentation?: ((segmentation: null | SelfieSegmentation) => void);
      updatePauseSegmentation?: ((pause: boolean) => void);
      updateProcessedStream?: ((stream: null | MediaStream) => void);
      updateKeepBackground?: ((keep: boolean) => void);
      updateBackgroundHasChanged?: ((changed: boolean) => void);
      updateVirtualStream?: ((stream: null | MediaStream) => void);
      updatePrevKeepBackground?: ((prev: boolean) => void);
      updateAppliedBackground?: ((applied: boolean) => void);
      updateVideoParams?: ((params: Record<string, unknown>) => void);
      updateAutoClickBackground?: ((auto: boolean) => void);
      createSendTransport?: ((options: Record<string, unknown>) => Promise<void>);
      connectSendTransportVideo?: ((options: Record<string, unknown>) => Promise<void>);
      disconnectSendTransportVideo?: ((options: Record<string, unknown>) => Promise<void>);
      onScreenChanges?: ((options: Record<string, unknown>) => Promise<void>);
      sleep?: ((options: {
          ms: number;
      }) => Promise<void>);
      getUpdatedAllParams?: (() => BackgroundModalParameters);
  }>

• toggleBackgroundModal: ((next?: Partial<BackgroundModalParameters>) => void)

  • • (next?): void

    • Parameters

      • Optionalnext: Partial<BackgroundModalParameters>

      Returns void

• openBackgroundModal: ((next?: Partial<BackgroundModalParameters>) => void)

  • • (next?): void

    • Parameters

      • Optionalnext: Partial<BackgroundModalParameters>

      Returns void

• closeBackgroundModal: (() => void)

  • • (): void

    • Returns void