fm.liveswitch.MediaReceiverStats Class Reference

Media receiver stats. More...

Public Member Functions

long getBytesReceived ()
 Gets the number of bytes received. More...
 
int getJitter ()
 Gets the jitter in milliseconds. More...
 
double getMediaQuality (boolean audio)
 Gets the receiver's estimated media quality. More...
 
double getNetworkQuality ()
 Gets the receiver's estimated network quality. More...
 
long getPacketsDiscarded ()
 Gets the number of packets discarded. More...
 
long getPacketsDuplicated ()
 Gets the number of packets duplicated. More...
 
long getPacketsLost ()
 Gets the number of packets lost. More...
 
long getPacketsReceived ()
 Gets the number of packets received. More...
 
long getPacketsRepaired ()
 Gets the number of packets repaired. More...
 
fm.liveswitch.MediaSinkStats getSink ()
 Gets the sink stats. More...
 
boolean isEquivalent (fm.liveswitch.MediaReceiverStats instance)
 Checks if a media receiver is equivalent to this one. More...
 
 MediaReceiverStats ()
 
String toJson ()
 Serializes this to JSON. More...
 
- Public Member Functions inherited from fm.liveswitch.MediaComponentStats
fm.liveswitch.CodecStats getCodec ()
 Gets the codec stats. More...
 
long getFirCount ()
 Gets the FIR count. More...
 
long getLrrCount ()
 Gets the LRR count. More...
 
long getNackCount ()
 Gets the NACK count. More...
 
long getPliCount ()
 Gets the PLI count. More...
 
String getRepairedRtpStreamId ()
 Gets the repaired RTP stream identifier. More...
 
String getRtpStreamId ()
 Gets the RTP stream identifier. More...
 
long getSliCount ()
 Gets the SLI count. More...
 
long getSynchronizationSource ()
 Gets the synchronization source. More...
 
fm.liveswitch.MediaTrackStats getTrack ()
 Gets the track's stats. More...
 
void setCodec (fm.liveswitch.CodecStats value)
 Sets the codec stats. More...
 
void setFirCount (long value)
 Sets the FIR count. More...
 
void setLrrCount (long value)
 Sets the LRR count. More...
 
void setNackCount (long value)
 Sets the NACK count. More...
 
void setPliCount (long value)
 Sets the PLI count. More...
 
void setRepairedRtpStreamId (String value)
 Sets the repaired RTP stream identifier. More...
 
void setRtpStreamId (String value)
 Sets the RTP stream identifier. More...
 
void setSliCount (long value)
 Sets the SLI count. More...
 
void setSynchronizationSource (long value)
 Sets the synchronization source. More...
 
void setTrack (fm.liveswitch.MediaTrackStats value)
 Sets the track's stats. More...
 
- Public Member Functions inherited from fm.liveswitch.BaseStats
String getId ()
 Gets the identifier of the object generating these stats. More...
 
java.util.Date getTimestamp ()
 Gets the timestamp when these stats were generated. More...
 
- Public Member Functions inherited from fm.liveswitch.IEquivalent< fm.liveswitch.MediaReceiverStats >
abstract boolean isEquivalent (T instance)
 Checks if an instance is equivalent to this one. More...
 

Static Public Member Functions

static fm.liveswitch.MediaReceiverStats fromJson (String mediaReceiverJson)
 Derializes media receiver stats from JSON. More...
 
static fm.liveswitch.MediaReceiverStats[] fromJsonArray (String mediaReceiversJson)
 Derializes media receiver stats array from JSON. More...
 
static String toJson (fm.liveswitch.MediaReceiverStats mediaReceiver)
 Serializes media receiver stats to JSON. More...
 
static String toJsonArray (fm.liveswitch.MediaReceiverStats[] mediaReceivers)
 Serializes media receiver stats array to JSON. More...
 

Protected Member Functions

void deserializeProperties (String key, String valueJson)
 Deserializes the properties. More...
 
void serializeProperties (java.util.HashMap< String, String > jsonObject)
 Serializes the properties. More...
 
- Protected Member Functions inherited from fm.liveswitch.MediaComponentStats
 MediaComponentStats ()
 
- Protected Member Functions inherited from fm.liveswitch.BaseStats
 BaseStats ()
 

