Zoom Meeting SDK for Web
    Preparing search index...

    Function vbStatusDataFunc

    • Virtual background (VB) status success callback

      Parameters

      • data: {
            result: {
                blur: boolean;
                id: any;
                lock: boolean;
                mask: boolean;
                status: boolean;
                vb: boolean;
                vbList: VbImageInfoType[];
            };
        }
        • result: {
              blur: boolean;
              id: any;
              lock: boolean;
              mask: boolean;
              status: boolean;
              vb: boolean;
              vbList: VbImageInfoType[];
          }

          Result:

          • blur: boolean

            Enable a blurred background or not.

          • id: any

            The current user's VB ID.

          • lock: boolean

            Whether or not VB is locked.

          • mask: boolean

            always false, remove mask feature since 3.11.0

          • status: boolean

            If true, the user can enable VB or blur through the UI and the developer can't call the following APIs to control it: updateVirtualBackgroundList setVirtualBackground lockVirtualBackground

          • vb: boolean

            True if the user selected VB, false if not.

          • vbList: VbImageInfoType[]

            vbList, name is VB image name, must be unique and identify different VB image

      Returns void