All Known Subinterfaces:

MediaStreamStats2

All Known Implementing Classes:

MediaStreamStats2Impl, MediaStreamStatsImpl
```
public interface MediaStreamStats
```
Class used to compute stats concerning a MediaStream.

Author:

Vincent Lucas, Lyubomir Marinov, Hristo Terezov

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`addRTCPPacketListener(RTCPPacketListener listener)`	Adds a listener which will be notified when RTCP packets are received.
`double`	`getAvgDownloadJitterMs()`	Gets the average of the RTP jitter values reported to us in RTCP reports, in milliseconds.
`double`	`getAvgUploadJitterMs()`	Gets the average of the RTP jitter values reported to us in RTCP reports, in milliseconds.
`double`	`getDownloadJitterMs()`	Deprecated. use the appropriate method from `MediaStreamStats2` instead.
`long`	`getDownloadNbPacketLost()`	Deprecated. use the appropriate method from `MediaStreamStats2` instead.
`double`	`getDownloadPercentLoss()`	Deprecated. use the appropriate method from `MediaStreamStats2` instead.
`double`	`getDownloadRateKiloBitPerSec()`	Deprecated. use the appropriate method from `MediaStreamStats2` instead.
`Dimension`	`getDownloadVideoSize()`	Returns the download video size if this stream downloads a video, or `null` if not.
`String`	`getEncoding()`	Returns the `MediaStream` enconding.
`String`	`getEncodingClockRate()`	Returns the `MediaStream` enconding rate (in Hz).
`int`	`getJitterBufferDelayMs()`	Returns the delay in milliseconds introduced by the jitter buffer.
`int`	`getJitterBufferDelayPackets()`	Returns the delay in number of packets introduced by the jitter buffer.
`String`	`getLocalIPAddress()`	Returns the local IP address of the `MediaStream`.
`int`	`getLocalPort()`	Returns the local port of the `MediaStream`.
`double`	`getMaxDownloadJitterMs()`	Gets the maximum RTP jitter value reported by us in an RTCP report, in milliseconds.
`double`	`getMaxUploadJitterMs()`	Gets the maximum RTP jitter value reported to us in an RTCP report, in milliseconds.
`double`	`getMinDownloadJitterMs()`	Gets the minimum RTP jitter value reported by us in an RTCP report, in milliseconds.
`double`	`getMinUploadJitterMs()`	Gets the minimum RTP jitter value reported to us in an RTCP report, in milliseconds.
`long`	`getNbDiscarded()`	Returns the total number of discarded packets since the beginning of the session.
`int`	`getNbDiscardedFull()`	Returns the number of packets discarded since the beginning of the session, because the packet queue was full.
`int`	`getNbDiscardedLate()`	Returns the number of packets discarded since the beginning of the session, because they were late.
`int`	`getNbDiscardedReset()`	Returns the number of packets discarded since the beginning of the session, because the packet queue was reset.
`int`	`getNbDiscardedShrink()`	Returns the number of packets discarded since the beginning of the session, while the packet queue was shrinking.
`long`	`getNbFec()`	Returns the number of packets for which FEC data was decoded.
`long`	`getNbPackets()`	Deprecated. use the appropriate method from `MediaStreamStats2` instead.
`long`	`getNbPacketsLost()`	Deprecated. use the appropriate method from `MediaStreamStats2` instead.
`long`	`getNbPacketsReceived()`	Deprecated. use the appropriate method from `MediaStreamStats2` instead.
`long`	`getNbPacketsSent()`	Deprecated. use the appropriate method from `MediaStreamStats2` instead.
`long`	`getNbReceivedBytes()`	Deprecated. use the appropriate method from `MediaStreamStats2` instead.
`long`	`getNbSentBytes()`	Deprecated. use the appropriate method from `MediaStreamStats2` instead.
`int`	`getPacketQueueCountPackets()`	Returns the number of packets currently in the packet queue.
`int`	`getPacketQueueSize()`	Returns the current size of the packet queue.
`double`	`getPercentDiscarded()`	Returns the current percent of discarded packets.
`String`	`getRemoteIPAddress()`	Returns the remote IP address of the `MediaStream`.
`int`	`getRemotePort()`	Returns the remote port of the `MediaStream`.
`RTCPReports`	`getRTCPReports()`	Gets the detailed statistics about the RTCP reports sent and received by the associated local peer.
`long`	`getRttMs()`	Deprecated. use the appropriate method from `MediaStreamStats2` instead.
`long`	`getSendingBitrate()`	Deprecated. use the appropriate method from `MediaStreamStats2` instead.
`double`	`getUploadJitterMs()`	Deprecated. use the appropriate method from `MediaStreamStats2` instead.
`long`	`getUploadNbPacketLost()`	Deprecated. use the appropriate method from `MediaStreamStats2` instead.
`double`	`getUploadPercentLoss()`	Deprecated. use the appropriate method from `MediaStreamStats2` instead.
`double`	`getUploadRateKiloBitPerSec()`	Deprecated. use the appropriate method from `MediaStreamStats2` instead.
`Dimension`	`getUploadVideoSize()`	Returns the upload video size if this stream uploads a video, or `null` if not.
`boolean`	`isAdaptiveBufferEnabled()`	Checks whether there is an adaptive jitter buffer enabled for at least one of the `ReceiveStream`s of the `MediaStreamImpl`.
`void`	`removeRTCPPacketListener(RTCPPacketListener listener)`	Removes a listener from the list of listeners which will be notified when RTCP packets are received.
`void`	`updateStats()`	Computes and updates information for a specific stream.

