SubscriberKit.VideoListener

Enclosing class: : SubscriberKit

public static interface SubscriberKit.VideoListener

Monitors when the subscriber starts and stops receiving video data.

Method Summary

All MethodsInstance MethodsAbstract Methods

Modifier and Type

Method

Description

void

onVideoDataReceived(SubscriberKit subscriber)

Invoked when an subscriber initially receives video data.

void

onVideoDisabled(SubscriberKit subscriber, String reason)

Called when the subscriber stops receiving video.

void

onVideoDisableWarning(SubscriberKit subscriber)

Called when the OpenTok Media Router determines that the stream quality has degraded and the video will be disabled if the quality degrades further.

void

onVideoDisableWarningLifted(SubscriberKit subscriber)

Called when the OpenTok Media Router determines that the stream quality has improved to the point at which the video being disabled is not an immediate risk.

void

onVideoEnabled(SubscriberKit subscriber, String reason)

Called when the subscriber's video stream starts (when there previously was no video) or resumes (after video was disabled).

Method Details

onVideoDataReceived

void onVideoDataReceived(SubscriberKit subscriber)

Invoked when an subscriber initially receives video data.

Parameters: : subscriber - The instance invoking this call.

onVideoDisabled

void onVideoDisabled(SubscriberKit subscriber, String reason)

Called when the subscriber stops receiving video. Check the reason parameter for the reason why the video stopped.

Parameters: : subscriber - The instance invoking this call. : reason - The reason that the video track was disabled. This is set to one of the following values: SubscriberKit.VIDEO_REASON_PUBLISH_VIDEO, SubscriberKit.VIDEO_REASON_SUBSCRIBE_TO_VIDEO, SubscriberKit.VIDEO_REASON_QUALITY, or SubscriberKit.VIDEO_REASON_CODEC_NOT_SUPPORTED.

onVideoEnabled

void onVideoEnabled(SubscriberKit subscriber, String reason)

Called when the subscriber's video stream starts (when there previously was no video) or resumes (after video was disabled). Check the reason parameter for the reason why the video stopped.

Parameters: : subscriber - The instance invoking this call. : reason - The reason that the video track was started (or resumed). This is set to one of the following values: SubscriberKit.VIDEO_REASON_PUBLISH_VIDEO, SubscriberKit.VIDEO_REASON_SUBSCRIBE_TO_VIDEO, or SubscriberKit.VIDEO_REASON_QUALITY.

onVideoDisableWarning

void onVideoDisableWarning(SubscriberKit subscriber)

Called when the OpenTok Media Router determines that the stream quality has degraded and the video will be disabled if the quality degrades further. If the quality degrades further, the subscriber disables the video and the onVideoDisabled(SubscriberKit subscriber, String reason) method called. If the stream quality improves, the onVideoDisableWarningLifted(SubscriberKit subscriber) method is called.

This feature is only available in sessions that use the OpenTok Media Router (sessions with the media mode set to routed), not in sessions with the media mode set to relayed. (See The OpenTok Media Router and media modes).

This method is mainly called when connection quality degrades.

Parameters: : subscriber - The SubscriberKit that may stop receiving video soon.

onVideoDisableWarningLifted

void onVideoDisableWarningLifted(SubscriberKit subscriber)

Called when the OpenTok Media Router determines that the stream quality has improved to the point at which the video being disabled is not an immediate risk. This method is called after the onVideoDisableWarning(SubscriberKit subscriber) method is called.

This method is mainly called when connection quality improves.

Parameters: : subscriber - The SubscriberKit instance.