本文にスキップする
Version: 6.0

バーチャル背景

ビデオ通話中にバーチャル背景(virtual background)機能を使用して、背景をぼかしたり画像に置き換えたりすることができます。ここでは、バーチャル背景機能の使い方について説明します。

対応する通話タイプSDKの最低バージョン
1対1通話、グループ通話(カンファレンス)PlanetKit 5.4
Note

バーチャル背景機能は、次のデバイスおよびOSバージョンと互換性があります。

  • iOS:iPhone 12以上のモデル、iOS 15以上
  • macOS:Appleシリコンを搭載したAppleデスクトップとノートパソコン、macOS 12以上
Warning

バーチャル背景効果を適用すると、CPU使用率が増加します。

概要

バーチャル背景機能を使用するには、計算型プロパティ(computed property)であるPlanetKitCameraManager.shared.virtualBackgroundPlanetKitVirtualBackgroundクラスと共に使用します。

ぼかし背景を設定する

背景にぼかし(blur)効果を適用するには、PlanetKitVirtualBackground(blurRadius:)メソッドを使ってPlanetKitCameraManager.shared.virtualBackgroundを設定します。

let blurRadius: Float
PlanetKitCameraManager.shared.virtualBackground = PlanetKitVirtualBackground(blurRadius: blurRadius)

blurRadiusパラメーターは、バーチャル背景に適用するガウスぼかし(Gaussian blur)の半径を定めます。blurRadiusの推奨デフォルト値は15.0で、blurRadiusが大きいほど結果はぼやけます。

画像を背景に設定する

背景を画像に置き換えるには、PlanetKitVirtualBackground(image:)メソッドを使ってPlanetKitCameraManager.shared.virtualBackgroundを設定します。

let uiImage = UIImage(named: "BackgroundImage")
let image = CIImage(image: uiImage)
PlanetKitCameraManager.shared.virtualBackground = PlanetKitVirtualBackground(image: image)

バーチャル背景タイプを確認する

現在使用中のバーチャル背景のタイプはPlanetKitCameraManager.shared.virtualBackground.typeで確認できます。返却されるPlanetKitVirtualBackgroundTypenoneblurimageのいずれかです。

let currentVirtualBackgroundType = PlanetKitCameraManager.shared.virtualBackground?.type ?? .none

バーチャル背景を解除する

バーチャル背景を解除するには、PlanetKitCameraManager.shared.virtualBackgroundnilに設定します。

PlanetKitCameraManager.shared.virtualBackground = nil

関連API

バーチャル背景機能に関連するAPIは次のとおりです。