SoraError

public enum SoraError : Error

SDK に関するエラーを表します。

Show on GitHub

  • 接続試行中に処理がキャンセルされたことを示します。

    Declaration

    Swift

    case connectionCancelled
    Show on GitHub

  • 接続タイムアウト。 接続試行開始から一定時間内に接続できなかったことを示します。

    Declaration

    Swift

    case connectionTimeout
    Show on GitHub

  • 何らかの処理の実行中で、指定された処理を実行できないことを示します。

    Declaration

    Swift

    case connectionBusy(reason: String)
    Show on GitHub

  • WebSocketChannel が接続解除されたことを示します。 導入当初は Sora から受信したクローズフレームのステータスコードが 1000 以外のときにこの Error を返していたが 2025.2.0 から、ステータスコードが 1000 のときも onDisconnect に切断理由を返すためにこの Error を使うようになった また、この Error は onDisconnect では Error ではなく、SoraCloseEvent.ok(code, reason) としてユーザーに通知される

    Declaration

    Swift

    case webSocketClosed(statusCode: WebSocketStatusCode, reason: String?)
    Show on GitHub

  • WebSocketChannel で発生したエラー

    Declaration

    Swift

    case webSocketError(Error)
    Show on GitHub

  • SignalingChannel で発生したエラー

    Declaration

    Swift

    case signalingChannelError(reason: String)
    Show on GitHub

  • シグナリングメッセージのフォーマットが無効

    Declaration

    Swift

    case invalidSignalingMessage
    Show on GitHub

  • 非対応のシグナリングメッセージ種別

    Declaration

    Swift

    case unknownSignalingMessageType(type: String)
    Show on GitHub

  • PeerChannel で発生したエラー

    Declaration

    Swift

    case peerChannelError(reason: String)
    Show on GitHub

  • カメラに関するエラー

    Declaration

    Swift

    case cameraError(reason: String)
    Show on GitHub

  • メッセージング機能のエラー

    Declaration

    Swift

    case messagingError(reason: String)
    Show on GitHub

  • DataChannel 経由のシグナリングで type: close を受信し、接続が解除されたことを示します。

    • statusCode: ステータスコード
    • reason: 切断理由

    Declaration

    Swift

    case dataChannelClosed(statusCode: Int, reason: String)
    Show on GitHub