- Method Detail
  - getDownloadJitterMs
```
@Deprecated
double getDownloadJitterMs()
```
    Deprecated.
    use the appropriate method from MediaStreamStats2 instead.
    
    Returns the jitter average of this download stream.
    
    Returns:
    
    the last jitter average computed (in ms).
  - getDownloadPercentLoss
```
@Deprecated
double getDownloadPercentLoss()
```
    Deprecated.
    use the appropriate method from MediaStreamStats2 instead.
    
    Returns the percent loss of the download stream.
    
    Returns:
    
    the last loss rate computed (in %).
  - getDownloadRateKiloBitPerSec
```
@Deprecated
double getDownloadRateKiloBitPerSec()
```
    Deprecated.
    use the appropriate method from MediaStreamStats2 instead.
    
    Returns the bandwidth used by this download stream.
    
    Returns:
    
    the last used download bandwidth computed (in Kbit/s).
  - getDownloadVideoSize
```
Dimension getDownloadVideoSize()
```
    Returns the download video size if this stream downloads a video, or null if not.
    
    Returns:
    
    the download video size if this stream downloads a video, or null if not.
  - getEncoding
```
String getEncoding()
```
    Returns the MediaStream enconding.
    
    Returns:
    
    the encoding used by the stream.
  - getEncodingClockRate
```
String getEncodingClockRate()
```
    Returns the MediaStream enconding rate (in Hz).
    
    Returns:
    
    the encoding rate used by the stream.
  - getJitterBufferDelayMs
```
int getJitterBufferDelayMs()
```
    Returns the delay in milliseconds introduced by the jitter buffer.
    
    Returns:
    
    the delay in milliseconds introduced by the jitter buffer
  - getJitterBufferDelayPackets
```
int getJitterBufferDelayPackets()
```
    Returns the delay in number of packets introduced by the jitter buffer.
    
    Returns:
    
    the delay in number of packets introduced by the jitter buffer
  - getLocalIPAddress
```
String getLocalIPAddress()
```
    Returns the local IP address of the MediaStream.
    
    Returns:
    
    the local IP address of the stream.
  - getLocalPort
```
int getLocalPort()
```
    Returns the local port of the MediaStream.
    
    Returns:
    
    the local port of the stream.
  - getNbReceivedBytes
```
@Deprecated
long getNbReceivedBytes()
```
    Deprecated.
    use the appropriate method from MediaStreamStats2 instead.
    
    Returns the number of received bytes since the beginning of the session.
    
    Returns:
    
    the number of received bytes for this stream.
  - getNbSentBytes
```
@Deprecated
long getNbSentBytes()
```
    Deprecated.
    use the appropriate method from MediaStreamStats2 instead.
    
    Returns the number of sent bytes since the beginning of the session.
    
    Returns:
    
    the number of sent bytes for this stream.
  - getNbDiscarded
```
long getNbDiscarded()
```
    Returns the total number of discarded packets since the beginning of the session.
    
    Returns:
    
    the total number of discarded packets since the beginning of the session.
  - getNbDiscardedFull
```
int getNbDiscardedFull()
```
    Returns the number of packets discarded since the beginning of the session, because the packet queue was full.
    
    Returns:
    
    the number of packets discarded since the beginning of the session, because the packet queue was full.
  - getNbDiscardedLate
```
int getNbDiscardedLate()
```
    Returns the number of packets discarded since the beginning of the session, because they were late.
    
    Returns:
    
    the number of packets discarded since the beginning of the session, because they were late.
  - getNbDiscardedReset
```
int getNbDiscardedReset()
```
    Returns the number of packets discarded since the beginning of the session, because the packet queue was reset.
    
    Returns:
    
    the number of packets discarded since the beginning of the session, because the packet queue was reset.
  - getNbDiscardedShrink
