Class RTCIceCandidatePairStats

java.lang.Object
org.kurento.client.Stats
org.kurento.client.RTCStats
org.kurento.client.RTCIceCandidatePairStats
public class RTCIceCandidatePairStats extends RTCStats

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    RTCIceCandidatePairStats()
    Default private constructor of RTCIceCandidatePairStats for serialization with Jackson
     
    RTCIceCandidatePairStats(String id, StatsType type, long timestampMillis, String transportId, String localCandidateId, String remoteCandidateId, RTCStatsIceCandidatePairState state, long priority, boolean nominated, boolean writable, boolean readable, long bytesSent, long bytesReceived, double roundTripTime, double availableOutgoingBitrate, double availableIncomingBitrate)
    Create a RTCIceCandidatePairStats

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    getAvailableIncomingBitrate()
    get Measured in Bits per second, and is implementation dependent.
    double
    getAvailableOutgoingBitrate()
    get Measured in Bits per second, and is implementation dependent.
    long
    getBytesReceived()
    get Represents the total number of payload bytes received on this candidate pair, i.e., not including headers or padding.
    long
    getBytesSent()
    get Represents the total number of payload bytes sent on this candidate pair, i.e., not including headers or padding.
    String
    getLocalCandidateId()
    get It is a unique identifier that is associated to the object that was inspected to produce the RTCIceCandidateAttributes for the local candidate associated with this candidate pair.
    boolean
    getNominated()
    get Related to updating the nominated flag described in Section 7.1.3.2.4 of [RFC5245].
    long
    getPriority()
    get Calculated from candidate priorities as defined in [RFC5245] section 5.7.2.
    boolean
    getReadable()
    get Has gotten a valid incoming ICE request.
    String
    getRemoteCandidateId()
    get It is a unique identifier that is associated to the object that was inspected to produce the RTCIceCandidateAttributes for the remote candidate associated with this candidate pair.
    double
    getRoundTripTime()
    get Represents the RTT computed by the STUN connectivity checks
    RTCStatsIceCandidatePairState
    getState()
    get Represents the state of the checklist for the local and remote candidates in a pair.
    String
    getTransportId()
    get It is a unique identifier that is associated to the object that was inspected to produce the RTCTransportStats associated with this candidate pair.
    boolean
    getWritable()
    get Has gotten ACK to an ICE request.
    void
    setAvailableIncomingBitrate(double availableIncomingBitrate)
    set Measured in Bits per second, and is implementation dependent.
    void
    setAvailableOutgoingBitrate(double availableOutgoingBitrate)
    set Measured in Bits per second, and is implementation dependent.
    void
    setBytesReceived(long bytesReceived)
    set Represents the total number of payload bytes received on this candidate pair, i.e., not including headers or padding.
    void
    setBytesSent(long bytesSent)
    set Represents the total number of payload bytes sent on this candidate pair, i.e., not including headers or padding.
    void
    setLocalCandidateId(String localCandidateId)
    set It is a unique identifier that is associated to the object that was inspected to produce the RTCIceCandidateAttributes for the local candidate associated with this candidate pair.
    void
    setNominated(boolean nominated)
    set Related to updating the nominated flag described in Section 7.1.3.2.4 of [RFC5245].
    void
    setPriority(long priority)
    set Calculated from candidate priorities as defined in [RFC5245] section 5.7.2.
    void
    setReadable(boolean readable)
    set Has gotten a valid incoming ICE request.
    void
    setRemoteCandidateId(String remoteCandidateId)
    set It is a unique identifier that is associated to the object that was inspected to produce the RTCIceCandidateAttributes for the remote candidate associated with this candidate pair.
    void
    setRoundTripTime(double roundTripTime)
    set Represents the RTT computed by the STUN connectivity checks
    void
    setState(RTCStatsIceCandidatePairState state)
    set Represents the state of the checklist for the local and remote candidates in a pair.
    void
    setTransportId(String transportId)
    set It is a unique identifier that is associated to the object that was inspected to produce the RTCTransportStats associated with this candidate pair.
    void
    setWritable(boolean writable)
    set Has gotten ACK to an ICE request.

    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

    • RTCIceCandidatePairStats

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

    • RTCIceCandidatePairStats

      public RTCIceCandidatePairStats(String id, StatsType type, long timestampMillis, String transportId, String localCandidateId, String remoteCandidateId, RTCStatsIceCandidatePairState state, long priority, boolean nominated, boolean writable, boolean readable, long bytesSent, long bytesReceived, double roundTripTime, double availableOutgoingBitrate, double availableIncomingBitrate)
      Create a RTCIceCandidatePairStats

  • Method Details

    • getTransportId

      public String getTransportId()
      get It is a unique identifier that is associated to the object that was inspected to produce the RTCTransportStats associated with this candidate pair.

    • setTransportId

      public void setTransportId(String transportId)
      set It is a unique identifier that is associated to the object that was inspected to produce the RTCTransportStats associated with this candidate pair.

    • getLocalCandidateId

      public String getLocalCandidateId()
      get It is a unique identifier that is associated to the object that was inspected to produce the RTCIceCandidateAttributes for the local candidate associated with this candidate pair.

    • setLocalCandidateId

      public void setLocalCandidateId(String localCandidateId)
      set It is a unique identifier that is associated to the object that was inspected to produce the RTCIceCandidateAttributes for the local candidate associated with this candidate pair.

    • getRemoteCandidateId

      public String getRemoteCandidateId()
      get It is a unique identifier that is associated to the object that was inspected to produce the RTCIceCandidateAttributes for the remote candidate associated with this candidate pair.

    • setRemoteCandidateId

      public void setRemoteCandidateId(String remoteCandidateId)
      set It is a unique identifier that is associated to the object that was inspected to produce the RTCIceCandidateAttributes for the remote candidate associated with this candidate pair.

    • getState

      public RTCStatsIceCandidatePairState getState()
      get Represents the state of the checklist for the local and remote candidates in a pair.

    • setState

      public void setState(RTCStatsIceCandidatePairState state)
      set Represents the state of the checklist for the local and remote candidates in a pair.

    • getPriority

      public long getPriority()
      get Calculated from candidate priorities as defined in [RFC5245] section 5.7.2.

    • setPriority

      public void setPriority(long priority)
      set Calculated from candidate priorities as defined in [RFC5245] section 5.7.2.

    • getNominated

      public boolean getNominated()
      get Related to updating the nominated flag described in Section 7.1.3.2.4 of [RFC5245].

    • setNominated

      public void setNominated(boolean nominated)
      set Related to updating the nominated flag described in Section 7.1.3.2.4 of [RFC5245].

    • getWritable

      public boolean getWritable()
      get Has gotten ACK to an ICE request.

    • setWritable

      public void setWritable(boolean writable)
      set Has gotten ACK to an ICE request.

    • getReadable

      public boolean getReadable()
      get Has gotten a valid incoming ICE request.

    • setReadable

      public void setReadable(boolean readable)
      set Has gotten a valid incoming ICE request.

    • getBytesSent

      public long getBytesSent()
      get Represents the total number of payload bytes sent on this candidate pair, i.e., not including headers or padding.

    • setBytesSent

      public void setBytesSent(long bytesSent)
      set Represents the total number of payload bytes sent on this candidate pair, i.e., not including headers or padding.

    • getBytesReceived

      public long getBytesReceived()
      get Represents the total number of payload bytes received on this candidate pair, i.e., not including headers or padding.

    • setBytesReceived

      public void setBytesReceived(long bytesReceived)
      set Represents the total number of payload bytes received on this candidate pair, i.e., not including headers or padding.

    • getRoundTripTime

      public double getRoundTripTime()
      get Represents the RTT computed by the STUN connectivity checks

    • setRoundTripTime

      public void setRoundTripTime(double roundTripTime)
      set Represents the RTT computed by the STUN connectivity checks

    • getAvailableOutgoingBitrate

      public double getAvailableOutgoingBitrate()
      get Measured in Bits per second, and is implementation dependent. It may be calculated by the underlying congestion control.

    • setAvailableOutgoingBitrate

      public void setAvailableOutgoingBitrate(double availableOutgoingBitrate)
      set Measured in Bits per second, and is implementation dependent. It may be calculated by the underlying congestion control.

    • getAvailableIncomingBitrate

      public double getAvailableIncomingBitrate()
      get Measured in Bits per second, and is implementation dependent. It may be calculated by the underlying congestion control.

    • setAvailableIncomingBitrate

      public void setAvailableIncomingBitrate(double availableIncomingBitrate)
      set Measured in Bits per second, and is implementation dependent. It may be calculated by the underlying congestion control.