java.lang.Object

com.opentok.android.SubscriberKit

実装済みのすべてのインターフェース： : Observer

直接の既知のサブクラス： : Subscriber

public class SubscriberKit extends 目的 実装 オブザーバー

SubscriberKit（subscriber）オブジェクトは、Streamにバインドされたメディアデータをレンダリングします。 SubscriberKitクラスを使用すると、ビデオストリームに対してカスタムビデオレンダラーを設定できます。 独自の ビデオ処理およびレンダリングの実装を提供したい場合は、SubscriberKitのサブクラスを作成してください。それ以外の場合は、 Subscriber クラス。 これには、あらかじめ組み込まれたビデオプロセッサとレンダラーが含まれています。

stream プロパティは、サブスクライブしたストリームを参照します。 SubscriberKit クラスには、サブスクライブしたストリームの ローカルでの音声および動画の再生を無効化または有効化できるメソッドが含まれています。

ネストされたクラスの概要

ネストされたクラス

修飾子と型

クラス

説明

static interface

SubscriberKit.AudioLevelListener

加入者の音声レベルの変化を監視します。

static interface

SubscriberKit.AudioStatsListener

サブスクライバーのオーディオ統計情報を取得するためのリスナーオブジェクトを定義します。

static class

SubscriberKit.Builder

～を構築するために使用される SubscriberKit オブジェクトがある。

static interface

SubscriberKit.CaptionsListener

更新されたキャプションテキストを監視するリスナー。

static interface

SubscriberKit.MediaLinkStatsListener

サブスクライバーのメディアリンク統計情報（トランスポートレベルのメトリクスやネットワーク状態の変化を含む）を取得するためのリスナーオブジェクトを定義します。

static class

SubscriberKit.SenderStats

送信側から報告された、ビットレートの推定値などの動画統計情報を表します。

static interface

SubscriberKit.StreamListener

加入者のストリームが中断されたときや再開されたときを監視します。

static class

SubscriberKit.SubscriberAudioStats

加入者の音声統計情報を定義します。

static interface

SubscriberKit.SubscriberListener

あるの状態で変化を監視する SubscriberKit インスタンスだ。

static class

SubscriberKit.SubscriberMediaLinkStats

ローカルおよびリモートの トランスポート指標やネットワークの品質低下に関する情報を含む、加入者のメディアリンク統計情報を提供します。

static interface

SubscriberKit.SubscriberRtcStatsReportListener

サブスクライバーのRTC統計レポートを取得するためのリスナーオブジェクトを定義します。

static class

SubscriberKit.SubscriberVideoStats

サブスクライバーの動画統計情報を定義します。

static interface

SubscriberKit.VideoListener

加入者がビデオデータの受信を開始および停止したタイミングを監視します。

static interface

SubscriberKit.VideoStatsListener

サブスクライバーの動画統計情報を取得するためのリスナーオブジェクトを定義します。

フィールド概要

フィールド

修飾子と型

フィールド

説明

protected SubscriberKit.AudioLevelListener

audioLevelListener

protected SubscriberKit.AudioStatsListener

audioStatsListener

protected SubscriberKit.CaptionsListener

captionsListener

protected SubscriberKit.MediaLinkStatsListener

mediaLinkStatsListener

static final String

NETWORK_REASON_NETWORK_CONDITION_CHANGE

ローカルまたはリモートの参加者のネットワーク状況に変化があったことを示します。

static final float

NO_PREFERRED_FRAMERATE

に渡しされるリセット値を定義します。 setPreferredFrameRate(float preferredFrameRate) メソッドを使用する。

static final VideoUtils.Size

NO_PREFERRED_RESOLUTION

に渡しされるリセット値を定義します。 setPreferredResolution(VideoUtils.Size preferredResolution) メソッドを使用する。

protected BaseVideoRenderer

renderer

protected SubscriberKit.SubscriberRtcStatsReportListener

rtcStatsReportListener

protected Session

session

protected Stream

stream

protected SubscriberKit.StreamListener

streamListener

protected SubscriberKit.SubscriberListener

subscriberListener

static final String

VIDEO_REASON_CODEC_CHANGE

ストリームのビデオコーデックが変更されました。

static final String

VIDEO_REASON_CODEC_NOT_SUPPORTED

この動画関連の事象は、サブスクライバーストリーム内の動画が、 そのストリームで使用されている動画コーデック（H.264など）が デバイスでサポートされていないために無効化されたことが原因で発生しました。

static final String

VIDEO_REASON_INTERRUPTION

動画の配信が中断されました。

static final String

VIDEO_REASON_NONE

static final String

VIDEO_REASON_PUBLISH_VIDEO

この動画イベントは、配信者が動画配信を開始または停止した ことが原因で発生しました。

static final String

VIDEO_REASON_QUALITY

この動画の不具合は、動画ストリームの画質変更が原因で発生しました。

static final String

VIDEO_REASON_RESOLUTION_CHANGE

ストリームの解像度が変更されました。

static final String

VIDEO_REASON_SUBSCRIBE_TO_VIDEO

この動画の不具合は、 setSubscribeToVideo(boolean subscribeToVideo) メソッドを使用する。

