Type Alias ZoomVideoSdkVirtualBackgroundHelperType

Virtual background helper.

type ZoomVideoSdkVirtualBackgroundHelperType = {
    addVirtualBackgroundItem: (
        filePath: string,
    ) => Promise<ZoomVideoSdkVirtualBackgroundItem>;
    getVirtualBackgroundItemList: () => Promise<
        ZoomVideoSdkVirtualBackgroundItem[],
    >;
    isSupportVirtualBackground: () => Promise<boolean>;
    removeVirtualBackgroundItem: (imageName: string) => Promise<Errors>;
    setVirtualBackgroundItem: (imageName: string) => Promise<Errors>;
}

Properties

addVirtualBackgroundItem: (
filePath: string,
) => Promise<ZoomVideoSdkVirtualBackgroundItem>

Add virtual background object.

getVirtualBackgroundItemList: () => Promise<ZoomVideoSdkVirtualBackgroundItem[]>

Returns a collection of virtual background item as an object of type ZoomVideoSDKVirtualBackgroundItem.

isSupportVirtualBackground: () => Promise<boolean>

Determine whether the user can support smart virtual backgrounds.

removeVirtualBackgroundItem: (imageName: string) => Promise<Errors>

Remove virtual background object.

setVirtualBackgroundItem: (imageName: string) => Promise<Errors>

Select virtual background item.