removeBackgroundImage

Removes a background image from the background image list.

public boolean removeBackgroundImage(AgoraImage backgroundImage) {
    if (backgroundImageList == null) {
      return false;
    }
    return backgroundImageList.remove(backgroundImage);
  }

Details

This method only supports removing one background image every time. If you need to remove more than one background image, call this method multiple times.

Parameters

backgroundImage
The number of background images on the live video. Watermark images must be in the PNG format. See AgoraImage.

Returns

Whether the background image is removed:

  • true: The background image is removed.
  • false: The background image is not removed.