fm.liveswitch.MediaSenderStats Class Reference

Media sender stats. More...

Public Member Functions

long getBytesSent ()
 Gets the number of bytes sent. More...
 
double getNetworkQuality ()
 Gets the sender's estimated network quality. More...
 
long getPacketsSent ()
 Gets the number of packets sent. More...
 
int getRoundTripTime ()
 Gets the round trip time in milliseconds. More...
 
fm.liveswitch.MediaSourceStats getSource ()
 Gets the source stats. More...
 
boolean isEquivalent (fm.liveswitch.MediaSenderStats instance)
 Checks if a media sender is equivalent to this one. More...
 
 MediaSenderStats ()
 
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...
 
double getMediaQuality (boolean audio)
 Gets the component's estimated media quality. 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.MediaSenderStats >
abstract boolean isEquivalent (T instance)
 Checks if an instance is equivalent to this one. More...
 

Static Public Member Functions

static fm.liveswitch.MediaSenderStats fromJson (String mediaSenderJson)
 Derializes media sender stats from JSON. More...
 
static fm.liveswitch.MediaSenderStats[] fromJsonArray (String mediaSendersJson)
 Derializes a media sender stats array from JSON. More...
 
static String toJson (fm.liveswitch.MediaSenderStats mediaSender)
 Serializes media sender stats to JSON. More...
 
static String toJsonArray (fm.liveswitch.MediaSenderStats[] mediaSenders)
 Serializes a media sender 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 sender stats.

Constructor & Destructor Documentation

◆ MediaSenderStats()

fm.liveswitch.MediaSenderStats.MediaSenderStats ( )

Member Function Documentation

◆ deserializeProperties()

void fm.liveswitch.MediaSenderStats.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.MediaSenderStats fm.liveswitch.MediaSenderStats.fromJson ( String  mediaSenderJson)
static

Derializes media sender stats from JSON.

Parameters
mediaSenderJsonThe media sender's stats JSON.

◆ fromJsonArray()

static fm.liveswitch.MediaSenderStats [] fm.liveswitch.MediaSenderStats.fromJsonArray ( String  mediaSendersJson)
static

Derializes a media sender stats array from JSON.

Parameters
mediaSendersJsonThe media senders' stats JSON.

◆ getBytesSent()

long fm.liveswitch.MediaSenderStats.getBytesSent ( )

Gets the number of bytes sent.

◆ getNetworkQuality()

double fm.liveswitch.MediaSenderStats.getNetworkQuality ( )

Gets the sender'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.

◆ getPacketsSent()

long fm.liveswitch.MediaSenderStats.getPacketsSent ( )

Gets the number of packets sent.

◆ getRoundTripTime()

int fm.liveswitch.MediaSenderStats.getRoundTripTime ( )

Gets the round trip time in milliseconds.

◆ getSource()

fm.liveswitch.MediaSourceStats fm.liveswitch.MediaSenderStats.getSource ( )

Gets the source stats.

◆ isEquivalent()

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

Checks if a media sender is equivalent to this one.

Parameters
instanceThe media sender.

◆ serializeProperties()

void fm.liveswitch.MediaSenderStats.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.MediaSenderStats.toJson ( )

Serializes this to JSON.

◆ toJson() [2/2]

static String fm.liveswitch.MediaSenderStats.toJson ( fm.liveswitch.MediaSenderStats  mediaSender)
static

Serializes media sender stats to JSON.

Parameters
mediaSenderThe media sender's stats.

◆ toJsonArray()

static String fm.liveswitch.MediaSenderStats.toJsonArray ( fm.liveswitch.MediaSenderStats[]  mediaSenders)
static

Serializes a media sender stats array to JSON.

Parameters
mediaSendersThe media senders' stats.