Merge pull request #225 from shiguredo/feature/deprecated-multistream-option

multistreamEnabled を非推奨扱いにする

Author: zztkm

CHANGES.md

@@ -11,6 +11,11 @@
 
 ## develop
 
+- [UPDATE] multistreamEnabled を非推奨扱いにする
+  - multistreamEnabled の設定が不要なイニシャライザを `Configuration` に追加する
+  - ドキュメントコメントに非推奨扱いの旨を追加する
+  - @zztkm
+
 ## 2025.1.1
 
 **リリース日**: 2025-01-23

Sora/Configuration.swift

@@ -86,13 +86,16 @@ public struct Configuration {
     public var role: Role
 
     /// マルチストリームの可否
-    public var multistreamEnabled: Bool
+    ///
+    /// レガシーストリーム機能は 2025 年 6 月リリースの Sora にて廃止します
+    /// そのため、multistreamEnabled の使用は非推奨です
+    public var multistreamEnabled: Bool?
 
     /// :nodoc:
     var isMultistream: Bool {
         switch role {
         default:
-            return multistreamEnabled
+            return multistreamEnabled ?? true
         }
     }
 
@@ -226,12 +229,12 @@ public struct Configuration {
      - parameter url: サーバーの URL
      - parameter channelId: チャネル ID
      - parameter role: ロール
-     - parameter multistreamEnabled: マルチストリームの可否
+     - parameter multistreamEnabled: マルチストリームの可否(デフォルトは指定なし)
      */
     public init(url: URL,
                 channelId: String,
                 role: Role,
-                multistreamEnabled: Bool)
+                multistreamEnabled: Bool? = nil)
     {
         urlCandidates = [url]
         self.channelId = channelId
@@ -244,12 +247,12 @@ public struct Configuration {
      - parameter urlCandidates: シグナリングに利用する URL の候補
      - parameter channelId: チャネル ID
      - parameter role: ロール
-     - parameter multistreamEnabled: マルチストリームの可否
+     - parameter multistreamEnabled: マルチストリームの可否(デフォルトは指定なし)
      */
     public init(urlCandidates: [URL],
                 channelId: String,
                 role: Role,
-                multistreamEnabled: Bool)
+                multistreamEnabled: Bool? = nil)
     {
         self.urlCandidates = urlCandidates
         self.channelId = channelId

Sora/PeerChannel.swift

@@ -294,7 +294,10 @@ class PeerChannel: NSObject, RTCPeerConnectionDelegate {
                      message: "did connect to signaling channel")
 
         var role: SignalingRole
-        var multistream = configuration.multistreamEnabled || configuration.spotlightEnabled == .enabled
+        var multistream = configuration.multistreamEnabled
+        if configuration.spotlightEnabled == .enabled {
+            multistream = true
+        }
         switch configuration.role {
         case .sendonly:
             role = .sendonly

Sora/Signaling.swift

@@ -270,6 +270,9 @@ public struct SignalingConnect {
     public var sdp: String?
 
     /// マルチストリームの可否
+    ///
+    /// レガシーストリーム機能は 2025 年 6 月リリースの Sora にて廃止します
+    /// そのため、multistreamEnabled の使用は非推奨です
     public var multistreamEnabled: Bool?
 
     /// 映像の可否