Configuration

public struct Configuration

クライアントに関する設定です。

Show on GitHub

接続に関する設定

  • スポットライトの設定

    See more

    Declaration

    Swift

    public enum Spotlight
    Show on GitHub

  • シグナリングに利用する URL の候補

    Declaration

    Swift

    public var urlCandidates: [URL]
    Show on GitHub

  • チャネル ID

    Declaration

    Swift

    public var channelId: String
    Show on GitHub

  • クライアント ID

    Declaration

    Swift

    public var clientId: String?
    Show on GitHub

  • バンドル ID

    Declaration

    Swift

    public var bundleId: String?
    Show on GitHub

  • ロール

    Declaration

    Swift

    public var role: Role
    Show on GitHub

  • マルチストリームの可否

    Declaration

    Swift

    @available(*, deprecated, message: "レガシーストリーム機能は 2025 年 6 月リリースの Sora にて廃止します。そのため multistreamEnabled の使用は非推奨です。\nこのプロパティは 2027 年中に廃止予定です。")
public var multistreamEnabled: Bool?
    Show on GitHub

  • 接続試行中のタイムアウト (秒) 。 指定した時間内に接続が成立しなければ接続試行を中止します。

    Declaration

    Swift

    public var connectionTimeout: Int
    Show on GitHub

  • 映像コーデック。デフォルトは .default です。

    Declaration

    Swift

    public var videoCodec: VideoCodec
    Show on GitHub

  • 映像ビットレート。デフォルトは無指定です。

    Declaration

    Swift

    public var videoBitRate: Int?
    Show on GitHub

  • カメラの設定

    Declaration

    Swift

    public var cameraSettings: CameraSettings
    Show on GitHub

  • 音声コーデック。デフォルトは .default です。

    Declaration

    Swift

    public var audioCodec: AudioCodec
    Show on GitHub

  • 音声ビットレート。デフォルトは無指定です。

    Declaration

    Swift

    public var audioBitRate: Int?
    Show on GitHub

  • 映像の可否。 true であれば映像を送受信します。 デフォルトは true です。

    Declaration

    Swift

    public var videoEnabled: Bool
    Show on GitHub

  • 音声の可否。 true であれば音声を送受信します。 デフォルトは true です。

    Declaration

    Swift

    public var audioEnabled: Bool
    Show on GitHub

  • 接続確立時に端末カメラキャプチャを自動起動するかどうか。

    cameraSettings.isEnabled が true の場合でも、このフラグが false であれば 接続時点ではカメラキャプチャを起動しません。 後から MediaChannel.setVideoHardMute(false) で必要に応じて開始できます。

    Declaration

    Swift

    public var initialCameraEnabled: Bool
    Show on GitHub

  • 接続確立時にマイクを有効にするかどうか。

    このフラグが false であれば接続時点ではマイク入力は無効となります。(ハードミュート相当) 後から MediaChannel.setAudioHardMute(false) で必要に応じてマイクを有効にできます。

    Declaration

    Swift

    public var initialMicrophoneEnabled: Bool
    Show on GitHub

  • サイマルキャストの可否。 true であればサイマルキャストを有効にします。

    Declaration

    Swift

    public var simulcastEnabled: Bool
    Show on GitHub

  • サイマルキャストでの映像の種類。 ロールが .sendrecv または .recvonly かつ simulcastEnabled が true のときのみ有効です。

    simulcastRequestRid と同時に設定された場合、Sora 2025.2.0 以降では simulcastRequestRid が優先されます。

    Declaration

    Swift

    @available(*, deprecated, message: "シグナリング接続時の simulcast_rid は 2027 年 12 月リリース予定の Sora にて\n廃止予定であるため、このプロパティは非推奨です。\n代わりに SimulcastRequestRid を使用してください。")