protected SubscriberKit.VideoListener

videoListener

protected SubscriberKit.VideoStatsListener

videoStatsListener

コンストラクタの概要

コンストラクタ

修飾子

コンストラクタ

説明

protected

SubscriberKit(SubscriberKit.Builder builder)

方法の概要

すべてのメソッド　インスタンスメソッド　具体的なメソッド　非推奨のメソッド

修飾子と型

方法

説明

protected void

attachToSession(Session session)

void

destroy()

非推奨です。

protected void

detachFromSession(Session session)

protected void

finalize()

ガベージコレクションにより、SubscriberKit オブジェクトへの参照が もう存在しないと判断された際に、ガベージコレクタによって呼び出されます。

double

getAudioVolume()

加入者の音声音量（0～100）を返します。

String

getCaptionsTranslationLanguage()

この加入者に対して設定されているキャプションの翻訳言語を取得します。

float

getPreferredFrameRate()

サブスクライバーのストリームに推奨されるフレームレートを返します。

VideoUtils.Size

getPreferredResolution()

サブスクライバーのストリームに対して推奨される解像度を返します。

BaseVideoRenderer

getRenderer()

このサブスクライバーのビデオレンダラーを返します。

void

getRtcStatsReport()

サブスクライバーのRTC統計レポートを取得します。

Session

getSession()

次の値を返します。 Session 加入者は（ connect() Session オブジェクトのメソッド）。

Stream

getStream()

次の値を返します。 Stream このインスタンスがバインドされているもの。

boolean

getSubscribeToAudio()

加入者がオーディオを購読しているかどうか。

boolean

getSubscribeToCaptions()

加入者が字幕サービスを購読しているかどうか。

boolean

getSubscribeToVideo()

加入者がオーディオを購読しているかどうか。

android.view.View

getView()

Subscriber ビデオを含む android.view.View オブジェクトを返します。

protected void

onAudioDisabled()

加入者のストリームオーディオが無効化されたときに呼び出されます

protected void

onAudioEnabled()

加入者のストリームでオーディオが有効になっているときに呼び出されます。

protected void

onAudioLevelUpdated(float audioLevel)

protected void

onCaptionText(String text, boolean isFinal)

protected void

onConnected()

インスタンスがストリームへの接続に成功し、メディアの再生を開始したときに呼び出されます。

protected void

onDisconnected()

非推奨です。

protected void

onError(OpentokError error)

サブスクライバーがOpenTokサーバーへの接続に失敗した際に呼び出されます。

void

onPause()

直接電話しないでください。電話をかける場合は Session.onPause() その代わりだ。

void

onResume()

直接電話しないでください。電話をかける場合は Session.onResume() その代わりだ。

protected void

onRtcStatsReport(String jsonArrayOfReports)

