クライアントが参加しているVonage Video APIセッションを表します。 続きを読む...

IDisposable インターフェースを継承しています。

詳細な説明

クライアントが参加しているVonage Video APIセッションを表します。

Vonage Video API Windows SDK を使用する最初のステップは、 セッション ...を使用してオブジェクトを Session.Builder クラスである。

について セッション このクラスは System.IDisposable インターフェースを実装しています。必ず Dispose() のメソッドを使用する。 セッション オブジェクトが不要になったとき（たとえば、アプリやウィンドウが閉じられるときなど）、そのオブジェクトがリソースを解放するようにします。

こちらも参照 セッション作成 そして トークン作成.

メンバー関数のドキュメント

Connect()

で提供されるVonage Video APIセッションに接続します。 セッション コンストラクタを、指定された認証トークンを使用して呼び出します。

セッションが接続されると、 セッション オブジェクトは 接続済み イベントを開催する。

セッションの接続に失敗した場合、 セッション オブジェクトは エラー イベントを開催する。

パラメータ : | | | | --- | --- | | token | ユーザーのトークン。詳細については トークン作成の概要. |

DisableForceMute()

セッションのアクティブなミュート状態を解除します。このメソッドを呼び出すと、そのセッションに配信される新しいストリームの音声はミュートされなくなります。

を呼び出した後 ForceMuteAll メソッド（または別のクライアントのモデレーターがすべてのストリームをミュートする呼び出しを行った場合）、モデレーションの呼び出し後に配信されるストリームは、音声がミュートされた状態で配信されます。 DisableForceMute() セッションのミュート状態を解除する方法（これにより、新たに公開されるストリームが自動的にミュートされるのを防ぐ）。

このメソッドを呼び出すと、 セッション セッションに接続している各クライアント内のオブジェクトを使用して、 強制ミュート イベントで IsActive プロパティの MuteForcedEventArgs 設定対象のオブジェクト false.

チェック CanForceMute プロパティの Session.Capabilities このオブジェクトを使用して、この関数を正常に呼び出せるかどうかを確認してください。これは、モデレーターの役割が割り当てられたトークンで接続したクライアント専用です（ トークン作成の概要).

参照 セッション内のストリームの音声をミュートする.

関連項目 ： 能力, ForceMuteAll, 強制ミュート

Disconnect()

このセッションから切断します。すべて 購読者 そして 出版社 インスタンスは切断されます。

ベストプラクティスとして、このメソッドを呼び出す前に、 公開取り消し（発行者） すべてのパブリッシャーに対してこのメソッドを実行し、 Publisher.StreamDestroyed イベント。これにより、パブリッシャーの完全な削除が保証されます。特に、ネットワーク接続の問題により、再接続機能のせいで削除が行えない場合（再接続の可能性に備えてパブリッシャーのストリームが維持される可能性があるため）に有効です。

セッションが切断されると、 セッション を送信する。 切断 イベントを開催する。

ForceDisconnect()

クライアントを強制的にセッションから切断します。

ForceDisconnect メソッドを使用して自身の接続を切断することも可能ですが、Disconnect メソッドを呼び出す方が簡単です。ユーザーのロールに、他のユーザーを強制的に切断するための権限が含まれていない場合、エラーが返されます。ユーザーのロールは、ユーザートークンを作成する際に定義します。

このメソッドを使用して接続を終了すると、 切断, 接続が切断されました また、Publisher.StramDestroyed イベントは、Disconnect を使用して接続が自ら切断された場合と同様にディスパッチされます。

パラメータ : | | | | --- | --- | | connection | 切断する接続。 |

ForceMuteAll()

そのセッションに参加しているすべての配信者（除外されたストリームを配信している配信者を除く）に対して、音声をミュートするように強制します。

また、以下の呼び出しの後に発行されるストリームは、すべて ForceMuteAll() メソッドを呼び出すと、オーディオがミュートされた状態でパブリッシュされます。セッションのミュート状態を解除するには DisableForceMute() メソッド。この DisableForceMute() メソッドを呼び出すと、セッションに公開された新しいストリームは、音声がミュートされなくなります。

このメソッドを呼び出すと、 セッション セッションに接続している各クライアント内のオブジェクトを使用して、 強制ミュート イベントで IsActive プロパティの MuteForcedEventArgs 設定対象のオブジェクト true.

チェック CanForceMute プロパティの Session.Capabilities このオブジェクトを使用して、この関数を正常に呼び出せるかどうかを確認してください。これは、モデレーターの役割が割り当てられたトークンで接続したクライアント専用です（ トークン作成の概要).

参照 セッション内のストリームの音声をミュートする.

パラメータ : | | | | --- | --- | | excludedStreams | ミュート要求から除外するストリーム。セッション内のすべてのストリーム（ローカルクライアントによって公開されたストリームを含む）をミュートするには、このパラメータをnullに設定するか、設定しないようにしてください。 |

関連項目 ： 能力, ForceMuteStream, DisableForceMute(), Session.MuteForced, Publisher.MuteForced

ForceMuteStream()

指定されたストリームの配信者に、音声をミュートするよう強制します。

チェック CanForceMute プロパティの Session.Capabilities このオブジェクトを使用して、この関数を正常に呼び出せるかどうかを確認してください。これは、モデレーターの役割が割り当てられたトークンで接続したクライアント専用です（ トークン作成の概要).

