MediaStream

public protocol MediaStream : AnyObject

メディアストリームの機能を定義したプロトコルです。 デフォルトの実装は非公開 (internal) であり、カスタマイズはイベントハンドラでのみ可能です。 ソースコードは公開していますので、実装の詳細はそちらを参照してください。

メディアストリームは映像と音声の送受信を行います。 メディアストリーム 1 つにつき、 1 つの映像と 1 つの音声を送受信可能です。

イベントハンドラ

接続情報

映像と音声の可否

  • 映像の可否。 false をセットすると、サーバーへの映像の送受信を停止します。 true をセットすると送受信を再開します。

    Declaration

    Swift

    var videoEnabled: Bool { get set }
  • 音声の可否。 false をセットすると、サーバーへの音声の送受信を停止します。 true をセットすると送受信を再開します。

    サーバーへの送受信を停止しても、マイクはミュートされませんので注意してください。

    Declaration

    Swift

    var audioEnabled: Bool { get set }
  • 受信した音声のボリューム。 0 から 10 (含む) までの値をセットします。 このプロパティはロールがサブスクライバーの場合のみ有効です。

    Declaration

    Swift

    var remoteAudioVolume: Double? { get set }

映像フレームの送信

  • 映像フィルター

    Declaration

    Swift

    var videoFilter: VideoFilter? { get set }
  • 映像レンダラー。

    Declaration

    Swift

    var videoRenderer: VideoRenderer? { get set }
  • 映像フレームをサーバーに送信します。 送信される映像フレームは映像フィルターを通して加工されます。 映像レンダラーがセットされていれば、加工後の映像フレームが 映像レンダラーによって描画されます。

    Declaration

    Swift

    func send(videoFrame: VideoFrame?)

    Parameters

    videoFrame

    描画する映像フレーム。 nil を指定すると空の映像フレームを送信します。

終了処理