``への呼び出しに応答して、加入者のRTC統計レポートが利用可能になった際に呼び出されます。 ` getRtcStatsReport().

protected void

onStreamDisconnected()

加入者のストリームが中断されたときに呼び出されます。

protected void

onStreamReconnected()

加入者のストリームが再開されたとき、以下の後に呼び出されます。 onStreamDisconnected() メソッドが呼び出される。

protected void

onVideoDataReceived()

サブスクライバーが初めて動画データを受信した際に呼び出されます。

protected void

onVideoDisabled(String reason)

加入者が動画の受信を停止したときに呼び出されます。

protected void

onVideoDisableWarning()

OpenTok Media Router がストリームの品質が低下したと判断した場合に呼び出され、 品質がさらに低下した場合は動画が停止されます。

protected void

onVideoDisableWarningLifted()

OpenTok Media Router が、ストリームの品質が 改善し、無効化される動画が直ちに リスクをもたらさない状態になったと判断した際に呼び出されます。

protected void

onVideoEnabled(String reason)

加入者のビデオストリームが開始されたとき（それまで ビデオがなかった場合）、または再開されたとき（ビデオが無効化されていた後）に呼び出されます。

void

setAudioLevelListener(SubscriberKit.AudioLevelListener listener)

をバインドします SubscriberKit.AudioLevelListener このSubscriberKitインスタンスに接続し、 オーディオレベルの更新を監視します。

void

setAudioStatsListener(SubscriberKit.AudioStatsListener listener)

サブスクライバーのオーディオ統計情報を監視するリスナーを設定します。

void

setAudioVolume(double volume)

加入者の音声音量を0から100の間で設定します。

void

setCaptionsListener(SubscriberKit.CaptionsListener listener)

をバインドします SubscriberKit.CaptionsListener このSubscriberKitインスタンスに接続して、字幕を受信します。

void

setCaptionsTranslationLanguage(String language)

この購読者のキャプション翻訳の優先言語を設定します。

void

setMediaLinkStatsListener(SubscriberKit.MediaLinkStatsListener listener)

サブスクライバーのメディアリンク統計に関するリスナーを設定します。

void

setPreferredFrameRate(float preferredFrameRate)

サブスクライバーのストリームに対して、推奨フレームレートを設定します。

void

setPreferredResolution(VideoUtils.Size preferredResolution)

サブスクライバーのストリームに使用する優先解像度を設定します。

void

setRenderer(BaseVideoRenderer renderer)

非推奨です。

void

setRtcStatsReportListener(SubscriberKit.SubscriberRtcStatsReportListener listener)

サブスクライバーのRTC統計レポートリスナーを設定します。

void

setStreamListener(SubscriberKit.StreamListener listener)

サブスクライバーのストリームが中断されたり、 再開されたりすることに関連するイベントのリスナーを設定します。

void

setStyle(String key, String value)

この購読者が使用するスタイルを設定します。

void

setSubscriberListener(SubscriberKit.SubscriberListener listener)

を SubscriberKit.SubscriberListener 状態の変化を監視するオブジェクト。

void

setSubscribeToAudio(boolean subscribeToAudio)

そのストリームの音声を購読するかどうか（true)または(false).

void

setSubscribeToCaptions(boolean subscribeToCaptions)

その配信の字幕を購読するかどうか（true)または(false)..

void

setSubscribeToVideo(boolean subscribeToVideo)

そのストリームの動画を購読するかどうか（true)または(false).

void

setVideoListener(SubscriberKit.VideoListener listener)

を SubscriberKit.VideoListener サブスクライバーが動画の受信を開始 および停止したタイミングを監視するオブジェクト。

void

setVideoStatsListener(SubscriberKit.VideoStatsListener listener)

サブスクライバーの動画統計情報のリスナーを設定します。

void

update(Observable o, Object arg)

非推奨です。

java.lang クラスから継承されたメソッド。目的

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

VIDEO_REASON_NONE

public static final ストリング VIDEO_REASON_NONE

関連項目： : - [定数フィールド値]

VIDEO_REASON_PUBLISH_VIDEO

public static final ストリング VIDEO_REASON_PUBLISH_VIDEO

この動画イベントは、配信者が動画ストリームの開始または停止を行ったことに起因しています。 この文字列は、

関連項目： : - method. - method. - [定数フィールド値]

VIDEO_REASON_SUBSCRIBE_TO_VIDEO

public static final ストリング VIDEO_REASON_SUBSCRIBE_TO_VIDEO

この動画の不具合は、 setSubscribeToVideo(boolean subscribeToVideo) メソッドを使用する。

関連項目： : - SubscriberKit.VideoListener.onVideoDisabled(SubscriberKit, String) - SubscriberKit.VideoListener.onVideoEnabled(SubscriberKit, String) - [定数フィールド値]

VIDEO_REASON_QUALITY

public static final ストリング VIDEO_REASON_QUALITY

この動画の不具合は、動画ストリームの画質変更によって引き起こされました。 ストリームの画質は、ネットワーク状況や、 視聴者側または配信者側のCPU使用率によって変化する場合があります。

オーディオフォールバックを有効にすると、動画の画質低下によりサブスクライバーが 動画ストリームの受信を中止した際にイベントが発生し、その結果、 SubscriberKit.VideoListener.onVideoDisabled(SubscriberKit, String) 呼び出されている メソッド。 状況が改善すると、ビデオストリームが再開され、 SubscriberKit.VideoListener.onVideoEnabled(SubscriberKit, String) メソッドが 呼び出されます。

ビデオストリームが切断された場合でも、オーディオストリームが存在すれば、加入者は引き続き そのオーディオストリームを受信し続けます。

ルーティングされたセッションでは、このイベントの発生源は、Vonage Video Media Router（加入者側オーディオフォールバック）またはパブリッシングクライアント （パブリッシャー側オーディオフォールバック）のいずれかになります。発生源がパブリッシング クライアントの場合、このイベントの後に Session.StreamPropertiesListener.onStreamHasVideoChanged(Session, Stream, boolean) セッションオブジェクトによってディスパッチされるコールバックで、 サブスクライブされたビデオチャンネルがもはやアクティブではないことを示します。一般的に、この追加の イベントはパブリッシャー側のネットワーク品質の低下を示しますが、 サブスクライバーから報告されたメトリクスがパブリッシャーのフォールバック判断に影響を与える可能性があり、 そのため、品質低下の正確な原因を特定することが困難になる場合があります。

中継セッションでは、「quality」イベントは、 パブリッシャーの内部オーディオフォールバックロジック（Publisher Audio フォールバック）によってのみトリガーされます。このイベントの後に、 ビデオが非アクティブであることを示すコールバックは発生しません。これは、 ネットワーク環境が良好な他の サブスクライバーが引き続きストリームを受信している可能性があるためです。なお、リレーセッションでは、 オーディオフォールバックイベントはパブリッシャーから発生しますが、 ネットワークの劣化はパブリッシャー側またはサブスクライバー側のいずれでも発生する可能性があることに注意してください。

関連項目： : - method. - method. - [定数フィールド値]

VIDEO_REASON_CODEC_NOT_SUPPORTED

public static final ストリング VIDEO_REASON_CODEC_NOT_SUPPORTED

この動画関連の事象は、サブスクライバーストリーム内の動画が、 そのストリームで使用されている動画コーデック（H.264など）が デバイスでサポートされていないために無効化されたことが原因で発生しました。

関連項目： : - [定数フィールド値]

VIDEO_REASON_INTERRUPTION

public static final ストリング VIDEO_REASON_INTERRUPTION

動画の配信が中断されました。

関連項目： : - [定数フィールド値]

VIDEO_理由_解像度_変更

public static final ストリング VIDEO_理由_解像度_変更

ストリームの解像度が変更されました。

関連項目： : - [定数フィールド値]

VIDEO_REASON_CODEC_CHANGE

public static final ストリング VIDEO_REASON_CODEC_CHANGE

ストリームのビデオコーデックが変更されました。

関連項目： : - [定数フィールド値]

NETWORK_REASON_NETWORK_CONDITION_CHANGE

public static final ストリング NETWORK_REASON_NETWORK_CONDITION_CHANGE

ローカルまたはリモートの参加者のネットワーク状態が変化したことを示します。 このイベントは、パブリッシャーまたはサブスクライバーのネットワーク状態に 著しい変化が検出されたときに発生します。

関連項目： : - [定数フィールド値]

NO_PREFERRED_RESOLUTION

public static final VideoUtils.Size NO_PREFERRED_RESOLUTION

に渡しされるリセット値を定義します。 setPreferredResolution(VideoUtils.Size preferredResolution) メソッド。この値を渡すと、サブスクライバーの設定がリセットされ、優先解像度が設定されなくなります。 サブスクライバーは、状況に応じて利用可能な最高解像度を使用します。

これは、スケーラブルビデオ 機能を使用して公開されたストリームにのみ適用されます。

NO_PREFERRED_FRAMERATE

public static final float NO_PREFERRED_FRAMERATE

に渡しされるリセット値を定義します。 setPreferredFrameRate(float preferredFrameRate) メソッド。 この値を引数として渡すと、サブスクライバーの設定がリセットされ、優先フレームレートが設定されなくなります。サブスクライバーは、 状況に応じて利用可能な最大フレームレートを使用します。

これは、スケーラブルビデオ機能を使用して公開されたストリームにのみ適用されます。

関連項目： : - [定数フィールド値]

videoStatsListener

protected SubscriberKit.VideoStatsListener videoStatsListener

audioStatsListener

protected SubscriberKit.AudioStatsListener audioStatsListener

mediaLinkStatsListener

protected SubscriberKit.MediaLinkStatsListener mediaLinkStatsListener

subscriberListener

protected SubscriberKit.SubscriberListener subscriberListener

rtcStatsReportListener

protected SubscriberKit.SubscriberRtcStatsReportListener rtcStatsReportListener

videoListener

protected SubscriberKit.VideoListener videoListener

audioLevelListener

protected SubscriberKit.AudioLevelListener audioLevelListener

captionsListener

protected SubscriberKit.CaptionsListener captionsListener

streamListener

protected SubscriberKit.StreamListener streamListener

セッション

protected セッション セッション

レンダラー

protected BaseVideoRenderer レンダラー

ストリーム

protected ストリーム ストリーム

コンストラクタの詳細

SubscriberKit

protected SubscriberKit(SubscriberKit.Builder （ビルダー）

メソッドの詳細

破壊する

@非推奨 public void destroy()

非推奨です。

オブジェクトを手動で破棄するのは安全ではありません。バージョン 2.17.0 以降、このメソッドは 何もしません。リソースはガベージコレクタによって自動的に解放されます。

setSubscriberListener

public void setSubscriberListener(SubscriberKit.SubscriberListener リスナー)

を SubscriberKit.SubscriberListener 状態の変化を監視するオブジェクト。

パラメータ： : listener - その SubscriberKit.SubscriberListener このSubscriberKitインスタンスを監視するものです。

setVideoListener

public void setVideoListener(SubscriberKit.VideoListener リスナー)

を SubscriberKit.VideoListener サブスクライバーが動画の受信を開始 および停止したタイミングを監視するオブジェクト。

パラメータ： : listener - その SubscriberKit.VideoListener インスタンスだ。

setAudioLevelListener

public void setAudioLevelListener(SubscriberKit.AudioLevelListener リスナー)

をバインドします SubscriberKit.AudioLevelListener このSubscriberKitインスタンスに接続し、 オーディオレベルの更新を監視します。

パラメータ： : listener - その SubscriberKit.AudioLevelListener このインスタンスを監視します。 リスナーの接続を解除し、オーディオレベルの監視を停止するには、これをnullに設定してください。

setCaptionsListener

public void setCaptionsListener(SubscriberKit.CaptionsListener リスナー)

をバインドします SubscriberKit.CaptionsListener このSubscriberKitインスタンスに接続して、字幕を受信します。

パラメータ： : listener - その SubscriberKit.CaptionsListener このインスタンスを監視します。 リスナーの接続を解除し、キャプションの受信を停止するには、これをnullに設定してください。

setAudioVolume

public void setAudioVolume(double volume)

加入者の音声音量を0から100の間で設定します。 値がこの範囲外の場合は、この範囲内に制限されます。

パラメータ： : volume - 加入者の数。

getAudioVolume

public double getAudioVolume()

加入者の音声音量（0～100）を返します。

デフォルト値は 100 です。

setStreamListener

public void setStreamListener(SubscriberKit.StreamListener リスナー)

サブスクライバーのストリームが中断されたり、 再開されたりすることに関連するイベントのリスナーを設定します。

getSession

public セッション getSession()

次の値を返します。 Session 加入者は（ connect() Session オブジェクトのメソッド）。

戻り値： : The Session 加入者が遵守する義務を負うもの。

getStream

public ストリーム getStream()

次の値を返します。 Stream このインスタンスがバインドされているものです。 ストリーム上のメディアチャネルはすべて、 このインスタンスでの表示・再生が可能である必要があります。

戻り値： : The Stream このインスタンスがバインドされているもの。

getSubscribeToAudio

public boolean getSubscribeToAudio()

加入者がオーディオを購読しているかどうか。

戻り値： : サブスクライバーがオーディオを購読している場合は true、そうでない場合は false。

getSubscribeToVideo

public boolean getSubscribeToVideo()

加入者がオーディオを購読しているかどうか。

戻り値： : サブスクライバーがオーディオを購読している場合は true、そうでない場合は false。

getSubscribeToCaptions

public boolean getSubscribeToCaptions()

加入者が字幕サービスを購読しているかどうか。

戻り値： : サブスクライバーがキャプションを購読している場合は true、そうでない場合は false。 デフォルト値は、そのパブリッシャーのキャプション値です。 PublisherKit.setPublishCaptions(boolean).

setSubscribeToAudio

public void setSubscribeToAudio(boolean subscribeToAudio)

そのストリームの音声を購読するかどうか（true)または(false). このプロパティを設定しても、 hasAudio Stream オブジェクトのメソッド を返します false.

パラメータ： : subscribeToAudio - ストリームの音声を購読するかどうか（true) あるいは そうでない場合 (false).

setSubscribeToVideo

public void setSubscribeToVideo(boolean subscribeToVideo)

そのストリームの動画を購読するかどうか（true)または(false). このプロパティを設定しても、 hasVideo Stream オブジェクトのメソッド を返します false.

パラメータ： : subscribeToVideo - そのストリームの動画を購読するかどうか（true) あるいは そうでない場合 (false).

setSubscribeToCaptions

public void setSubscribeToCaptions(boolean subscribeToCaptions)

その配信の字幕を購読するかどうか（true)または(false)..

パラメータ： : subscribeToCaptions - その配信の字幕を購読するかどうか（true) あるいは そうでない場合 (false).

setCaptionsTranslationLanguage

public void setCaptionsTranslationLanguage(ストリング 言語)

この購読者のキャプション翻訳の優先言語を設定します。

この設定は、字幕が有効になっている場合にのみ有効になります。 翻訳された字幕を受け取るには、サポートされている BCP-47 言語コードを設定してください。 または null 翻訳を無効にするには。デフォルト値は null （翻訳設定がありません）。

サポートされている言語コードは、サーバーAPI仕様書に定義されています。

これはプライベートベータ版の機能です。

パラメータ： : language - サポートされている BCP-47 言語コード、または null 翻訳を無効にするには。

getCaptionsTranslationLanguage

public ストリング getCaptionsTranslationLanguage()

この加入者に対して設定されているキャプションの翻訳言語を取得します。

これはプライベートベータ版の機能です。

戻り値： : 設定された BCP-47 言語コード、または null 翻訳が設定されていない場合。

setStyle

public void setStyle(ストリング key, ストリング 値)

この購読者が使用するスタイルを設定します。

デフォルトでは、あらかじめ定義されているスタイルキーは1つだけです： BaseVideoRenderer.STYLE_VIDEO_SCALE. このキーに値を設定することで、 動画の拡大縮小率を指定できます。以下の値がサポートされています：

  • BaseVideoRenderer.STYLE_VIDEO_FILL — 動画は、必要に応じてトリミングを行いながら、 レンダラーの領域全体に拡大表示されます。
  • BaseVideoRenderer.STYLE_VIDEO_FIT — 動画は必要に応じて縮小され、 ピラーボックス表示（デフォルト設定）で動画全体が見えるようになります。

このメソッドを呼び出すことは、以下を呼び出すことと同じです。 getRenderer().setStyle()。ただし、 このクラスを継承すれば、このメソッドをオーバーライドして、他のスタイルや動作に対応させることができます。

パラメータ： : key - 設定するスタイル。 : value - スタイルを設定する値。

setRenderer

@非推奨 public void setRenderer(BaseVideoRenderer レンダラー)

非推奨です。

このサブスクライバーのビデオレンダラーを設定します。

このメソッドは非推奨です。代わりに、 次の SubscriberKit.Builder.renderer(BaseVideoRenderer renderer) Builder を使用して SubscriberKit インスタンスを作成する際の メソッド。

getRenderer

public BaseVideoRenderer getRenderer()

このサブスクライバーのビデオレンダラーを返します。

getView

public android.view.View getView()

Subscriber ビデオを含む android.view.View オブジェクトを返します。

setVideoStatsListener

public void setVideoStatsListener(SubscriberKit.VideoStatsListener リスナー)

サブスクライバーの動画統計情報のリスナーを設定します。このリスナーオブジェクトは、 SubscriberKit.VideoStatsListener.onVideoStats(SubscriberKit subscriber, SubscriberKit.SubscriberVideoStats stats) メソッド。このメソッドは定期的に呼び出され、 以下の情報を報告します：

  • 失われたビデオパケットの総数
  • 受信したビデオパケットの総数
  • 受信した動画の総バイト数

関連項目： : - setAudioStatsListener(AudioStatsListener listener)

setAudioStatsListener

public void setAudioStatsListener(SubscriberKit.AudioStatsListener リスナー)

サブスクライバーのオーディオ統計情報のリスナーを設定します。このリスナーオブジェクトは、 SubscriberKit.AudioStatsListener.onAudioStats(SubscriberKit subscriber, SubscriberKit.SubscriberAudioStats stats) メソッド。このメソッドは定期的に呼び出され、 以下の情報を報告します：

  • 失われたオーディオパケットの総数
  • 受信したオーディオパケットの総数
  • 受信したオーディオの合計バイト数

関連項目： : - setVideoStatsListener(VideoStatsListener listener)

setMediaLinkStatsListener

public void setMediaLinkStatsListener(SubscriberKit.MediaLinkStatsListener リスナー)

サブスクライバーのメディアリンク統計に関するリスナーを設定します。このリスナーオブジェクトは ` SubscriberKit.MediaLinkStatsListener インターフェース。これには以下が含まれます：