参照 セッション内のストリームの音声をミュートする.

パラメータ : | | | | --- | --- | | stream | ミュートするストリーム。 |

関連項目 ： 能力, ForceMuteAll, Publisher.MuteForced

Publish()

を開始します 出版社 セッションへのストリーミング。

パラメータ : | | | | --- | --- | | 発行元 | The 出版社 そのセッションにストリーミングしたいもの。 |

SendSignal()

セッション内のすべてのクライアントに信号を送信します。

パラメータ : | | | | --- | --- | | type | 信号のタイプ。タイプは SignalEventArgs.Type の引数 シグナル イベントリスナー。 | | data | 送信するデータ。データのサイズ上限は8kBです。型は SignalEventArgs.Data の引数 シグナル イベントリスナー。 | | 接続 | | | 再接続後の再試行 | |

SetEncryptionSecret()

すべてのパブリッシャーおよびサブスクライバーが使用するエンドツーエンド暗号化の秘密鍵を設定します。

参照 エンド・ツー・エンドの暗号化 開発者ガイド

パラメータ : | | | | --- | --- | | secret | 暗号化シークレットの値。 |

Subscribe()

指定された加入者に対するオーディオ・ビデオストリームデータの受信およびレンダリングを開始します。

パラメータ : | | | | --- | --- | | subscriber | 受信対象のストリームにバインドされたサブスクライバー。 |

Unpublish()

の接続を解除します 出版社 そのセッションから。

パラメータ : | | | | --- | --- | | 発行元 | The 出版社 公開を取り消す。 |

購読解除()

セッション内の指定されたサブスクライバーへのサブスクリプション（ストリームの受信）を停止します。

パラメータ : | | | | --- | --- | | subscriber | 購読を停止したいサブスクライバー。 |

イベントの記録

接続が作成されました

別のクライアントがセッションに接続した際に送信されます。

について ConnectionEventArgs.Connection このオブジェクトは、クライアントとセッションとの接続を表します。なお、このメソッドは以下の場合に呼び出されます。 その他 クライアントがセッションに接続します。あなたの 自身の クライアントが接続すると、その セッション を送信する。 接続済み イベントを開催する。

接続が切断されました

別のクライアントがセッションを離脱した際に送信されます。

について ConnectionEventArgs.Connection このオブジェクトは、クライアントによるセッションへの前回の接続を表します。なお、このメソッドは以下の場合に呼び出されます。 その他 クライアントがセッションを離れます。あなたの 自身の クライアントが切断されると、その セッション オブジェクトは 接続済み イベントを開催する。

エラー

セッションへの接続中に問題が発生した場合、またはセッションに接続済みの状態で問題が発生した場合に送信されます。

このイベントは、セッションへの接続に失敗した場合に送信されます。また、接続に成功した後、エラーによりセッションとの接続が切断された場合にも送信されます。この場合、イベントは 切断 イベントが送信される。

再接続開始

ローカルクライアントがVonage Video APIセッションとの接続を失い、再接続を試みている際に送信されます。これは、ネットワーク接続が切断されたことが原因です。

クライアントがセッションに再接続できる場合、 セッション オブジェクトは 再接続に成功しました イベント。それ以外の場合、クライアントが再接続できない場合は、 セッション オブジェクトは 切断 イベントを開催する。

このメソッドが呼び出された際、アプリがセッションへの再接続を試みており、音声・映像ストリームが一時的に切断されていることをユーザーに知らせるため、ユーザーインターフェース上で通知を表示するとよいでしょう。

関連項目 ： 再接続に成功しました, 切断

再接続に成功しました

ローカルクライアントのネットワーク接続が一時的に切断された後、Vonage Video API セッションに再接続された際に呼び出されます。

接続が切断されると、 セッション オブジェクトは Session.ReconnectionStart イベント、送信する前に Session.ReconnectionSuccess イベント。クライアントがセッションに再接続できない場合、 セッション オブジェクトは Session.Disconnected イベントを開催する。

クライアントが再接続し、このメソッドが呼び出されると、既存のパブリッシャーおよびサブスクライバーは自動的に再接続されます。

デフォルトでは、ローカルクライアントが SendSignal(string, string, Connection, bool) クライアントが再接続した際に、このメソッドが呼び出されます。接続が切断されていた間に発生したシグナルが送信されないようにするには、 retryAfterReconnect パラメーターの SendSignal メソッドを使用します。 false. （クライアントが切断されていた間に他のクライアントから送信されたすべての信号は、再接続時に受信されます。）

関連項目 ： 再接続開始

StreamDropped

送信日時 もう一つ クライアントが、このVonage Video APIセッションへのストリームの配信を停止します。

について StreamEventArgs.Stream このオブジェクトは、コールバックが呼び出された時点でのストリームのスナップショットを表します。これを使用して、対応する 購読者 （もしあるなら）。

StreamReceived

以下のユーザーによって新しいストリームが公開された際に送信されます もう一つ このVonage Video APIセッションのクライアント。

について StreamEventArgs.Stream このオブジェクトは、コールバックが実行された時点でのストリームのスナップショットを表します。次のオブジェクトを作成します。 購読者 そして、 購読（購読者） ストリームを購読する方法。