Class RTCMediaStreamTrackStats

java.lang.Object
org.kurento.client.Stats
org.kurento.client.RTCStats
org.kurento.client.RTCMediaStreamTrackStats
public class RTCMediaStreamTrackStats extends RTCStats
Statistics related to the media stream.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    RTCMediaStreamTrackStats()
    Default private constructor of RTCMediaStreamTrackStats for serialization with Jackson
     
    RTCMediaStreamTrackStats(String id, StatsType type, long timestampMillis, String trackIdentifier, boolean remoteSource, List<String> ssrcIds, long frameWidth, long frameHeight, double framesPerSecond, long framesSent, long framesReceived, long framesDecoded, long framesDropped, long framesCorrupted, double audioLevel, double echoReturnLoss, double echoReturnLossEnhancement)
    Create a RTCMediaStreamTrackStats

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    getAudioLevel()
    get Only valid for audio, and the value is between 0..1 (linear), where 1.0 represents 0 dBov.
    double
    getEchoReturnLoss()
    get Only present on audio tracks sourced from a microphone where echo cancellation is applied.
    double
    getEchoReturnLossEnhancement()
    get Only present on audio tracks sourced from a microphone where echo cancellation is applied.
    long
    getFrameHeight()
    get Only makes sense for video media streams and represents the height of the video frame for this SSRC.
    long
    getFramesCorrupted()
    get Only valid for video.
    long
    getFramesDecoded()
    get Only valid for video.
    long
    getFramesDropped()
    get Only valid for video.
    double
    getFramesPerSecond()
    get Only valid for video.
    long
    getFramesReceived()
    get Only valid for video and when remoteSource is set to true.
    long
    getFramesSent()
    get Only valid for video.
    long
    getFrameWidth()
    get Only makes sense for video media streams and represents the width of the video frame for this SSRC.
    boolean
    getRemoteSource()
    get true indicates that this is a remote source.
    List<String>
    getSsrcIds()
    get Synchronized sources.
    String
    getTrackIdentifier()
    get Represents the track.id property.
    void
    setAudioLevel(double audioLevel)
    set Only valid for audio, and the value is between 0..1 (linear), where 1.0 represents 0 dBov.
    void
    setEchoReturnLoss(double echoReturnLoss)
    set Only present on audio tracks sourced from a microphone where echo cancellation is applied.
    void
    setEchoReturnLossEnhancement(double echoReturnLossEnhancement)
    set Only present on audio tracks sourced from a microphone where echo cancellation is applied.
    void
    setFrameHeight(long frameHeight)
    set Only makes sense for video media streams and represents the height of the video frame for this SSRC.
    void
    setFramesCorrupted(long framesCorrupted)
    set Only valid for video.
    void
    setFramesDecoded(long framesDecoded)
    set Only valid for video.
    void
    setFramesDropped(long framesDropped)
    set Only valid for video.
    void
    setFramesPerSecond(double framesPerSecond)
    set Only valid for video.
    void
    setFramesReceived(long framesReceived)
    set Only valid for video and when remoteSource is set to true.
    void
    setFramesSent(long framesSent)
    set Only valid for video.
    void
    setFrameWidth(long frameWidth)
    set Only makes sense for video media streams and represents the width of the video frame for this SSRC.
    void
    setRemoteSource(boolean remoteSource)
    set true indicates that this is a remote source.
    void
    setSsrcIds(List<String> ssrcIds)
    set Synchronized sources.
    void
    setTrackIdentifier(String trackIdentifier)
    set Represents the track.id property.

    Methods inherited from class Stats

    getId, getTimestampMillis, getType, setId, setTimestampMillis, setType

    Methods inherited from class Object

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

  • Constructor Details

    • RTCMediaStreamTrackStats

      protected RTCMediaStreamTrackStats()
      Default private constructor of RTCMediaStreamTrackStats for serialization with Jackson

    • RTCMediaStreamTrackStats

      public RTCMediaStreamTrackStats(String id, StatsType type, long timestampMillis, String trackIdentifier, boolean remoteSource, List<String> ssrcIds, long frameWidth, long frameHeight, double framesPerSecond, long framesSent, long framesReceived, long framesDecoded, long framesDropped, long framesCorrupted, double audioLevel, double echoReturnLoss, double echoReturnLossEnhancement)
      Create a RTCMediaStreamTrackStats

  • Method Details

    • getTrackIdentifier

      public String getTrackIdentifier()
      get Represents the track.id property.

    • setTrackIdentifier

      public void setTrackIdentifier(String trackIdentifier)
      set Represents the track.id property.

    • getRemoteSource

      public boolean getRemoteSource()
      get true indicates that this is a remote source. false in other case.

    • setRemoteSource

      public void setRemoteSource(boolean remoteSource)
      set true indicates that this is a remote source. false in other case.

    • getSsrcIds

      public List<String> getSsrcIds()
      get Synchronized sources.

    • setSsrcIds

      public void setSsrcIds(List<String> ssrcIds)
      set Synchronized sources.

    • getFrameWidth

      public long getFrameWidth()
      get Only makes sense for video media streams and represents the width of the video frame for this SSRC.

    • setFrameWidth

      public void setFrameWidth(long frameWidth)
      set Only makes sense for video media streams and represents the width of the video frame for this SSRC.

    • getFrameHeight

      public long getFrameHeight()
      get Only makes sense for video media streams and represents the height of the video frame for this SSRC.

    • setFrameHeight

      public void setFrameHeight(long frameHeight)
      set Only makes sense for video media streams and represents the height of the video frame for this SSRC.

    • getFramesPerSecond

      public double getFramesPerSecond()
      get Only valid for video. It represents the nominal FPS value.

    • setFramesPerSecond

      public void setFramesPerSecond(double framesPerSecond)
      set Only valid for video. It represents the nominal FPS value.

    • getFramesSent

      public long getFramesSent()
      get Only valid for video. It represents the total number of frames sent for this SSRC.

    • setFramesSent

      public void setFramesSent(long framesSent)
      set Only valid for video. It represents the total number of frames sent for this SSRC.

    • getFramesReceived

      public long getFramesReceived()
      get Only valid for video and when remoteSource is set to true. It represents the total number of frames received for this SSRC.

    • setFramesReceived

      public void setFramesReceived(long framesReceived)
      set Only valid for video and when remoteSource is set to true. It represents the total number of frames received for this SSRC.

    • getFramesDecoded

      public long getFramesDecoded()
      get Only valid for video. It represents the total number of frames correctly decoded for this SSRC.

    • setFramesDecoded

      public void setFramesDecoded(long framesDecoded)
      set Only valid for video. It represents the total number of frames correctly decoded for this SSRC.

    • getFramesDropped

      public long getFramesDropped()
      get Only valid for video. The total number of frames dropped pre-decoding or dropped because the frame missed its display deadline.

    • setFramesDropped

      public void setFramesDropped(long framesDropped)
      set Only valid for video. The total number of frames dropped pre-decoding or dropped because the frame missed its display deadline.

    • getFramesCorrupted

      public long getFramesCorrupted()
      get Only valid for video. The total number of corrupted frames that have been detected.

    • setFramesCorrupted

      public void setFramesCorrupted(long framesCorrupted)
      set Only valid for video. The total number of corrupted frames that have been detected.

    • getAudioLevel

      public double getAudioLevel()
      get Only valid for audio, and the value is between 0..1 (linear), where 1.0 represents 0 dBov.

    • setAudioLevel

      public void setAudioLevel(double audioLevel)
      set Only valid for audio, and the value is between 0..1 (linear), where 1.0 represents 0 dBov.

    • getEchoReturnLoss

      public double getEchoReturnLoss()
      get Only present on audio tracks sourced from a microphone where echo cancellation is applied. Calculated in decibels.

    • setEchoReturnLoss

      public void setEchoReturnLoss(double echoReturnLoss)
      set Only present on audio tracks sourced from a microphone where echo cancellation is applied. Calculated in decibels.

    • getEchoReturnLossEnhancement

      public double getEchoReturnLossEnhancement()
      get Only present on audio tracks sourced from a microphone where echo cancellation is applied.

    • setEchoReturnLossEnhancement

      public void setEchoReturnLossEnhancement(double echoReturnLossEnhancement)
      set Only present on audio tracks sourced from a microphone where echo cancellation is applied.