```
int getNbDiscardedShrink()
```
    Returns the number of packets discarded since the beginning of the session, while the packet queue was shrinking.
    
    Returns:
    
    the number of packets discarded since the beginning of the session, while the packet queue was shrinking.
  - getNbFec
```
long getNbFec()
```
    Returns the number of packets for which FEC data was decoded.
    
    Returns:
    
    the number of packets for which FEC data was decoded
  - getNbPackets
```
@Deprecated
long getNbPackets()
```
    Deprecated.
    use the appropriate method from MediaStreamStats2 instead.
    
    Returns the total number of packets that are send or receive for this stream since the stream is created.
    
    Returns:
    
    the total number of packets.
  - getNbPacketsLost
```
@Deprecated
long getNbPacketsLost()
```
    Deprecated.
    use the appropriate method from MediaStreamStats2 instead.
    
    Returns the number of lost packets for that stream.
    
    Returns:
    
    the number of lost packets.
  - getPacketQueueCountPackets
```
int getPacketQueueCountPackets()
```
    Returns the number of packets currently in the packet queue.
    
    Returns:
    
    the number of packets currently in the packet queue.
  - getPacketQueueSize
```
int getPacketQueueSize()
```
    Returns the current size of the packet queue.
    
    Returns:
    
    the current size of the packet queue.
  - getPercentDiscarded
```
double getPercentDiscarded()
```
    Returns the current percent of discarded packets.
    
    Returns:
    
    the current percent of discarded packets.
  - getRemoteIPAddress
```
String getRemoteIPAddress()
```
    Returns the remote IP address of the MediaStream.
    
    Returns:
    
    the remote IP address of the stream.
  - getRemotePort
```
int getRemotePort()
```
    Returns the remote port of the MediaStream.
    
    Returns:
    
    the remote port of the stream.
  - getRTCPReports
```
RTCPReports getRTCPReports()
```
    Gets the detailed statistics about the RTCP reports sent and received by the associated local peer.
    
    Returns:
    
    the detailed statistics about the RTCP reports sent and received by the associated local peer
  - getRttMs
```
@Deprecated
long getRttMs()
```
    Deprecated.
    use the appropriate method from MediaStreamStats2 instead.
    
    Returns the RTT computed with the RTCP feedback (cf. RFC3550, section 6.4.1, subsection "delay since last SR (DLSR): 32 bits").
    
    Returns:
    
    The RTT computed with the RTCP feedback. Returns -1 if the RTT has not been computed yet. Otherwise the RTT in ms.
  - getUploadJitterMs
```
@Deprecated
double getUploadJitterMs()
```
    Deprecated.
    use the appropriate method from MediaStreamStats2 instead.
    
    Returns the jitter average of this upload stream.
    
    Returns:
    
    the last jitter average computed (in ms).
  - getUploadPercentLoss
```
@Deprecated
double getUploadPercentLoss()
```
    Deprecated.
    use the appropriate method from MediaStreamStats2 instead.
    
    Returns the percent loss of the upload stream.
    
    Returns:
    
    the last loss rate computed (in %).
  - getUploadRateKiloBitPerSec
```
@Deprecated
double getUploadRateKiloBitPerSec()
```
    Deprecated.
    use the appropriate method from MediaStreamStats2 instead.
    
    Returns the bandwidth used by this download stream.
    
    Returns:
    
    the last used upload bandwidth computed (in Kbit/s).
  - getUploadVideoSize
```
Dimension getUploadVideoSize()
```
    Returns the upload video size if this stream uploads a video, or null if not.
    
    Returns:
    
    the upload video size if this stream uploads a video, or null if not.
  - isAdaptiveBufferEnabled
```
boolean isAdaptiveBufferEnabled()
```
    Checks whether there is an adaptive jitter buffer enabled for at least one of the ReceiveStreams of the MediaStreamImpl.
    
    Returns:
    
    true if there is an adaptive jitter buffer enabled for at least one of the ReceiveStreams of the MediaStreamImpl; otherwise, false
  - updateStats
```
void updateStats()
```
    Computes and updates information for a specific stream.
  - getMinDownloadJitterMs
```
double getMinDownloadJitterMs()
```
    Gets the minimum RTP jitter value reported by us in an RTCP report, in milliseconds. Returns -1D if the value is unknown.
    
    Returns:
    
    the minimum RTP jitter value reported by us in an RTCP report, in milliseconds.
  - getMaxDownloadJitterMs
```
double getMaxDownloadJitterMs()
```
    Gets the maximum RTP jitter value reported by us in an RTCP report, in milliseconds. Returns -1D if the value is unknown.
    
    Returns:
    
    the maximum RTP jitter value reported by us in an RTCP report, in milliseconds.
  - getAvgDownloadJitterMs
