Vonage Video API セッション内でオーディオ・ビデオストリームを再生するために使用されます。 続きを読む...
IDisposable インターフェースを継承しています。
| 授業 | |
| クラス | AudioDataEventArgs |
| のパラメータを定義します OpenTok.AudioData イベント。 続きを読む... | |
| クラス | AudioLevelArgs |
| の引数を定義します AudioLevel イベント。 続きを読む... | |
| クラス | AudioNetworkStatsEventArgs |
| の引数を定義します AudioStatsが更新されました イベント。 続きを読む... | |
| クラス | ビルダー |
| ~を作成するために使用されます 購読者 例。 続きを読む... | |
| クラス | CaptionTextArgs |
| の引数を定義します キャプションテキスト イベント。 続きを読む... | |
| クラス | ErrorEventArgs |
| の引数を定義します。 エラー イベント。 続きを読む... | |
| クラス | NetworkConditionChangedEventArgs |
| の引数を定義します ネットワーク状態の変更 加入者によって発生したイベント。 続きを読む... | |
| クラス | RtcStatsReportArgs |
| の引数を定義します RtcStatsReport イベント。 続きを読む... | |
| クラス | 送信者統計 |
| 送信側ネットワーク統計。 続きを読む... | |
| クラス | 購読者・メディア・リンク・統計 |
| ローカルおよびリモートのトランスポート指標やネットワークの品質低下に関する情報を含む、加入者のメディアリンク統計情報を提供します。 続きを読む... | |
| クラス | SubscriberMediaLinkStatsEventArgs |
| の引数を定義します MediaLinkStatsの更新 イベント。 続きを読む... | |
| クラス | VideoEventArgs |
| の引数を定義します。 動画対応 そして 動画が無効になっています イベント。 続きを読む... | |
| クラス | VideoNetworkStatsEventArgs |
| の引数を定義します VideoStatsが更新されました イベント。 続きを読む... | |
| クラス | VideoQualityChangedEventArgs |
| の引数を定義します VideoQualityChanged 加入者によって発生したイベント。 続きを読む... |
| パブリック型 | |
| enum | VideoReason : int { 動画を公開する = 1 , 動画の購読者 = 2 , 品質 = 3 , CodecNotSupported = 4 , CodecChange = 8 , 解像度の変更 = 9 , 動画の中断 = 10 } |
| の値を定義します。 VideoEventArgs.Reason そして VideoEventArgs.Reason プロパティ。 続きを読む... |
| パブリックメンバー関数 | |
| void | 廃棄する () |
| 以下の事項を処理する 購読者 オブジェクトのリソース。 | |
| void | GetRtcStatsReport () |
| サブスクライバーの RTC 統計レポートを取得します。これは非同期操作です。統計情報が利用可能になると、 RtcStatsReport メッセージが送信されます。 続きを読む... |
| 保護されたメンバ関数 | |
| 購読者 (ビルダー (ビルダー) | |
| 仮想 void | 廃棄する (bool disposing) |
| プロパティ | |
| ストリーム | ストリーム [get] |
| この購読者のストリームです。のプロパティは、 ストリーム object は、このプロパティにアクセスした時点でのストリームの状態のスナップショットであり、ストリームの状態が変化しても更新されることはありません。 | |
| bool | 字幕を購読する [get, set] |
……かどうか 購読者 字幕を購読しています(true)または(false). デフォルト値は、ストリームのパブリッシャーのキャプション値です。Publisher.PublishCaptions |
|
| ストリング | キャプション・翻訳・言語 [get, set] |
| この購読者にとって、キャプションの翻訳に最適な言語です。 続きを読む... | |
| bool | オーディオを購読する [get, set] |
……かどうか 購読者 オーディオを購読しています(true)または(false). |
|
| bool | 動画の購読 [get, set] |
……かどうか 購読者 動画の購読をしています(true)または(false). |
|
| IVideoRenderer | VideoRenderer [get] |
| このチャンネル登録者が使用している動画レンダラー。 続きを読む... | |
| ストリング | ID [get] |
| の固有識別子 購読者. | |
| サイズ | 推奨解決策 [get, set] |
| 加入者のストリームに推奨される解像度。 続きを読む... | |
| ダブル | AudioVolume [get, set] |
| 加入者の音声音量。 続きを読む... | |
| float | 推奨フレームレート [get, set] |
| チャンネル登録者のストリームにおける推奨フレームレート。 続きを読む... |
| イベント | |
| EventHandler | 接続済み |
| インスタンスがストリームへの接続に成功し、メディアの再生を開始したときに呼び出されます。 | |
| EventHandler | ストリームが切断されました |
| 加入者のストリームが中断されたときに呼び出されます。 続きを読む... | |
| EventHandler | ストリームが再接続されました |
| 加入者のストリームが再開されたとき(一時的に切断された後)に送信されます。 続きを読む... | |
| EventHandler< CaptionTextArgs > | キャプションテキスト |
| 加入者のストリームがキャプションテキストを受信したときに送信されます。 | |
| EventHandler< VideoEventArgs > | 動画が無効になっています |
| 加入者が動画の受信を停止したときに呼び出されます。 続きを読む... | |
| EventHandler< VideoEventArgs > | 動画対応 |
| 加入者のビデオストリームが開始されたとき(それまでビデオがなかった場合)、または再開されたとき(ビデオが無効化されていた後)に呼び出されます。 続きを読む... | |
| EventHandler< ErrorEventArgs > | エラー |
| サブスクライバーがVonage Video APIサーバーへの接続に失敗した際に呼び出されます。 | |
| EventHandler | VideoDisableWarning |
| Vonage Video API メディアルーターが、ストリームの品質が低下したと判断し、さらに品質が低下した場合に動画が停止されることになる場合に呼び出されます。 続きを読む... | |
| EventHandler | VideoDisableWarningLifted |
| Vonage Video API メディアルーターが、ストリームの品質が改善し、無効化される動画が直ちにリスクをもたらさない状態になったと判断した際に呼び出されます。 続きを読む... | |
| EventHandler< VideoQualityChangedEventArgs > | VideoQualityChanged |
| 加入者側で品質に関連する事象が検出された場合に発生します。 続きを読む... | |
| EventHandler< NetworkConditionChangedEventArgs > | ネットワーク状態の変更 |
| 加入者側でネットワーク状況の変化が検出された場合に発生します。 続きを読む... | |
| EventHandler< SubscriberMediaLinkStatsEventArgs > | MediaLinkStatsの更新 |
| 加入者のメディアリンク統計を報告するために、定期的に実行されます。 | |
| EventHandler< AudioLevelArgs > | AudioLevel |
| 加入者の音声レベルを報告するために定期的に送信されます。 | |
| EventHandler< AudioDataEventArgs > | オーディオデータ |
| 加入者のPCMオーディオデータを報告するために、定期的に呼び出されます。 | |
| EventHandler< AudioNetworkStatsEventArgs > | AudioStatsが更新されました |
| サブスクライバーが共有できるオーディオ統計情報がある場合に呼び出されます。 | |
| EventHandler< VideoNetworkStatsEventArgs > | VideoStatsが更新されました |
| サブスクライバーが共有できる動画統計情報がある場合に呼び出されます。 | |
| EventHandler< RtcStatsReportArgs > | RtcStatsReport |
| 「~への呼びかけ」への回答として送信されました GetRtcStatsReport(). |
詳細な説明
Vonage Video API セッション内でオーディオ・ビデオストリームを再生するために使用されます。
を使用する。 Subscriber.Builder クラスを作成して、 購読者 インスタンス。このメソッドを呼び出すと、サブスクライバーはメディアを受信するために接続できます。 Session.Subscribe(Subscriber) メソッドを使用する。
について 購読者 このクラスは System.IDisposable インターフェースを実装しています。必ず Dispose() のメソッドを使用する。 購読者 そのオブジェクトが不要になったとき(たとえば、 購読者 (動画のストリーミングが停止したとき、またはアプリやウィンドウが閉じられるときなど)。
メンバー列挙に関するドキュメント
VideoReason
| enum OpenTok.Subscriber.VideoReason : int |
の値を定義します。 VideoEventArgs.Reason そして VideoEventArgs.Reason の特性を持つ。
| 調査員 | |
|---|---|
| 動画を公開する | この事象は、ストリームの配信者が動画の配信を開始または停止したために発生しました。 |
| 動画の購読者 | この事象は、ローカルクライアントが動画の購読を開始または停止したために発生しました。 |
| 品質 | この現象は、動画ストリームの画質変更が原因で発生しました。 ストリーム 品質は、サブスクライバー側またはパブリッシャー側のネットワーク状況やCPU使用率によって変動する可能性があります。有効にすると、オーディオフォールバック機能により、動画品質の低下によりサブスクライバーが動画ストリームの受信を中断した際にイベントが発生し、その結果、サブスクライバーは 動画が無効になっています イベント。状況が改善すると、動画ストリームが再開され、その 購読者 を送信する。 動画対応 イベント。ビデオストリームが切断された場合でも、オーディオストリームが存在すれば、サブスクライバーは引き続きそのオーディオストリームを受信し続けます。ルーティングされたセッションでは、この動作の原因は、Vonage Video API メディアルーター(購読者 (オーディオのフォールバック)またはパブリッシングクライアント(出版社 オーディオのフォールバック)。パブリッシングクライアントがソースである場合、サブスクライバーアプリケーションは対応する Session.StreamHasVideoChanged、これは、購読中の動画チャンネルがもはやアクティブではないことを示しています。一般的に、この挙動はパブリッシャー側のネットワーク品質の低下を示唆していますが、サブスクライバーから報告されるメトリクスがパブリッシャーのフォールバック判断に影響を与える可能性があり、その結果、品質低下の正確な原因を特定することが困難になる場合があります。 中継セッションでは、「quality」イベントは、パブリッシャーの内部オーディオフォールバックロジック(Publisher Audio Fallback)によってのみトリガーされます。ネットワーク状態が良好な他の加入者にはストリームが引き続き受信されている可能性があるため、このイベントの後に、動画が非アクティブであることを示す追加のイベントは発生しません。 なお、中継セッションではフォールバックはパブリッシャー側から発生しますが、根本的なネットワーク品質の低下はパブリッシャー側またはサブスクライバー側のいずれかで発生している可能性があることに注意してください。 |
| CodecNotSupported | この動画関連の事象は、サブスクライバーのストリームで使用されている動画コーデック(H.264など)がデバイスでサポートされていないため、ストリーム内の動画が無効化されたことで発生しました。 |
| CodecChange | ストリームのビデオコーデックが変更されました。 |
| 解像度の変更 | 動画の解像度やレイヤー数の変更。これは、ビットレートの制約、エンコーダの適応、カメラソースの変更(カメラの切り替えや入力解像度の変更など)、あるいは設定の変更によって発生することがあります。必ずしも画質の低下を意味するわけではありません。 |
| 動画の中断 | 動画ストリームが中断されました。これは、加入者への動画配信が一定期間(通常は5秒以上)停止したことを示しています。動画の中断が発生した場合、Applicationsは VideoStatsが更新されました 低ビットレートや高遅延などの要因を特定するため。 |
メンバー関数のドキュメント
GetRtcStatsReport()
| void OpenTok.Subscriber.GetRtcStatsReport | ( | ) |
サブスクライバーの RTC 統計レポートを取得します。これは非同期操作です。統計情報が利用可能になると、 RtcStatsReport メッセージが送信される。
こちらも参照 AudioStatsが更新されました, VideoStatsが更新されましたそして Publisher.GetRtcStatsReport().
物件に関する資料
AudioVolume
| --- | double OpenTok.Subscriber.AudioVolume |
加入者の音声音量。
加入者の音声音量(0~100)。値を設定する際、この範囲外の場合は、この範囲内にクリップされます。
デフォルト値は 100 です。
キャプション・翻訳・言語
| --- | 文字列 OpenTok.Subscriber.CaptionsTranslationLanguage |
この購読者にとって、キャプションの翻訳に最適な言語です。
これはベータ機能です.
この設定は、字幕が有効になっている場合にのみ有効になります。翻訳された字幕を表示するには、サポートされている BCP-47 言語コードを設定するか、 null 翻訳を無効にするには。デフォルト値は null (翻訳設定がありません)。
サポートされている言語コードは、サーバーAPI仕様書に定義されています。
推奨フレームレート
| --- | float OpenTok.Subscriber.PreferredFramerate |
チャンネル登録者のストリームにおける推奨フレームレート。
フレームレートと動画の解像度を制限する(推奨解決策) これにより、サブスクライバー側のクライアントにおけるネットワーク使用量とCPU使用量が削減されます。アプリ内のサブスクライバーの動画のサイズに応じて、より低い解像度を設定することを検討してください。また、他のストリームに比べて重要度が低く(かつ規模が小さい)ストリームのサブスクライバーに対しては、より低いフレームレートや解像度を設定することを検討してください。
このプロパティは、 スケーラブルビデオ機能. スケーラブルビデオが利用可能です:
- Vonage Video API メディアルーターを使用するセッション( メディアモード に設定されている)。
- スケーラブルビデオをサポートするクライアントによって配信されるストリームのみ対象です(詳細については、 スケーラブルビデオ機能).
スケーラブルビデオを使用していないストリームでは、このプロパティを設定しても効果はありません。
注: スケーラブルなビデオストリームのフレームレートは、このプロパティを設定していなくても、ネットワークの状態やCPU使用率に基づいて、各加入者ごとに自動的に調整されます。この加入者の最大フレームレートを設定したい場合は、このプロパティを設定してください。
利用可能なフレームレートは、ストリームで利用可能な最大フレームレートの値に基づいています。サブスクライバーの希望フレームレートを設定すると、Vonage Video API Windows SDK は、クライアントの帯域幅および CPU の制約に基づき、希望フレームレートに最も近い利用可能な最適なフレームレートを選択します。
実際に利用可能なフレームレートは、パブリッシャーが利用できるネットワークおよびCPUリソースに応じて動的に変化します。
推奨解決策
| --- | Size OpenTok.Subscriber.PreferredResolution |
加入者のストリームに推奨される解像度。
加入者のストリームに推奨される解像度。
動画の解像度とフレームレートを制限する(推奨フレームレート) これにより、サブスクライバー側のクライアントにおけるネットワーク使用量とCPU使用量が削減されます。アプリ内のサブスクライバーの動画のサイズに応じて、より低い解像度を設定することを検討してください。また、他のストリームに比べて重要度が低く(かつ規模が小さい)ストリームのサブスクライバーに対しては、より低いフレームレートや解像度を設定することを検討してください。
このプロパティは、 スケーラブルビデオ機能. スケーラブルビデオが利用可能です:
- Vonage Video API メディアルーターを使用するセッション( メディアモード に設定されている)。
- スケーラブルビデオをサポートするクライアントによって配信されるストリームのみ対象です(詳細については、 スケーラブルビデオ機能).
スケーラブルビデオを使用していないストリームでは、このプロパティを設定しても効果はありません。
注: スケーラブルビデオストリームの解像度は、このプロパティを設定していなくても、ネットワークの状態やCPU使用率に基づいて、各加入者ごとに自動的に調整されます。この加入者の最大解像度を設定したい場合は、このプロパティを設定してください。
すべての解像度が加入者に利用可能というわけではありません。希望する解像度を設定すると、Vonage Video API Windows SDK は、設定された制約条件に合致する利用可能な最適な解像度を選択します。利用可能な解像度は、最大幅および最大高さに依存します。 出版社 ストリーム用のセットで、これらは Stream.Width そして Stream.Height の特性である。 ストリーム オブジェクト。ストリームで利用可能な各解像度は、すべて同じアスペクト比を使用します。
VideoRenderer
| --- | IVideoRenderer OpenTok.Subscriber.VideoRenderer |
このチャンネル登録者が使用している動画レンダラー。
ビデオレンダラーを設定するには、 VideoRenderer Subscriber(Context, Stream, IVideoRenderer) コンストラクタを呼び出す際。
イベントの記録
ネットワーク状態の変更
| EventHandler<NetworkConditionChangedEventArgs> OpenTok.Subscriber.NetworkConditionChanged |
加入者側でネットワーク状況の変化が検出された場合に発生します。
このイベントは、ネットワークの状態に著しい変化が生じた際にトリガーされ、メディアリンクの統計情報と変化の理由を提供します。
ストリームが切断されました
| EventHandler OpenTok.Subscriber.StreamDisconnected |
加入者のストリームが中断されたときに呼び出されます。
このメソッドが呼び出された際、オーディオ・ビデオストリームが一時的に切断され、アプリがストリームへの再接続を試みていることをユーザーに知らせるため、ユーザーインターフェース上で通知を表示するとよいでしょう。
クライアントがストリームに再接続した場合、サブスクライバーは ストリームが再接続されました イベント。そうでない場合は、 セッション オブジェクトは Session.StreamDropped イベントを開催する。
ストリームが再接続されました
| EventHandler OpenTok.Subscriber.StreamReconnected |
加入者のストリームが再開されたとき(一時的に切断された後)に送信されます。
について 購読者 は、 ストリームが切断されました イベントを開催する。
動画が無効になっています
| EventHandler<VideoEventArgs> OpenTok.Subscriber.VideoDisabled |
加入者が動画の受信を停止したときに呼び出されます。
チェック reason 動画が停止した理由に関するイベント引数のプロパティ。
VideoDisableWarning
| EventHandler OpenTok.Subscriber.VideoDisableWarning |
Vonage Video API メディアルーターが、ストリームの品質が低下したと判断し、さらに品質が低下した場合に動画が停止されることになる場合に呼び出されます。
画質がさらに低下した場合、加入者は動画を停止し、 購読者 VideoDisabled メッセージを送信します。ストリームの画質が向上した場合、 購読者 VideoDisableWarningLifted イベントを送信します。
この機能は、Vonage Video API メディアルーターを使用するセッション(メディアモードが「ルーティング」に設定されているセッション)でのみ利用可能であり、メディアモードが「中継」に設定されているセッションでは利用できません。(参照: OpenTok メディアルーターとメディアモード).
このメソッドは、主に接続品質が低下した際に呼び出されます。
VideoDisableWarningLifted
| EventHandler OpenTok.Subscriber.VideoDisableWarningLifted |
Vonage Video API メディアルーターが、ストリームの品質が改善し、無効化される動画が直ちにリスクをもたらさない状態になったと判断した際に呼び出されます。
この機能は、Vonage Video API メディアルーターを使用するセッション(メディアモードが「ルーティング」に設定されているセッション)でのみ利用可能であり、メディアモードが「中継」に設定されているセッションでは利用できません。(参照: OpenTok メディアルーターとメディアモード).
このメソッドは、主に接続品質が改善されたときに呼び出されます。
動画対応
| EventHandler<VideoEventArgs> OpenTok.Subscriber.VideoEnabled |
加入者のビデオストリームが開始されたとき(それまでビデオがなかった場合)、または再開されたとき(ビデオが無効化されていた後)に呼び出されます。
チェック reason 動画が有効化された理由に関するイベント引数のプロパティ。
VideoQualityChanged
| EventHandler<VideoQualityChangedEventArgs> OpenTok.Subscriber.VideoQualityChanged |
加入者側で品質に関連する事象が検出された場合に発生します。
このイベントは、サブスクライバーのビデオストリームで、ビデオの中断(一時停止)の検出やコーデックの変更など、品質に著しい変化が生じた際にトリガーされます。
現在の実装では、このイベントは動画の中断やコーデックの変更が発生した場合にのみトリガーされます。 フリーズは内部で追跡され、統計情報にも反映されますが、その持続時間が短く頻度が高いため、個別にこのイベントをトリガーすることはありません。コールバックが発生するのは、一時停止(5秒以上レンダリングフレームがない状態)が検出された場合のみです。これは、より重大な再生の途絶を表すためです。
について VideoReason この値はイベントの原因を指定するもので、以下の優先順位に従います: VideoInterruption, CodecChange.
このイベントは、 動画が無効になっています そして 動画対応 単純なトラックのオン/オフの切り替えではなく、品質に関連する変更を報告するという点で。その 動画が無効になっています そして 動画対応 イベントは、サブスクライバーのビデオトラックがオフまたはオンになったタイミング(たとえば、オーディオのフォールバックやストリームプロパティの更新など)を示します。これに対し、このイベントは、フリーズ、一時停止回数、更新されたビデオ統計情報など、画質低下の原因に関する診断情報を提供します。
このイベントでは、5秒以上続く動画の中断をすべて対象とします。オーディオへのフォールバックや動画が無効化された場合などにおいても、その中断は統計上「一時停止」として記録され、対応する品質変化イベントが発生する場合があります。
Applications can use this event to respond to quality issues, such as updating UI indicators, logging telemetry, or notifying users.