PlanetKitVirtualBackground

public class PlanetKitVirtualBackground : NSObject

PlanetKitVirtualBackground enables the detection and segmentation of human subjects from the background in the PlanetKitCamera video feeds.

Remark

Please note that this feature is compatible with iPhone 12 and newer models, as well as MacBook devices equipped with the Apple Silicon processor.

  • The type of virtual background.

    Declaration

    Swift

    @objc
public let type: PlanetKitVirtualBackgroundType

  • The image used as the virtual background.

    Declaration

    Swift

    @objc
public let image: CIImage?

  • The radius for the Gaussian blur applied to the virtual background.

    Declaration

    Swift

    @objc
public let blurRadius: Float

  • Initializes a new instance of PlanetKitVirtualBackground with the specified image.

    Declaration

    Swift

    @objc
public init(image: CIImage)

    Parameters

    image

    The image used as the virtual background.

  • Initializes a new instance of PlanetKitVirtualBackground with the specified blur radius.

    Remark

    Through our testing, a value of 15.0 has been found to provide a good balance of blur effect. Adjust this value to increase or decrease the blur intensity as required.

    See

    https://developer.apple.com/documentation/coreimage/cigaussianblur

    Declaration

    Swift

    @objc
public init(blurRadius: Float)

    Parameters

    blurRadius

    The radius for the Gaussian blur applied to the virtual background.