スポットライト機能

概要

スポットライト機能およびスポットライトレガシー機能は、一定の音量を超えて音声を発している参加者の音声や映像のみを配信する機能です。 詳細は以下ドキュメントを参照してください。

スポットライト機能は VP8 と H.264 でのみ利用可能です。

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

サーバ接続時に以下を設定します

  • マルチストリームを有効にする。

  • Configuration.spotlightEnabled プロパティに .enabled を指定する。

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

  • Configuration.spotlightNumber プロパティでスポットライトのフォーカス数を指定する。

  • Configuration.spotlightFocusRid プロパティでフォーカスされている映像の rid を指定する。

  • Configuration.spotlightUnfocusRid プロパティでフォーカスされていない映像の rid を指定する。

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

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

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

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

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

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

// スポットライト用にビットレートを高めに設定することを推奨します。
config.videoBitRate = 3000

スポットライトレガシー機能を有効にする

サーバ接続時に以下を指定します

  • マルチストリームを有効にする。

  • Sora オブジェクトの useSpotlightLegacy() を実行する。

  • Configuration.spotlightEnabled プロパティに .enabled を指定する。

  • Configuration.spotlightNumber プロパティにスポットライトのフォーカス数を指定する。

スポットライトレガシー機能はサイマルキャストと併用できません。サイマルキャストを無効にしてご利用ください。

スポットライトレガシーの Configuration 設定例

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

// スポットライトレガシーを有効にします。
config.spotlightEnabled = true

// アクティブな配信数を設定します。
config.spotlightNumber = 2
© Copyright 2018-2021, Shiguredo Inc. Created using Sphinx 4.2.0