OpenTok Android SDK リファレンス
OpenTok Android SDK には、以下のクラスが含まれています：
| クラス | 説明 |
|---|---|
| オーディオデータ | |
| AudioDeviceManager | アプリに対して定義できるオーディオキャプチャソースとレンダリングターゲットは、それぞれ1つだけです。パブリッシャーやサブスクライバーごとに個別に設定することはできません。ただし、PublisherKit.Builder.audioBitrate(int) メソッドを使用すれば、パブリッシュされたストリームのオーディオビットレートを設定することは可能です。 |
| BaseAudioDevice | セッションに接続する前に、このメソッドを呼び出してください。 |
| BaseAudioDevice.AudioBus | |
| BaseAudioDevice.AudioFocusManager | 外部オーディオのフォーカス管理に関して、Vonage SDK はオーディオ出力のルーティングを自動的に処理しません。ConnectionServices を使用する場合は、Telecom フレームワークに組み込まれているオーディオルーティング機能を活用する必要があります。このプラットフォームは、利用可能なオーディオルートの統一されたリストをアプリに提供します。 |
| BaseAudioDevice.AudioSettings | 現在、利用可能なサンプル形式は、符号付き16ビット整数PCMのみです。 |
| BaseAudioDevice.BluetoothState | |
| BaseAudioDevice.OutputMode | |
| BaseVideoCapturer | |
| BaseVideoCapturer.CaptureSettings | |
| BaseVideoCapturer.キャプチャスイッチ | カスタムビデオキャプチャを使用する場合は、`BaseVideoCapturer` を継承するオブジェクトで `CaptureSwitch` インターフェースを実装してください。その後、`cycleCamera()` メソッドを実装して、そのビデオキャプチャを使用する `Publisher` オブジェクトの `Publisher.cycleCamera()` メソッドの動作を定義します。 |
| BaseVideoCapturer.VideoContentHint | これらのオプションの詳細については、W3Cのワーキングドラフトをご覧ください。 |
| BaseVideoRenderer | このクラスを継承し、このメソッドをオーバーライドすることで、他のスタイルや動作に対応させることができます。 |
| BaseVideoRenderer.Frame | |
| Ca証明書 | |
| 接続 | セッションを初期化するには、Session() コンストラクタを呼び出します。これにより、Session オブジェクトが返されます。次に、Session オブジェクトの connect() メソッドを呼び出して、セッションに接続します。セッションへの接続が確立されると、Session.SessionListener.onConnected(Session session) メソッドが呼び出されます。 |
| MediaUtils | |
| MediaUtils.SupportedCodecs | |
| MediaUtils.VideoCodecType | |
| MuteForcedInfo | |
| ネットワーク性能低下の原因 | |
| NetworkDegradationSource.Source | |
| OpentokError | エラーの詳細については、getErrorCode() および getMessage() が返す値を確認してください。 |
| OpentokError.Domain | |
| OpentokError.ErrorCode | |
| PermissionsUtils | |
| 出版社 | パブリッシャーのビューがアクティブなウィンドウから外れると、そのパブリッシャーオブジェクトは破棄されます。これは、アクティビティが停止または一時停止された場合にも当てはまります。 |
| パブリッシャー.ビルダー | Session.publish(PublisherKit publisher) メソッドを使用して、パブリッシャーからセッションへのストリーミングを開始します。 |
| Publisher.CameraCaptureFrameRate | OpenTok Media Router を使用するセッション（メディアモードが「routed」に設定されているセッション）では、フレームレートを下げると、ストリームが使用する帯域幅も比例して減少することに注意してください。ただし、メディアモードが「relayed」に設定されているセッションでは、フレームレートを下げてもストリームの帯域幅は減少しません。 |
| Publisher.CameraCaptureResolution | |
| Publisher.CameraListener | |
| PublisherKit | 独自の動画キャプチャおよびレンダリングの実装を提供したい場合は、PublisherKitのサブクラスを作成してください。そうでない場合は、あらかじめ組み込まれた動画キャプチャ機能とレンダリング機能を含むPublisherクラスを使用してください。 |
| PublisherKit.AudioLevelListener | |
| PublisherKit.AudioStatsListener | |
| PublisherKit.AudioTransformer | 重要：Android 向け Vonage Video Client SDK のバージョン 2.27.2 以降では、Vonage Video Android SDK とは別に Vonage Media Library を追加する必要があります。詳細については、「Vonage Media Library の統合」を参照してください。詳細については、Transformers パッケージの README.md ファイルを確認してください。 |
| PublisherKit.Builder | Session.publish(PublisherKit publisher) メソッドを使用して、パブリッシャーからセッションへのストリーミングを開始します。 |
| PublisherKit.CustomAudioTransformer | |
| PublisherKit.CustomVideoTransformer | |
| PublisherKit.劣化設定 | |
| PublisherKit.MediaLinkStatsListener | パブリッシャーのメディアリンク統計を報告するために定期的に呼び出されます。トランスポートレベルのメトリクスを提供します。 |
| PublisherKit.MuteListener | |
| PublisherKit.推奨ビデオコーデック | |
| PublisherKit.PreferredVideoCodecs.Codec | |
| PublisherKit.PublisherAudioStats | |
| PublisherKit.PublisherKitVideoType | |
| PublisherKit.PublisherListener | |
| PublisherKit.PublisherMediaLinkStats | ビデオとオーディオは同じ基盤となるトランスポートを共有しているため、このクラスではローカルトランスポートの統計情報を単一のオブジェクトに統合しています。 |
| PublisherKit.PublisherRtcStats | 以下にその一部を例として示します： |
| PublisherKit.PublisherRtcStatsReportListener | |
| PublisherKit.PublisherVideoStats | |
| PublisherKit.VideoBitratePreset | これらのプリセットは、パブリッシャーのストリームにおける動画のビットレートを制御するために、あらかじめ定義された戦略を適用します。プリセットの設定と手動でのビットレート設定は、互いに排他的です。 |
| PublisherKit.VideoLayerStats | 同時配信構成では、各エントリは1つの独立したビデオエンコーディングに対応します（たとえば、低解像度、中解像度、高解像度のストリームが並行して送信される場合など）。SVC（Scalable Video Coding）の場合、パブリッシャーは通常、スケーラビリティ（時間的、空間的、あるいはその両方）を備えた単一のビデオエンコーディングを送信します。 |
| PublisherKit.VideoListener | このメソッドは、主に接続品質が低下した際に呼び出されます。 |
| PublisherKit.VideoStatsListener | PublisherKit.PublisherVideoStats オブジェクトには、パブリッシャーが受信したビデオバイト数、失われたビデオパケット数、および受信したビデオパケット数に関するプロパティが含まれています。 |
| PublisherKit.VideoTransformer | 重要：Android 向け Vonage Video Client SDK のバージョン 2.27.2 以降では、Vonage Video Android SDK とは別に Vonage Media Library を追加する必要があります。詳細については、「Vonage Media Library の統合」を参照してください。詳細については、Transformers パッケージの README.md ファイルを確認してください。 |
| セッション | Sessionインスタンスを作成する際は、OpenTokのセッションID、トークン、およびAPIキーを渡します。APIキーは、OpenTok Accountに登録すると取得できます。テスト目的では、Vonage Video API Accountにログインして、テスト用のセッションIDとトークンを生成することができます。OpenTokのサーバーサイドライブラリを使用してください。 |
| Session.ArchiveListener | |
| Session.Builder | デフォルト値は false です。 |
| Session.Builder.IceServer | |
| Session.Builder.IncludeServers | |
| Session.Builder.TransportPolicy | |
| Session.Capabilities | たとえば、Subscriber ロールが割り当てられたトークンを使用してセッションに接続する場合、このオブジェクトの canPublish プロパティは false に設定されます（この場合、クライアントにはセッションへの公開権限がありません）。詳細については、OpenTok のトークンに関するドキュメントを参照してください。 |
| Session.ConfigurableSessionOptions | |
| Session.ConnectionListener | |
| Session.MuteListener | |
| Session.ReconnectionListener | このメソッドが呼び出された際、アプリがセッションへの再接続を試みており、音声・映像ストリームが一時的に切断されていることをユーザーに知らせるため、ユーザーインターフェース上で通知を表示するとよいでしょう。 |
| セッション・リスナー | このメソッドは、セッションへの接続に失敗した場合に呼び出されます。また、接続に成功した後、エラーによってセッションとの接続が切断された場合にも呼び出されます。この場合、このメソッドは onDisconnected(Session session) メソッドが呼び出される直前に呼び出されます。 |
| Session.SessionOptions | |
| Session.SessionOptionsProvider | |
| Session.SignalListener | |
| Session.StreamCaptionsPropertiesListener | |
| Session.StreamPropertiesListener | |
| ストリーム | Session.SessionListener.onStreamDropped(Session session, Stream stream) メソッドは、ストリームがセッションから公開解除された際に通知を行います。 |
| Stream.StreamVideoType | |
| 購読者 | |
| Subscriber.Builder | Session.subscribe(SubscriberKit subscriber) メソッドを使用して、サブスクライバーへの動画ストリーミングを開始します。 |
| SubscriberKit | stream プロパティは、サブスクライブしたストリームを参照します。SubscriberKit クラスには、サブスクライブしたストリームのローカルでの音声および動画の再生を無効化または有効化できるメソッドが含まれています。 |
| SubscriberKit.AudioLevelListener | |
| SubscriberKit.AudioStatsListener | |
| SubscriberKit.Builder | Session.subscribe(SubscriberKit subscriber) メソッドを使用して、サブスクライバーへの動画ストリーミングを開始します。 |
| SubscriberKit.CaptionsListener | |
| SubscriberKit.MediaLinkStatsListener | 加入者のメディアリンク統計情報を報告するために定期的に呼び出されます。ローカルの加入者とリモートのパブリッシャーの両方について、トランスポートレベルのメトリクスを提供します。 |
| SubscriberKit.SenderStats | |
| SubscriberKit.StreamListener | このメソッドが呼び出された際、オーディオ・ビデオストリームが一時的に切断され、アプリがストリームへの再接続を試みていることをユーザーに知らせるため、ユーザーインターフェース上で通知を表示するとよいでしょう。 |
| SubscriberKit.SubscriberAudioStats | |
| SubscriberKit.SubscriberListener | |
| SubscriberKit.SubscriberMediaLinkStats | |
| SubscriberKit.SubscriberRtcStatsReportListener | 以下にその一部を例として示します： |
| SubscriberKit.SubscriberVideoStats | |
| SubscriberKit.VideoListener | この機能は、OpenTok Media Router を使用するセッション（メディアモードが「routed」に設定されているセッション）でのみ利用可能であり、「relayed」に設定されているセッションでは利用できません。（「OpenTok Media Router とメディアモード」を参照してください。） |
| SubscriberKit.VideoStatsListener | サブスクライバーの品質関連の動画イベントを監視するリスナー。 |
| TransportStats | |
| TransportStats.NetworkCondition | |
| VideoUtils | |
| VideoUtils.Size |