```
double getAvgDownloadJitterMs()
```
    Gets the average of the RTP jitter values reported to us in RTCP reports, in milliseconds. Returns -1D if the value is unknown.
    
    Returns:
    
    the average of the RTP jitter values reported to us in RTCP reports, in milliseconds. Returns -1D if the value is unknown.
  - getMinUploadJitterMs
```
double getMinUploadJitterMs()
```
    Gets the minimum RTP jitter value reported to us in an RTCP report, in milliseconds. Returns -1D if the value is unknown.
    
    Returns:
    
    the minimum RTP jitter value reported to us in an RTCP report, in milliseconds.
  - getMaxUploadJitterMs
```
double getMaxUploadJitterMs()
```
    Gets the maximum RTP jitter value reported to us in an RTCP report, in milliseconds. Returns -1D if the value is unknown.
    
    Returns:
    
    the maximum RTP jitter value reported to us in an RTCP report, in milliseconds.
  - getAvgUploadJitterMs
```
double getAvgUploadJitterMs()
```
    Gets the average of the RTP jitter values reported to us in RTCP reports, in milliseconds. Returns -1D if the value is unknown.
    
    Returns:
    
    the average of the RTP jitter values reported to us in RTCP reports, in milliseconds. Returns -1D if the value is unknown.
  - getNbPacketsSent
```
@Deprecated
long getNbPacketsSent()
```
    Deprecated.
    use the appropriate method from MediaStreamStats2 instead.
    
    Returns the number of packets sent since the beginning of the session.
    
    Returns:
    
    the number of packets sent since the beginning of the session.
  - getNbPacketsReceived
```
@Deprecated
long getNbPacketsReceived()
```
    Deprecated.
    use the appropriate method from MediaStreamStats2 instead.
    
    Returns the number of packets received since the beginning of the session.
    
    Returns:
    
    the number of packets received since the beginning of the session.
  - getDownloadNbPacketLost
```
@Deprecated
long getDownloadNbPacketLost()
```
    Deprecated.
    use the appropriate method from MediaStreamStats2 instead.
    
    Returns the number of RTP packets sent by the remote side, but not received by us.
    
    Returns:
    
    the number of RTP packets sent by the remote side, but not received by us.
  - getUploadNbPacketLost
```
@Deprecated
long getUploadNbPacketLost()
```
    Deprecated.
    use the appropriate method from MediaStreamStats2 instead.
    
    Returns the number of RTP packets sent by us, but not received by the remote side.
    
    Returns:
    
    the number of RTP packets sent by us, but not received by the remote side.
  - addRTCPPacketListener
```
void addRTCPPacketListener(RTCPPacketListener listener)
```
    Adds a listener which will be notified when RTCP packets are received.
    
    Parameters:
    
    listener - the listener.
  - removeRTCPPacketListener
```
void removeRTCPPacketListener(RTCPPacketListener listener)
```
    Removes a listener from the list of listeners which will be notified when RTCP packets are received.
    
    Parameters:
    
    listener - the listener.
  - getSendingBitrate
```
@Deprecated
long getSendingBitrate()
```
    Deprecated.
    use the appropriate method from MediaStreamStats2 instead.
    
    Gets the rate at which we are currently sending data to the remote endpoint in bits per second. This is almost the same as getUploadRateKiloBitPerSec(). The duplication is necessary, because of implementation details.
    
    Returns:
    
    the rate at which we are currently sending data to the remote endpoint, in bits per second.

Interface MediaStreamStats

Method Summary

Method Detail

getDownloadJitterMs

getDownloadPercentLoss

getDownloadRateKiloBitPerSec

getDownloadVideoSize

getEncoding

getEncodingClockRate

getJitterBufferDelayMs

getJitterBufferDelayPackets

getLocalIPAddress

getLocalPort

getNbReceivedBytes

getNbSentBytes

getNbDiscarded

getNbDiscardedFull

getNbDiscardedLate

getNbDiscardedReset

getNbDiscardedShrink

getNbFec

getNbPackets

getNbPacketsLost

getPacketQueueCountPackets

getPacketQueueSize

getPercentDiscarded

getRemoteIPAddress

getRemotePort

getRTCPReports

getRttMs

getUploadJitterMs

getUploadPercentLoss

getUploadRateKiloBitPerSec

getUploadVideoSize

isAdaptiveBufferEnabled

updateStats

getMinDownloadJitterMs

getMaxDownloadJitterMs

getAvgDownloadJitterMs

getMinUploadJitterMs

getMaxUploadJitterMs

getAvgUploadJitterMs

getNbPacketsSent

getNbPacketsReceived

getDownloadNbPacketLost

getUploadNbPacketLost

addRTCPPacketListener

removeRTCPPacketListener

getSendingBitrate