setAudioHardMute, setAudioSoftMute 失敗時は Error で返すように修正

Author: t-miya

Sora/AudioDeviceModuleWrapper.swift

@@ -2,33 +2,37 @@ import Foundation
 import WebRTC
 
 /// RTCAudioDeviceModule の録音ポーズ/再開をラップするクラス
-public final class AudioDeviceModuleWrapper {
+final class AudioDeviceModuleWrapper {
   private let audioDeviceModule: RTCAudioDeviceModule
   // ハードミュート処理を直列化するためのキュー
   private let queue = DispatchQueue(label: "jp.shiguredo.sora.audio.device.wrapper")
   // 現在のハードミュート状態
   private var isHardMuted: Bool = false
 
-  public init(audioDeviceModule: RTCAudioDeviceModule) {
+  init(audioDeviceModule: RTCAudioDeviceModule) {
     self.audioDeviceModule = audioDeviceModule
   }
 
   /// 音声のハードミュート有効化/無効化します
   /// - Parameter mute: `true` でミュート有効化、`false` でミュート無効化
-  /// - Returns: 成功した場合は `true`
-  public func setAudioHardMute(_ mute: Bool) -> Bool {
+  /// - Returns: 成功した場合は `true`、失敗した場合は `false` を返します
+  func setAudioHardMute(_ mute: Bool) -> Bool {
     queue.sync {
-      guard isHardMuted != mute else { return true }
+      guard isHardMuted != mute else {
+        return true
+      }
+
       let internalResult = mute ? pauseRecordingInternal() : resumeRecordingInternal()
       let message = "setAudioHardMute via RTCAudioDeviceModule mute=\(mute)"
       let result = internalResult == 0
       if result {
         isHardMuted = mute
         Logger.debug(type: .mediaChannel, message: message)
+        return true
       } else {
         Logger.error(type: .mediaChannel, message: "\(message) failed")
+        return false
       }
-      return result
     }
   }
 

Sora/MediaChannel.swift

@@ -524,68 +524,48 @@ public final class MediaChannel {
 
   /// MediaChannel の接続中にマイクをハードミュート有効化/無効化します
   /// - Parameter mute: `true` で有効化、`false` で無効化
-  /// - Returns: 成功した場合は `true`、接続状態などの理由で処理しなかった場合は `false`
-  public func setAudioHardMute(_ mute: Bool) -> Bool {
-    guard canSwitchAudioMute() else {
-      return false
+  /// - Returns: 成功した場合は `nil`、失敗した場合は `Error` を返します
+  public func setAudioHardMute(_ mute: Bool) -> Error? {
+    guard state == .connected else {
+      return SoraError.mediaChannelError(
+        reason: "MediaChannel is not connected (state: \(state))")
     }
 
-    return NativePeerChannelFactory.default.audioDeviceModuleWrapper.setAudioHardMute(mute)
-  }
-
-  /// MediaChannel の接続中にマイクをソフトミュート有効化 / 無効化します
-  /// - Parameter mute: `true` で有効化、`false` で無効化
-  /// - Returns: 成功した場合は `true`、接続状態などの理由で処理しなかった場合は `false`
-  public func setAudioSoftMute(_ mute: Bool) -> Bool {
-    guard canSwitchAudioMute() else {
-      return false
+    guard configuration.audioEnabled else {
+      return SoraError.mediaChannelError(reason: "audioEnabled is false")
     }
 
-    // senderStream が Nullable のためアンラップが必要
-    guard let senderStream else {
-      return false
+    if NativePeerChannelFactory.default.audioDeviceModuleWrapper.setAudioHardMute(mute) {
+      return SoraError.mediaChannelError(reason: "AudioDeviceModuleWrapper::setAudioHardMute failed")
     }
 
-    senderStream.audioEnabled = !mute
-    Logger.debug(type: .mediaChannel, message: "setAudioSoftMute mute=\(mute)")
-    return true
+    return nil
   }
 
-  // 音声ミュートの切り替えが可能かチェックします
-  private func canSwitchAudioMute() -> Bool {
-    // 接続中か
+  /// MediaChannel の接続中にマイクをソフトミュート有効化 / 無効化します
+  /// - Parameter mute: `true` で有効化、`false` で無効化
+  /// - Returns: 成功した場合は `nil`、失敗した場合は `Error` を返します
+  public func setAudioSoftMute(_ mute: Bool) -> Error? {
     guard state == .connected else {
-      Logger.debug(
-        type: .mediaChannel,
-        message: "Switch audio mute failed, cause MediaChannel is not connected (state: \(state))")
-      return false
+      return SoraError.mediaChannelError(
+        reason: "MediaChannel is not connected (state: \(state))")
     }
 
-    // 接続設定で音声を有効にしているか
     guard configuration.audioEnabled else {
-      Logger.debug(
-        type: .mediaChannel,
-        message: "Switch audio mute failed, cause audioEnabled is false")
-      return false
+      return SoraError.mediaChannelError(reason: "audioEnabled is false")
     }
 
-    // ストリームが存在するか
     guard let senderStream else {
-      Logger.debug(
-        type: .mediaChannel,
-        message: "Switch audio mute failed, cause senderStream is unavailable")
-      return false
+      return SoraError.mediaChannelError(reason: "senderStream is unavailable")
     }
 
-    // ストリームに音声トラックが含まれているか
     guard senderStream.hasAudioTrack else {
-      Logger.debug(
-        type: .mediaChannel,
-        message: "Switch audio mute failed, cause senderStream has no AudioTrack")
-      return false
+      return SoraError.mediaChannelError(reason: "senderStream has no AudioTrack")
     }
 
-    return true
+    senderStream.audioEnabled = !mute
+    Logger.debug(type: .mediaChannel, message: "setAudioSoftMute mute=\(mute)")
+    return nil
   }
 }
 

Sora/SoraError.swift

@@ -33,6 +33,9 @@ public enum SoraError: Error {
   /// ``PeerChannel`` で発生したエラー
   case peerChannelError(reason: String)
 
+  /// ``MediaChannel`` で発生したエラー
+  case mediaChannelError(reason: String)
+
   /// カメラに関するエラー
   case cameraError(reason: String)
 
@@ -74,6 +77,8 @@ extension SoraError: LocalizedError {
       return "Unknown signaling message type \(type)"
     case .peerChannelError(let reason):
       return "PeerChannel error (\(reason))"
+    case .mediaChannelError(let reason):
+      return "MediaChannel error (\(reason))"
     case .cameraError(let reason):
       return "Camera error: \(reason)"
     case .messagingError(let reason):