This article describes how you can use the Webex Android Meetings SDK to work with virtual backgrounds in your app.

anchorVirtual Background Notes

When using custom virtual backgrounds, consider the following guidelines:

• Supported image formats for custom backgrounds are JPG and PNG.
• The SDK resizes images larger than 1280x720 to avoid excessive CPU usage.
• Application storage will increase based on the custom images used.
• High CPU usage by the Virtual Background feature may trigger CallObserver.onCpuHitThreshold(). If that happens, consider disabling the feature.

anchorVirtual Background Types

The Webex iOS Meetings SDK lets you choose from three options:

• None
• Blur
• Custom

None

Removes any custom or blurred background, effectively disabling the virtual background feature. This is the default setting.

Blur

Applies a blur effect to the background.

Custom

Allows the use of a personal image as the background.

anchorHow to Use Virtual Backgrounds

The following sections describe how to use the virtual background functionality in the Webex iOS Meetings SDK.

Check Device Compatibility

To check if the device supports virtual backgrounds:

val isSupported: Boolean = webex.phone.isVirtualBackgroundSupported()

Fetch Available Virtual Backgrounds

To retrieve available virtual backgrounds:

webex.phone.fetchVirtualBackgrounds( CompletionHandler { result ->  
    if (result.isSuccessful) {
        val data: List<VirtualBackground>? = result.data
        //display the background
    } else {
        Log.d(tag, "error: ${result.error?.message}")
    }
})

Upload a Custom Virtual Background

To upload a custom virtual background:

val thumbnailFile = FileUtils.getFileFromResource(this, "nature-thumb")
val file = FileUtils.getFileFromResource(this, "nature")
val thumbnail = LocalFile.Thumbnail(thumbnailFile, null, 64, 64)

val imgFile = LocalFile(file, null, thumbnail, null)

webex.phone.addVirtualBackground(imgFile, CompletionHandler { result ->
    if (result.isSuccessful) {
        val data: VirtualBackground? = result.data
        //handle the success response
    } else {
        Log.d(tag, "error: ${result.error?.message}")
    }
})

Apply a Virtual Background

To apply a virtual background:

//Specify the mode PREVIEW or CALL as per requirement. 
val mode = Phone.VirtualBackgroundMode.PREVIEW // Phone.VirtualBackgroundMode.CALL
webex.phone.applyVirtualBackground(virtualBackgroundItem, mode, CompletionHandler { result ->
    if (result.isSuccessful) {
        val data: Boolean? = result.data
        //handle the success response
    } else {
            Log.d(tag, "error: ${result.error?.message}")
    }
})

Specify the display mode, set either PREVIEW or CALL, depending on your requirements.

Remove Virtual Background

To remove a virtual background:

webex.phone.removeVirtualBackground(background, CompletionHandler { result ->
    if (result.isSuccessful) {
        val data: Boolean? = result.data
        //handle the delete response
    } else {
        Log.d(tag, "error: ${result.error?.message}")
    }
})

Manage the Virtual Background Limit

Set the number of virtual backgrounds that you want to support. The default limit is 3.

webex.phone.setMaxVirtualBackgroundItems(limit)

Retrieve the Background Limit

To retrieve the current virtual background limit:

val limit: Int = webex.phone.getMaxVirtualBackgroundItems()