パラメータ： : listener - その SubscriberKit.MediaLinkStatsListener リスナーを削除するには、インスタンスまたはnullを指定します。

setPreferredResolution

public void setPreferredResolution(VideoUtils.Size preferredResolution)

サブスクライバーのストリームに使用する優先解像度を設定します。

動画の解像度とフレームレートを制限する（参照： setPreferredFrameRate(float preferredFrameRate)) これにより、 サブスクライバー側のクライアントにおけるネットワーク負荷と CPU使用率が軽減されます。アプリ内でサブスクライバーの動画の サイズに応じて、より低い解像度を設定することを検討してください。また、他の ストリームに比べて重要度が低く（かつ規模が小さい）ストリームの サブスクライバーに対しては、より低いフレームレートや 解像度を設定することを検討してください。

この方法は、 スケーラブルビデオ機能. スケーラブルビデオが利用可能です：

  • OpenTok Media Router を使用するセッション（ メディア モード に設定されている)。
  • スケーラブルビデオに対応したクライアントによって配信されるストリームのみ （詳細については、 スケーラブルな 動画機能).

スケーラブルビデオを使用していないストリームでは、このメソッドを呼び出しても何の効果もありません。

注： スケーラブルなビデオストリームの解像度は、このメソッドを呼び出さなくても、 ネットワークの状態やCPU使用率に基づいて、各加入者ごとに自動的に調整されます。 この加入者の最大解像度を設定したい場合は、このメソッドを呼び出してください。

