Enumerations

The following enumerations are available globally.

  • 音声コーデックを表します。

    See more

    Declaration

    Swift

    public enum AudioCodec
    extension AudioCodec: CustomStringConvertible
  • 音声モード。 AVAudioSession の音声モードと音声カテゴリを変更します。 詳細な設定を行いたい場合は AVAudioSession を使用して下さい。

    音声カテゴリのオプションは次の値が指定されます:

    • allowBluetooth
    • allowBluetoothA2DP
    • allowAirPlay
    See more

    Declaration

    Swift

    public enum AudioMode
  • 音声出力先

    See more

    Declaration

    Swift

    public enum AudioOutput

デフォルト値

  • ログレベルです。 上から下に向かってログの重要度が下がり、詳細度が上がります。 off はログを出力しません。

    1. fatal
    2. error
    3. warn
    4. info
    5. debug
    6. trace
    7. off
    See more

    Declaration

    Swift

    public enum LogLevel
  • SoraCloseEvent は、Sora の接続が切断された際のイベント情報を表します。

    接続が正常に切断された場合は、.ok(code, reason) ケースが使用され、 異常な切断やエラー発生時は、.error(Error) ケースが使用されます。

    See more

    Declaration

    Swift

    public enum SoraCloseEvent
  • ストリームの音声のボリュームの定数のリストです。

    See more

    Declaration

    Swift

    public enum MediaStreamAudioVolume
  • WebRTC フレームワークの情報を表します。

    See more

    Declaration

    Swift

    public enum WebRTCInfo
  • サイマルキャスト の rid をリクエストする RPC メソッド

    視聴するサイマルキャスト映像の解像度を指定する RPC メソッドです。

    See more

    Declaration

    Swift

    public enum RequestSimulcastRid : RPCMethodProtocol
  • スポットライト rid をリクエストする RPC メソッド

    スポットライト機能で注目する接続を指定する RPC メソッドです。

    See more

    Declaration

    Swift

    public enum RequestSpotlightRid : RPCMethodProtocol
  • スポットライト rid をリセットする RPC メソッド

    スポットライト機能の設定をリセットする RPC メソッドです。

    See more

    Declaration

    Swift

    public enum ResetSpotlightRid : RPCMethodProtocol
  • シグナリング通知メタデータを設定する RPC メソッド

    シグナリング通知全体にメタデータを設定する RPC メソッドです。 ジェネリック型パラメータで任意の型のメタデータを指定できます。

    使用例

    struct MyMetadata: Codable {
      let userId: String
      let sessionId: String
    }
    
    do {
      let metadata = MyMetadata(userId: "user123", sessionId: "sess456")
      let result = try await mediaChannel.rpc(
        method: PutSignalingNotifyMetadata<MyMetadata>.self,
        params: PutSignalingNotifyMetadataParams(metadata: metadata)
      )
      if let metadata = result?.result {
        print("Set metadata: \(metadata)")
      }
    } catch {
      print("Failed to set metadata: \(error)")
    }
    
    See more

    Declaration

    Swift

    public enum PutSignalingNotifyMetadata<Metadata> : RPCMethodProtocol where Metadata : Decodable, Metadata : Encodable
  • シグナリング通知メタデータのアイテムを設定する RPC メソッド

    シグナリング通知メタデータの特定キーに値を設定する RPC メソッドです。 ジェネリック型パラメータで値の型とレスポンスの型を指定できます。

    使用例

    struct NotifyResponse: Decodable {
      let key: String
      let value: String
    }
    
    do {
      let result = try await mediaChannel.rpc(
        method: PutSignalingNotifyMetadataItem<NotifyResponse, String>.self,
        params: PutSignalingNotifyMetadataItemParams(
          key: "status",
          value: "ready"
        )
      )
      if let response = result?.result {
        print("Set metadata item - key: \(response.key), value: \(response.value)")
      }
    } catch {
      print("Failed to set metadata item: \(error)")
    }
    
    See more

    Declaration

    Swift

    public enum PutSignalingNotifyMetadataItem<Metadata: Decodable, Value: Encodable>:
      RPCMethodProtocol
  • 接続するクライアントのロールを表します。

    See more

    Declaration

    Swift

    public enum Role
    extension Role: CustomStringConvertible
  • シグナリングの種別です。

    See more

    Declaration

    Swift

    public enum Signaling
  • サイマルキャストでの映像の種類を表します。

    See more

    Declaration

    Swift

    public enum SimulcastRid
  • サイマルキャストで視聴する映像の種類を表します。

    See more

    Declaration

    Swift

    public enum SimulcastRequestRid
  • スポットライトの映像の種類を表します 。

    See more

    Declaration

    Swift

    public enum SpotlightRid
  • ストリームの方向を表します。 シグナリングメッセージで使われます。

    See more

    Declaration

    Swift

    public enum SignalingRole : String
  • libwebrtc の内部で利用されているキューを表します。

    See more

    Declaration

    Swift

    public enum SoraDispatcher
  • SDK に関するエラーを表します。

    See more

    Declaration

    Swift

    public enum SoraError : Error
  • TLS のセキュリティポリシーを表します。

    See more

    Declaration

    Swift

    public enum TLSSecurityPolicy
  • Rid

    サイマルキャストの rid を表す汎用型

    See more

    Declaration

    Swift

    public enum Rid : Equatable
  • 映像コーデックを表します。

    See more

    Declaration

    Swift

    public enum VideoCodec
    extension VideoCodec: CustomStringConvertible
  • 映像フレームの種別です。 現在の実装では次の映像フレームに対応しています。

    • ネイティブの映像フレーム (RTCVideoFrame)
    • CMSampleBuffer (映像のみ、音声は非対応。 RTCVideoFrame に変換されます)
    See more

    Declaration

    Swift

    public enum VideoFrame
  • VideoView における、映像ソースの停止時の処理を表します。

    See more

    Declaration

    Swift

    public enum VideoViewConnectionMode
  • SDP でのマルチストリームの記述方式です。

    See more

    Declaration

    Swift

    public enum SDPSemantics
  • (リソースの逼迫により) 送信する映像の品質が維持できない場合の挙動です。

    See more

    Declaration

    Swift

    public enum DegradationPreference
  • WebSocket のステータスコードを表します。

    See more

    Declaration

    Swift

    public enum WebSocketStatusCode
  • WebSocket の通信で送受信されるメッセージを表します。

    See more

    Declaration

    Swift

    public enum WebSocketMessage