Merge pull request #287 from shiguredo/feature/simulcast-request-rid

SimulcastRequestRid に対応する

Author: zztkm

CHANGES.md

@@ -16,6 +16,9 @@
 - [UPDATE] Statistics, StatisticsEntry をドキュメント対象として公開する
   - `getStats` メソッドの返り値である `Statistics` のドキュメントを生成するため
   - @t-miya
+- [UPDATE] Configuration.simulcastRid を非推奨にする
+  - 移行先は `Configuration.simulcastRequestRid`
+  - @zztkm
 - [ADD] MediaChannel に libwebrtc の統計情報を取得する `getStats` メソッドを追加する
   - @t-miya
 - [ADD] RTCAudioTrack から音声データを受け取るためのコールバックプロトコルである RTCAudioTrackSink を追加する
@@ -25,6 +28,10 @@
     - `addAudioTrackSink(_ sink: RTCAudioTrackSink)`
     - `removeAudioTrackSink(_ sink: RTCAudioTrackSink)`
   - @zztkm
+- [ADD] シグナリング接続時に視聴するストリームの rid を指定する `Configuration.simulcastRequestRid: SimulcastRequestRid?` を追加する
+  - SimulcastRequestRid は none 、 r0 、 r1 、 r2 を指定できる
+  - role が sendrecv または recvonly の場合、かつ simulcast が true の場合にのみ有効
+  - @zztkm
 
 ### misc
 

Sora/Configuration.swift

@@ -139,9 +139,22 @@ public struct Configuration {
   public var simulcastEnabled: Bool = false
 
   /// サイマルキャストでの映像の種類。
-  /// ロールが `.sendrecv` または `.recvonly` のときのみ有効です。
+  /// ロールが `.sendrecv` または `.recvonly` かつ `simulcastEnabled` が true のときのみ有効です。
+  ///
+  /// simulcastRequestRid と同時に設定された場合、Sora 2025.2.0 以降では simulcastRequestRid が優先されます。
+  @available(
+    *, deprecated,
+    message: "2027 年 12 月リリース予定の Sora にて廃止予定です。",
+    renamed: "simulcastRequestRid"
+  )
   public var simulcastRid: SimulcastRid?
 
+  /// サイマルキャストで視聴する映像の種類。
+  /// ロールが `.sendrecv` または `.recvonly` かつ `simulcastEnabled` が true のときのみ有効です。
+  ///
+  /// このプロパティは Sora 2025.2.0 以降で利用可能です。
+  public var simulcastRequestRid: SimulcastRequestRid?
+
   /// スポットライトの可否
   /// 詳しくは Sora のスポットライト機能を参照してください。
   public var spotlightEnabled: Spotlight = .disabled

Sora/PeerChannel.swift

@@ -353,6 +353,7 @@ class PeerChannel: NSObject, RTCPeerConnectionDelegate {
       spotlightUnfocusRid: configuration.spotlightUnfocusRid,
       simulcastEnabled: simulcast,
       simulcastRid: configuration.simulcastRid,
+      simulcastRequestRid: configuration.simulcastRequestRid,
       soraClient: soraClient,
       webRTCVersion: webRTCVersion,
       environment: DeviceInfo.current.description,

Sora/Signaling.swift

@@ -198,6 +198,21 @@ public enum SimulcastRid {
   case r2
 }
 
+/// サイマルキャストで視聴する映像の種類を表します。
+public enum SimulcastRequestRid {
+  /// 映像を受信しない
+  case none
+
+  /// r0
+  case r0
+
+  /// r1
+  case r1
+
+  /// r2
+  case r2
+}
+
 /// スポットライトの映像の種類を表します 。
 public enum SpotlightRid {
   /**
@@ -310,6 +325,9 @@ public struct SignalingConnect {
   /// サイマルキャストでの映像の種類
   public var simulcastRid: SimulcastRid?
 
+  /// サイマルキャストで視聴する映像の種類
+  public var simulcastRequestRid: SimulcastRequestRid?
+
   /// :nodoc:
   public var soraClient: String?
 
@@ -768,6 +786,27 @@ extension SimulcastRid: Codable {
   }
 }
 
+private var simulcastRequestRidTable: PairTable<String, SimulcastRequestRid> =
+  PairTable(
+    name: "simulcastRequestRid",
+    pairs: [
+      ("none", .none),
+      ("r0", .r0),
+      ("r1", .r1),
+      ("r2", .r2),
+    ])
+
+/// :nodoc:
+extension SimulcastRequestRid: Codable {
+  public init(from decoder: Decoder) throws {
+    throw SoraError.invalidSignalingMessage
+  }
+
+  public func encode(to encoder: Encoder) throws {
+    try simulcastRequestRidTable.encode(self, to: encoder)
+  }
+}
+
 private var spotlightRidTable: PairTable<String, SpotlightRid> =
   PairTable(
     name: "spotlightRid",
@@ -830,6 +869,7 @@ extension SignalingConnect: Codable {
     case spotlight_unfocus_rid
     case simulcast
     case simulcast_rid
+    case simulcast_request_rid
     case video
     case audio
     case sora_client
@@ -952,6 +992,8 @@ extension SignalingConnect: Codable {
       switch role {
       case .sendrecv, .recvonly:
         try container.encodeIfPresent(simulcastRid, forKey: .simulcast_rid)
+        try container.encodeIfPresent(
+          simulcastRequestRid, forKey: .simulcast_request_rid)
       default:
         break
       }