Package com.opentok.android

Class SubscriberKit.SubscriberVideoStats

java.lang.Object
com.opentok.android.SubscriberKit.SubscriberVideoStats
Enclosing class:
SubscriberKit
public static class SubscriberKit.SubscriberVideoStats extends Object
Defines video statistics for a subscriber.
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    long
    bitrate
    The bitrate, in bits per second.
    String
    codec
    Codec used for the video stream.
    double
    decodedFrameRate
    The decoded video frame rate (in frames per second)
    long
    freezeCount
    Number of times the subscriber’s video has frozen.
    int
    height
    The height of the video frame, in pixels.
    long
    pauseCount
    Number of times the subscriber’s video playback has paused.
    SubscriberKit.SenderStats
    senderStats
    Deprecated.
    Use subscriber media link stats (SubscriberMediaLinkStats) instead for complete network metrics including remote publisher transport and network degradation source information.
    double
    timeStamp
    The timestamp, in milliseconds since the Unix epoch, for when these stats were gathered.
    long
    totalBitrate
    The total bitrate (including RTP headers, padding, and payload).
    long
    totalFreezesDuration
    Cumulative duration (in milliseconds) of all video freezes.
    long
    totalPausesDuration
    Cumulative duration (in milliseconds) of all video pauses.
    int
    videoBytesReceived
    The total number of video bytes received by the subscriber.
    int
    videoPacketsLost
    The total number of video packets lost by the subscriber.
    int
    videoPacketsReceived
    The total number of video packets received by the subscriber.
    int
    width
    The width of the video frame, in pixels.

  • Method Summary

    Methods inherited from class java.lang.Object

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

  • Field Details

    • videoPacketsLost

      public int videoPacketsLost
      The total number of video packets lost by the subscriber.

    • videoPacketsReceived

      public int videoPacketsReceived
      The total number of video packets received by the subscriber.

    • videoBytesReceived

      public int videoBytesReceived
      The total number of video bytes received by the subscriber.

    • timeStamp

      public double timeStamp
      The timestamp, in milliseconds since the Unix epoch, for when these stats were gathered.

    • senderStats

      @Deprecated public SubscriberKit.SenderStats senderStats
      Deprecated.
      Use subscriber media link stats (SubscriberMediaLinkStats) instead for complete network metrics including remote publisher transport and network degradation source information.
      Sender-side network estimation stats. This may be null if stats are not available. Due to network latency, sender statistics may not be immediately available after the initial stats request.

    • width

      public int width
      The width of the video frame, in pixels.

    • height

      public int height
      The height of the video frame, in pixels.

    • decodedFrameRate

      public double decodedFrameRate
      The decoded video frame rate (in frames per second)

    • bitrate

      public long bitrate
      The bitrate, in bits per second.

    • totalBitrate

      public long totalBitrate
      The total bitrate (including RTP headers, padding, and payload).

    • pauseCount

      public long pauseCount
      Number of times the subscriber’s video playback has paused. Video is considered paused if the time since the last rendered frame exceeds 5 seconds.

    • totalPausesDuration

      public long totalPausesDuration
      Cumulative duration (in milliseconds) of all video pauses.

    • freezeCount

      public long freezeCount
      Number of times the subscriber’s video has frozen. A freeze is defined according to https://www.w3.org/TR/webrtc-stats/#dom-rtcinboundrtpstreamstats-freezecount

    • totalFreezesDuration

      public long totalFreezesDuration
      Cumulative duration (in milliseconds) of all video freezes.

    • codec

      public String codec
      Codec used for the video stream. This value may be null if the information is not available.