スケーラブルビデオを使用していないストリームでは、このメソッドを呼び出しても何の効果もありません。

すべての解像度が加入者に利用可能というわけではありません。希望する 解像度を設定すると、OpenTok Android SDK は、利用可能な解像度の中から、 設定条件に合致する最適な解像度を選択します。利用可能な解像度は、パブリッシャーがストリームに対して設定した最大 幅および最大高さに依存し、これらは Stream.getVideoWidth() そして Stream.getVideoHeight() Stream オブジェクトの メソッド。ストリームで利用可能な各解像度は、すべて同じ アスペクト比を使用します。

パス・イン SubscriberKit.NO_PREFERRED_RESOLUTION サブスクライバーをリセットし、 優先解像度を設定しないようにします。サブスクライバーは、 状況に応じて利用可能な最高解像度を使用します。

setPreferredFrameRate

public void setPreferredFrameRate(float preferredFrameRate)

サブスクライバーのストリームに対して、推奨フレームレートを設定します。

フレームレートと動画解像度の制限（参照： setPreferredResolution(VideoUtils.Size preferredResolution)) これにより、サブスクライバー側のクライアントにおけるネットワークおよび CPUの使用量が削減されます。アプリ内でサブスクライバーの動画の サイズに応じて、より低い解像度を設定することを検討してください。また、他の ストリームに比べて重要度が低く（かつ規模が小さい）ストリームのサブスクライバーに対しては、 より低いフレームレートや 解像度を設定することを検討してください。

