.. danger:: 2022 年 6 月のリリースよりスポットライト機能で複数画質を送信するにはサイマルキャスト機能を有効化する必要があります

####################
スポットライト機能
####################

.. _spotlight:

概要
====

スポットライト機能は、一定の音量を超えて音声を発している参加者の画質を優先して配信する機能です。
詳細は以下ドキュメントを参照してください。

- `Sora ドキュメント スポットライト機能 <https://sora-doc.shiguredo.jp/SPOTLIGHT>`_


スポットライト機能を有効にする
==============================

Sora 接続時に以下を設定します

- マルチストリーム機能を有効にします。
- ``Configuration.spotlightEnabled`` プロパティに ``.enabled`` を指定します。
- ``Configuration.simulcastEnabled`` プロパティを指定します。

  - 自分の映像について、音声に応じて画質の切り替えを行う場合は ``true`` を指定します。
  - 自分の映像について、音声に応じて画質の切り替えを行なわない場合は ``false`` を指定します。

追加で以下のオプションが設定可能です

- ``Configuration.spotlightNumber`` プロパティでスポットライトのフォーカス数を指定します。
- ``Configuration.spotlightFocusRid`` プロパティでフォーカスされている映像の rid を指定します。
- ``Configuration.spotlightUnfocusRid`` プロパティでフォーカスされていない映像の rid を指定します。

スポットライトの Configuration 設定例
-----------------------------------------

.. code-block:: swift

  // 接続の設定を行います。マルチストリーム機能を有効にする必要があります。
  let config = Configuration(url: soraURL,
                             channelId: soraChannelId,
                             role: role,
                             multistreamEnabled: true)

  // サイマルキャストを有効にします。
  // 自分が話していない時は画質が落ちた状態で配信されます。
  config.simulcastEnabled = true

  // スポットライトを有効にします。
  config.spotlightEnabled = .enabled

  // スポットライトのフォーカスする配信数を設定可能です。
  config.spotlightNumber = 2

  // スポットライトがフォーカスされている映像、フォーカスされていない映像の rid を設定可能です。
  // 映像を受信しない設定も可能です。
  config.spotlightFocusRid = .r1
  config.spotlighspotlightUnfocusRidtEnabled = .none

  // 動画のコーデックを設定します。
  config.videoCodec = .vp8