# Virtual Background (/en/realtime-media/rtc/build/apply-video-effects/virtual-background/flutter)

> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).

Virtual Background enables users to blur their background, or replace it with a solid color or an image. This feature is applicable to use-cases such as online conferences, online classes, and live streaming. It helps protect personal privacy and reduces audience distraction.

      
  
      
  
      
  
      
  
      
  
      
## Understand the tech

Virtual Background offers the following options:

| Feature                                 | Example                                                                                                                                                                                                                                                                                                               |
| --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Blurred background and image background | ![image](https://assets-docs.agora.io/images/extensions-marketplace/blurred-background.jpg)                                                                                                                                                                                                                           |
| Video/Animated background               | <video src="https://assets-docs.agora.io/images/extensions-marketplace/virtual-background.mp4" poster="https://web-cdn.agora.io/docs-files/1654571689670" width="100%" height="auto">Your browser does not support the `video` element.</video>                                                                       |
| Portrait-in-picture                     | ![portrait-in-picture](https://assets-docs.agora.io/images/extensions-marketplace/portrait-in-picture.jpg) Allows the presenter to use slides as the virtual background while superimposing their video. The effect is similar to a weather news cast on television, preventing interruptions during a layout toggle. |

Want to test Virtual Background? Try the <a href="https://webdemo.agora.io/virtualBackground/index.html">online demo</a>.

## Prerequisites

Ensure that you have implemented the [SDK quickstart](/en/realtime-media/rtc/get-started-sdk) in your project.

## Implement virtual background

This section shows you how to add a virtual background to the local video.

### Check device compatibility

To avoid performance degradation or unavailable features when enabling Virtual Background on low-end devices, check whether the device supports the feature.

```dart
if (!await _engine.isFeatureAvailableOnDevice(FeatureType.videoVirtualBackground)) {
  return;
}
```

### Set a blurred background

To blur the video background, use the following code:

```dart
Future<void> setBlurBackground() async {
  final virtualBackgroundSource = const VirtualBackgroundSource(
    backgroundSourceType: BackgroundSourceType.backgroundBlur,
    blurDegree: BackgroundBlurDegree.blurDegreeHigh,
  );

  final segmentationProperty = const SegmentationProperty(
    modelType: SegModelType.segModelAi,
    greenCapacity: 0.5,
  );

  // Enable or disable virtual background
  _engine.enableVirtualBackground(
    enabled: true,
    backgroundSource: virtualBackgroundSource,
    segproperty: segmentationProperty);
}
```

### Set a color background

To apply a solid color as the virtual background, use a hexadecimal color code. For example, `0x0000FF` for blue:

```dart
Future<void> setColorBackground() async {
  final virtualBackgroundSource = const VirtualBackgroundSource(
    backgroundSourceType: BackgroundSourceType.backgroundColor,
    color: 0x0000FF,
  );

  final segmentationProperty = const SegmentationProperty(
    modelType: SegModelType.segModelAi,
    greenCapacity: 0.5,
  );

  // Enable or disable virtual background
  _engine.enableVirtualBackground(
    enabled: true,
    backgroundSource: virtualBackgroundSource,
    segproperty: segmentationProperty);
}
```

### Set an image background

To set a custom image as the virtual background, specify the path to the image file.

```dart
Future<void> setImageBackground() async {
  final virtualBackgroundSource = const VirtualBackgroundSource(
    backgroundSourceType: BackgroundSourceType.backgroundImg,
    source: "<path to an image file>",
  );

  final segmentationProperty = const SegmentationProperty(
    modelType: SegModelType.segModelAi,
    greenCapacity: 0.5,
  );

  // Enable or disable virtual background
  _engine.enableVirtualBackground(
    enabled: true,
    backgroundSource: virtualBackgroundSource,
    segproperty: segmentationProperty);
}
```

### Reset the background

To disable the virtual background and revert to the original video state, use the following code:

```dart
Future<void> resetVirtualBackground() async {
  await enableVirtualBackground( false,
    const VirtualBackgroundSource(),
    const SegmentationProperty(),
  );
}
```

## Reference

This section contains content that completes the information in this page, or points you to documentation that explains other aspects to this product.

### API reference

* [`isFeatureAvailableOnDevice`](https://api-ref.agora.io/en/video-sdk/flutter/6.x/API/class_irtcengine.html#api_irtcengine_isfeatureavailableondevice)

* [`enableVirtualBackground`](https://api-ref.agora.io/en/video-sdk/flutter/6.x/API/class_irtcengine.html#api_irtcengine_enablevirtualbackground)

* [`VirtualBackgroundSource`](https://api-ref.agora.io/en/video-sdk/flutter/6.x/API/class_virtualbackgroundsource.html)

* [`SegmentationProperty`](https://api-ref.agora.io/en/video-sdk/flutter/6.x/API/class_segmentationproperty.html)

    
  
      
  
      
  
      
  
      
  
      
  