この方法は、 スケーラブルビデオ機能. スケーラブルビデオが利用可能です：

  • OpenTok Media Router を使用するセッション（ メディア モード に設定されている)。
  • スケーラブルビデオに対応したクライアントによって配信されるストリームのみ （詳細については、 スケーラブルな 動画機能).

スケーラブルビデオを使用していないストリームでは、このメソッドを呼び出しても何の効果もありません。

注： スケーラブルなビデオストリームのフレームレートは、このメソッドを呼び出さなくても、 ネットワークの状態やCPU使用率に基づいて、各加入者ごとに自動的に調整されます。 この加入者の最大フレームレートを設定したい場合は、このメソッドを呼び出してください。

利用可能なフレームレートは、ストリームで利用可能な最大フレームレートの値に基づいています。 サブスクライバーの希望フレームレートを設定すると、OpenTok Android SDKは、 クライアントの帯域幅およびCPUの制約に基づき、希望フレームレートに最も近い 利用可能な最適なフレームレートを選択します。

実際に利用可能なフレームレートは、パブリッシャーが利用できるネットワークおよびCPU リソースに応じて動的に変化します。

パス・イン SubscriberKit.NO_PREFERRED_FRAMERATE サブスクライバーの設定をリセットし、 優先フレームレートを設定しないようにします。これにより、サブスクライバーは状況に応じて、 利用可能な最大フレームレートを使用するようになります。