public var simulcastRid: SimulcastRid?
    Show on GitHub

  • サイマルキャストで視聴する映像の種類。 ロールが .sendrecv または .recvonly かつ simulcastEnabled が true のときのみ有効です。

    このプロパティは Sora 2025.2.0 以降で利用可能です。

    Declaration

    Swift

    public var simulcastRequestRid: SimulcastRequestRid
    Show on GitHub

  • スポットライトの可否 詳しくは Sora のスポットライト機能を参照してください。

    Declaration

    Swift

    public var spotlightEnabled: Spotlight
    Show on GitHub

  • スポットライトの対象人数

    Declaration

    Swift

    public var spotlightNumber: Int?
    Show on GitHub

  • スポットライト機能でフォーカスした場合の映像の種類

    Declaration

    Swift

    public var spotlightFocusRid: SpotlightRid
    Show on GitHub

  • スポットライト機能でフォーカスしていない場合の映像の種類

    Declaration

    Swift

    public var spotlightUnfocusRid: SpotlightRid
    Show on GitHub

  • WebRTC に関する設定

    Declaration

    Swift

    public var webRTCConfiguration: WebRTCConfiguration
    Show on GitHub

  • connect シグナリングに含めるメタデータ

    Declaration

    Swift

    public var signalingConnectMetadata: Encodable?
    Show on GitHub

  • connect シグナリングに含める通知用のメタデータ

    Declaration

    Swift

    public var signalingConnectNotifyMetadata: Encodable?
    Show on GitHub

  • シグナリングにおける DataChannel の利用可否。 true の場合、接続確立後のシグナリングを DataChannel 経由で行います。

    Declaration

    Swift

    public var dataChannelSignaling: Bool?
    Show on GitHub

  • メッセージング機能で利用する DataChannel の設定

    Declaration

    Swift

    public var dataChannels: Any?
    Show on GitHub

  • DataChannel 経由のシグナリングを利用している際に、 WebSocket が切断されても Sora との接続を継続するためのフラグ。 詳細: https://sora-doc.shiguredo.jp/DATA_CHANNEL_SIGNALING#07c227

    Declaration

    Swift

    public var ignoreDisconnectWebSocket: Bool?
    Show on GitHub

  • 音声ストリーミング機能で利用する言語コード

    Declaration

    Swift

    public var audioStreamingLanguageCode: String?
    Show on GitHub

  • プロキシに関する設定

    Declaration

    Swift

    public var proxy: Proxy?
    Show on GitHub

  • 転送フィルターの設定

    この項目は 2025 年 12 月リリース予定の Sora にて廃止されます

    Declaration

    Swift

    public var forwardingFilter: ForwardingFilter?
    Show on GitHub

  • リスト形式の転送フィルターの設定

    Declaration

    Swift

    public var forwardingFilters: [ForwardingFilter]?
    Show on GitHub

  • VP9 向け映像コーデックパラメーター

    Declaration

    Swift

    public var videoVp9Params: Encodable?
    Show on GitHub

  • AV1 向け映像コーデックパラメーター

    Declaration

    Swift

    public var videoAv1Params: Encodable?
    Show on GitHub

  • H264 向け映像コーデックパラメーター

    Declaration

    Swift

    public var videoH264Params: Encodable?
    Show on GitHub

イベントハンドラ

パブリッシャーに関する設定

  • パブリッシャーのストリームの ID です。 通常、指定する必要はありません。

    Declaration

    Swift

    public var publisherStreamId: String
    Show on GitHub

  • パブリッシャーの映像トラックの ID です。 通常、指定する必要はありません。

    Declaration

    Swift

    public var publisherVideoTrackId: String
    Show on GitHub

  • パブリッシャーの音声トラックの ID です。 通常、指定する必要はありません。

    Declaration

    Swift

    public var publisherAudioTrackId: String
    Show on GitHub

  • 初期化します。

    Declaration

    Swift

    public init(
  url: URL,
  channelId: String,
  role: Role,
  multistreamEnabled: Bool? = nil
)

    Parameters

    url

    サーバーの URL
    channelId

    チャネル ID
    role

    ロール
    multistreamEnabled

    マルチストリームの可否(デフォルトは指定なし)
    Show on GitHub

  • 初期化します。

    Declaration

    Swift

    public init(
  urlCandidates: [URL],
  channelId: String,
  role: Role,
  multistreamEnabled: Bool? = nil
)

    Parameters

    urlCandidates

    シグナリングに利用する URL の候補
    channelId

    チャネル ID
    role

    ロール
    multistreamEnabled

    マルチストリームの可否(デフォルトは指定なし)
    Show on GitHub