HMSVirtualBackground

All Implemented Interfaces:

live.hms.video.plugin.video.HMSVideoPlugin , live.hms.video.plugin.video.virtualbackground.HmsVirtualBackgroundInterface
```
public final class HMSVirtualBackground
 implements HmsVirtualBackgroundInterface
                    
```

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`HMSVirtualBackground.Companion`

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description
`HMSVirtualBackground(HMSSDK hmsSdk)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`Unit`	`init()`
`HMSVideoPluginType`	`getPluginType()`
`Integer`	`getCurrentBlurPercentage()`	Retrieves the current blur percentage applied to the video frames.
`Unit`	`enableBlur(Integer blurPercentage)`	Enables the blur effect on the video frames.
`Unit`	`enableBackground(Bitmap bitmap)`	Enables the background replacement effect on the video frames.
`Unit`	`disableEffects()`	Disables all video effects.
`Unit`	`setVideoFrameInfoListener(VideoFrameInfoListener listener)`	Sets the VideoFrameInfoListener to receive information about video frames.
`Unit`	`processVideoFrame(VideoFrame inputVideoFrame, HMSPluginResultListener outputListener, Boolean skipProcessing)`
`Unit`	`stop()`
`String`	`getName()`
`Boolean`	`isSupported()`
`Unit`	`setKey(String key)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HMSVirtualBackground
```
HMSVirtualBackground(HMSSDK hmsSdk)
```
- Method Detail
  - init
```
 Unit init()
```
  - getPluginType
```
 HMSVideoPluginType getPluginType()
```
  - getCurrentBlurPercentage
```
 Integer getCurrentBlurPercentage()
```
    Retrieves the current blur percentage applied to the video frames.
  - enableBlur
```
 Unit enableBlur(Integer blurPercentage)
```
    Enables the blur effect on the video frames.
    
    Parameters:
    
    blurPercentage - The percentage of blur to be applied, ranging from 0 to 100.
  - enableBackground
```
 Unit enableBackground(Bitmap bitmap)
```
    Enables the background replacement effect on the video frames.
    
    Parameters:
    
    bitmap - The bitmap to be used as the replacement background.
  - disableEffects
```
 Unit disableEffects()
```
    Disables all video effects.
  - setVideoFrameInfoListener
```
 Unit setVideoFrameInfoListener(VideoFrameInfoListener listener)
```
    Sets the VideoFrameInfoListener to receive information about video frames.
    
    Parameters:
    
    listener - The listener instance to be notified about video frame information.
  - processVideoFrame
```
 Unit processVideoFrame(VideoFrame inputVideoFrame, HMSPluginResultListener outputListener, Boolean skipProcessing)
```
  - stop
```
 Unit stop()
```
  - getName
```
 String getName()
```
  - isSupported
```
 Boolean isSupported()
```
  - setKey
```
 Unit setKey(String key)
```