getPreferredResolution

public VideoUtils.Size getPreferredResolution()

サブスクライバーのストリームに対して推奨される解像度を返します。このメソッドは、 スケーラブルビデオ機能を使用して公開されたストリームにのみ適用されます。詳しくは、 setPreferredResolution(VideoUtils.Size preferredResolution).

setRtcStatsReportListener

public void setRtcStatsReportListener(SubscriberKit.SubscriberRtcStatsReportListener リスナー)

サブスクライバーの RTC 統計レポートリスナーを設定します。詳しくは、 getRtcStatsReport().

パラメータ： : listener - その SubscriberKit.SubscriberRtcStatsReportListener オブジェクトがある。

getRtcStatsReport

public void getRtcStatsReport()

サブスクライバーのRTC統計レポートを取得します。これは非同期操作です。 SubscriberKit#setRtcStatsReportListener(SubscriberRtcStatsReportListener listener) メソッドを呼び出し、次に SubscriberKit.SubscriberRtcStatsReportListener.onRtcStatsReport(SubscriberKit subscriber, String jsonArrayOfReports) このメソッドを呼び出す前に、method を実行してください。統計情報が利用可能になった時点で、 の SubscriberKit.SubscriberRtcStatsReportListener.onRtcStatsReport(SubscriberKit subscriber, String jsonArrayOfReports) メソッドが呼び出されます。

こちらも参照 setAudioStatsListener(SubscriberKit.AudioStatsListener listener), setVideoStatsListener(SubscriberKit.VideoStatsListener listener)そして PublisherKit.getRtcStatsReport().

onRtcStatsReport

protected void onRtcStatsReport(ストリング jsonArrayOfReports)

