####################
サイマルキャスト機能
####################

.. _simulcast:

概要
====

サイマルキャスト (Simulcast) 機能は配信時に 1 つの RTCPeerConnection から複数種類のエンコードした映像を配信する機能です。
詳細は `Sora ドキュメント サイマルキャスト機能 <https://sora-doc.shiguredo.jp/SIMULCAST>`_ を参照してください。

サイマルキャストを有効にする
============================

Sora 接続時に ``Configuration.simulcastEnabled`` プロパティを ``true`` に設定します。
視聴時に受信する映像を ``Configuration.SimulcastRid`` で指定可能です。


サイマルキャストの Configuration 設定例
-----------------------------------------

ビットレートや解像度が低い場合、 3 段階の画質の切替ができないことがあります。
詳細は `Sora ドキュメント 現時点でのサイマルキャストの仕様 <https://sora-doc.shiguredo.jp/SIMULCAST#id4>`_ を参照してください。

.. code-block:: swift

  // 接続の設定を行います。
  let config = Configuration(url: soraURL,
                             channelId: soraChannelId,
                             role: role,
                             multistreamEnabled: multiplicityControl.selectedSegmentIndex == 1)

  // サイマルキャストの有効化
  config.simulcastEnabled = true

  // サイマルキャスト受信時の映像を指定
  config.simulcastRid = .r0

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

  // 十分な解像度、ビットレートを指定しないとサイマルキャストの映像が 3 本になりません
  config.videoBitRate = 15000

  // 解像度、フレームレートの設定
  let cameraSettings = CameraVideoCapturer.Settings(resolution: .hd1080p,
                                                    frameRate: 30,
                                                    canStop: true)
  config.videoCapturerDevice = VideoCapturerDevice.camera(settings: cameraSettings)