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

> 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. |
| Together Mode                           | ![together-mode](https://assets-docs.agora.io/images/video-sdk/together-mode.png) Allows the presenter to segment the portrait in the remote video, transmit it locally, and customize the display.                                                                                                                   |

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.

```swift
guard agoraEngine.isFeatureAvailable(onDevice: .videoPreprocessVirtualBackground) else {
  // Device doesn't support virtual background
  return
}
```

### Set a blurred background

To blur the video background, use the following code:

```swift
func blurBackground() {
  let virtualBackgroundSource = AgoraVirtualBackgroundSource()
  virtualBackgroundSource.backgroundSourceType = .blur
  virtualBackgroundSource.blurDegree = .high

  let segData = AgoraSegmentationProperty()
  segData.modelType = .agoraAi

  agoraEngine.enableVirtualBackground(true, backData: virtualBackgroundSource, segData: segData)
}
```

### Set a color background

To apply a solid color as the virtual background, use a hexadecimal color code.

```swift
func colorBackground() {
  let virtualBackgroundSource = AgoraVirtualBackgroundSource()
  virtualBackgroundSource.backgroundSourceType = .color
  virtualBackgroundSource.color = convertColorToHex(.red)

  let segData = AgoraSegmentationProperty()
  segData.modelType = .agoraAi

  agoraEngine.enableVirtualBackground(true, backData: virtualBackgroundSource, segData: segData)
}
```

### Set an image background

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

```swift
func imageBackground() {
  let virtualBackgroundSource = AgoraVirtualBackgroundSource()
  virtualBackgroundSource.backgroundSourceType = .img
  virtualBackgroundSource.source = Bundle.main.path(forResource: "background_ss", ofType: "jpg")

  let segData = AgoraSegmentationProperty()
  segData.modelType = .agoraAi

  agoraEngine.enableVirtualBackground(true, backData: virtualBackgroundSource, segData: segData)
}
```

### Reset the background

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

```swift
agoraEngine.enableVirtualBackground(false, backData: nil, segData: nil)
```

## 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

* [`isFeatureAvailable`](https://api-ref.agora.io/en/video-sdk/macos/4.x/documentation/agorartckit/agorartcenginekit/isfeatureavailable%28ondevice:%29)

* [`enableVirtualBackground`](https://api-ref.agora.io/en/video-sdk/macos/4.x/documentation/agorartckit/agorartcenginekit/enablevirtualbackground%28_\:backdata\:segdata:%29)

* [`AgoraVirtualBackgroundSource`](https://api-ref.agora.io/en/video-sdk/macos/4.x/documentation/agorartckit/agoravirtualbackgroundsource)

* [`AgoraSegmentationProperty`](https://api-ref.agora.io/en/video-sdk/macos/4.x/documentation/agorartckit/agorasegmentationproperty)