Detailed Description

Media receiver stats.

Constructor & Destructor Documentation

◆ MediaReceiverStats()

fm.liveswitch.MediaReceiverStats.MediaReceiverStats ( )

Member Function Documentation

◆ deserializeProperties()

void fm.liveswitch.MediaReceiverStats.deserializeProperties ( String  key,
String  valueJson 
)
protected

Deserializes the properties.

Parameters
keyThe key.
valueJsonThe value in JSON format.

Reimplemented from fm.liveswitch.MediaComponentStats.

◆ fromJson()

static fm.liveswitch.MediaReceiverStats fm.liveswitch.MediaReceiverStats.fromJson ( String  mediaReceiverJson)
static

Derializes media receiver stats from JSON.

Parameters
mediaReceiverJsonThe media receiver's stats JSON.

◆ fromJsonArray()

static fm.liveswitch.MediaReceiverStats [] fm.liveswitch.MediaReceiverStats.fromJsonArray ( String  mediaReceiversJson)
static

Derializes media receiver stats array from JSON.

Parameters
mediaReceiversJsonThe media receivers' stats JSON.

◆ getBytesReceived()

long fm.liveswitch.MediaReceiverStats.getBytesReceived ( )

Gets the number of bytes received.

◆ getJitter()

int fm.liveswitch.MediaReceiverStats.getJitter ( )

Gets the jitter in milliseconds.

◆ getMediaQuality()

double fm.liveswitch.MediaReceiverStats.getMediaQuality ( boolean  audio)

Gets the receiver's estimated media quality.


The value ranges from 0.0 to 1.0, where 0.0 is the lowest quality and 1.0 is the highest quality.

Parameters
audioWhether these are audio stats.

Reimplemented from fm.liveswitch.MediaComponentStats.

◆ getNetworkQuality()

double fm.liveswitch.MediaReceiverStats.getNetworkQuality ( )

Gets the receiver's estimated network quality.


The value ranges from 0.0 to 1.0, where 0.0 is the lowest quality and 1.0 is the highest quality.

◆ getPacketsDiscarded()

long fm.liveswitch.MediaReceiverStats.getPacketsDiscarded ( )

Gets the number of packets discarded.

◆ getPacketsDuplicated()

long fm.liveswitch.MediaReceiverStats.getPacketsDuplicated ( )

Gets the number of packets duplicated.

◆ getPacketsLost()

long fm.liveswitch.MediaReceiverStats.getPacketsLost ( )

Gets the number of packets lost.

◆ getPacketsReceived()

long fm.liveswitch.MediaReceiverStats.getPacketsReceived ( )

Gets the number of packets received.

◆ getPacketsRepaired()

long fm.liveswitch.MediaReceiverStats.getPacketsRepaired ( )

Gets the number of packets repaired.

◆ getSink()

fm.liveswitch.MediaSinkStats fm.liveswitch.MediaReceiverStats.getSink ( )

Gets the sink stats.

◆ isEquivalent()

boolean fm.liveswitch.MediaReceiverStats.isEquivalent ( fm.liveswitch.MediaReceiverStats  instance)

Checks if a media receiver is equivalent to this one.

Parameters
instanceThe media receiver.

◆ serializeProperties()

void fm.liveswitch.MediaReceiverStats.serializeProperties ( java.util.HashMap< String, String >  jsonObject)
protected

Serializes the properties.

Parameters
jsonObjectThe JSON object.

Reimplemented from fm.liveswitch.MediaComponentStats.

◆ toJson() [1/2]

String fm.liveswitch.MediaReceiverStats.toJson ( )

Serializes this to JSON.

◆ toJson() [2/2]

static String fm.liveswitch.MediaReceiverStats.toJson ( fm.liveswitch.MediaReceiverStats  mediaReceiver)
static

Serializes media receiver stats to JSON.

Parameters
mediaReceiverThe media receiver's stats.

◆ toJsonArray()

static String fm.liveswitch.MediaReceiverStats.toJsonArray ( fm.liveswitch.MediaReceiverStats[]  mediaReceivers)
static

Serializes media receiver stats array to JSON.

Parameters
mediaReceiversThe media receivers' stats.