``への呼び出しに応答して、加入者のRTC統計レポートが利用可能になった際に呼び出されます。 ` getRtcStatsReport().

SubscriberKit クラスを拡張する場合は、 SubscriberKit.SubscriberRtcStatsReportListener インターフェースの onRtcStatsReport() メソッドを実装する代わりに、このメソッドをオーバーライドすることができます。

参照 onRtcStatsReport(String jsonArrayOfReports).

getPreferredFrameRate

public float getPreferredFrameRate()

サブスクライバーのストリームに対して推奨されるフレームレートを返します。このメソッドは、 スケーラブルビデオ機能を使用して公開されたストリームにのみ適用されます。詳しくは、 setPreferredFrameRate(float preferredFrameRate).

戻り値： : サブスクライバー・ストリームの推奨フレームレート。実際の値の取得中に エラーが発生した場合は -1 を返す。

onConnected

protected void onConnected()

インスタンスがストリームへの接続に成功し、メディアの再生を開始したときに呼び出されます。

SubscriberKit クラスを継承する場合は、 onConnected() SubscriberKit.SubscriberListener インターフェースのメソッド。

onDisconnected

@非推奨 protected void onDisconnected()

非推奨です。

バージョン 2.17.0 以降、このコールバックは呼び出されなくなります。サブスクライバーが セッションから切断すると、 Session.SessionListener.onStreamDropped(com.opentok.android.Session, com.opentok.android.Stream) コールバックが呼び出されます。

onError

protected void onError(OpentokError (エラー)

サブスクライバーがOpenTokサーバーへの接続に失敗した際に呼び出されます。

SubscriberKit クラスを継承する場合は、 onError() SubscriberKit.SubscriberListener インターフェースのメソッド。

パラメータ： : error - エラー。

onStreamDisconnected

protected void onStreamDisconnected()

加入者のストリームが中断されたときに呼び出されます。

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

クライアントがストリームに再接続した場合、 onStreamReconnected() メソッドが呼び出されます。 そうでない場合は、 onDisconnected() メソッドが呼び出される。

SubscriberKit クラスを継承する場合は、 を実装する代わりに、このメソッドをオーバーライドすることができます。 onDisconnected() SubscriberKit.StreamListener インターフェースのメソッド。

onStreamReconnected

protected void onStreamReconnected()

加入者のストリームが再開されたとき、以下の後に呼び出されます。 onStreamDisconnected() メソッドが呼び出される。

SubscriberKit クラスを継承する場合は、 を実装する代わりに、このメソッドをオーバーライドすることができます。 onReconnected() SubscriberKit.StreamListener インターフェースのメソッド。

onAudioEnabled

protected void onAudioEnabled()

加入者のストリームでオーディオが有効になっているときに呼び出されます。

SubscriberKit クラスを継承する場合は、 を実装する代わりに、このメソッドをオーバーライドすることができます。 onAudioEnabled() SubscriberKit.StreamListener インターフェースのメソッド。

onAudioDisabled

protected void onAudioDisabled()

加入者のストリームオーディオが無効化されたときに呼び出されます

SubscriberKit クラスを継承する場合は、 を実装する代わりに、このメソッドをオーバーライドすることができます。 onAudioDisabled() SubscriberKit.StreamListener インターフェースのメソッド。

onVideoDisabled

protected void onVideoDisabled(ストリング 理由）

加入者が動画の受信を停止した際に呼び出されます。動画の受信が停止した理由については、 reason パラメータを確認してください。

SubscriberKit クラスを継承する場合は、 onVideoDisabled() SubscriberKit.SubscriberListener インターフェースのメソッド。

パラメータ： : reason - ビデオトラックが無効にされた理由。この値は、 以下のいずれかの値に設定されます： VIDEO_REASON_PUBLISH_VIDEO VIDEO_REASON_SUBSCRIBE_TO_VIDEO, VIDEO_REASON_QUALITY、または VIDEO_REASON_CODEC_NOT_SUPPORTED.

onVideoEnabled

protected void onVideoEnabled(ストリング 理由）

加入者のビデオストリームが開始されたとき（それまで ビデオがなかった場合）、または再開されたとき（ビデオが無効化された後）に呼び出されます。ビデオが停止した理由については、 reason パラメータを確認してください。

SubscriberKit クラスを継承する場合は、 onVideoEnabled() SubscriberKit.SubscriberListener インターフェースのメソッド。

パラメータ： : reason - ビデオトラックが開始または再開された理由。この値は 、以下のいずれかの値に設定されます： VIDEO_REASON_PUBLISH_VIDEO VIDEO_REASON_SUBSCRIBE_TO_VIDEO、または VIDEO_REASON_QUALITY.

onVideoDisableWarning

protected void onVideoDisableWarning()

OpenTok Media Router がストリームの品質が低下したと判断し、 さらに品質が低下した場合は動画が無効化される場合に呼び出されます。 品質がさらに低下した場合、加入者は動画を無効化し、 onVideoDisabled(String reason) メソッドが呼び出されます。ストリームの品質が 向上した場合、 onVideoDisableWarningLifted() メソッドが呼び出される。

この機能は、OpenTok Media Router を使用するセッション （メディアモードが「routed」に設定されているセッション）でのみ利用可能であり、メディアモードが 「relayed」に設定されているセッションでは利用できません。（参照： OpenTokの メディアルーターとメディアモード).

このメソッドは、主に接続品質が低下した際に呼び出されます。

SubscriberKit クラスを継承する場合は、 onVideoDisableWarning() SubscriberKit.SubscriberListener インターフェースのメソッド。

onVideoDisableWarningLifted

protected void onVideoDisableWarningLifted()

OpenTok Media Router が、ストリームの品質が 改善し、無効化される動画が直ちに リスクをもたらさない状態になったと判断した際に呼び出されます。このメソッドは、 onVideoDisableWarning() メソッドが呼び出されます。

この機能は、OpenTok Media Router を使用するセッション （メディアモードが「routed」に設定されているセッション）でのみ利用可能であり、メディア モードが「relayed」に設定されているセッションでは利用できません。（参照： OpenTokの メディアルーターとメディアモード.)

このメソッドは、主に接続品質が改善されたときに呼び出されます。

SubscriberKit クラスを継承する場合は、 の代わりにこのメソッドをオーバーライドすることができます。 onVideoDisableWarningLifted() SubscriberKit.SubscriberListener インターフェースの メソッド。

onVideoDataReceived

protected void onVideoDataReceived()

サブスクライバーが初めて動画データを受信した際に呼び出されます。

SubscriberKit クラスを継承する場合は、 onVideoDataReceived() SubscriberKit.VideoListener インターフェースのメソッド。

attachToSession

protected void attachToSession(セッション セッション)

detachFromSession

protected void detachFromSession(セッション セッション)

onAudioLevelUpdated

protected void onAudioLevelUpdated(float audioLevel)

onCaptionText

protected void onCaptionText(ストリング text, boolean isFinal)

onPause

public void onPause()

直接電話しないでください。電話をかける場合は Session.onPause() その代わりだ。

onResume

public void onResume()

直接電話しないでください。電話をかける場合は Session.onResume() その代わりだ。

更新

@非推奨 public void update(オブザーバブル o, 目的 arg)

非推奨です。

このメソッドは、監視対象のオブジェクトに変更があったたびに呼び出されます。 このクラスはObserverインターフェースを実装しているため、 セッションの一時停止や再開などのイベントを監視します。

指定者： : update インターフェース内で Observer

パラメータ： : o - 観測対象。 : arg - `notifyObservers` メソッドに渡される引数。

確定する

protected void finalize() throws 投げられる

ガベージコレクションにより、SubscriberKit オブジェクトへの参照が もう存在しないと判断された際に、ガベージコレクタによって呼び出されます。

上書き： : finalize 授業中 Object

投球： : Throwable