fm.liveswitch.telemetry.MediaStats Class Reference

Represents stats collected from the connection. More...

Public Member Functions

long getAvailableOutgoingBitrate ()
 Gets the available outgoing bitrate. More...
 
boolean getDetached ()
 Gets if the media track is detached. More...
 
String getDirection ()
 Gets the direction the media is being sent. More...
 
int getFrameHeight ()
 Gets the height of the last encoded frame. More...
 
double getFrameRate ()
 Gets the number of encoded frames sent in the last second. More...
 
int getFrameWidth ()
 Gets the width of the last encoded frame. More...
 
String getMediaType ()
 Gets the type of media. More...
 
boolean getMuted ()
 Gets if the media track is muted. More...
 
long getNackCount ()
 Gets the NACK count. More...
 
int getPacketsLost ()
 Gets the total packets lost. More...
 
double getPercentLost ()
 Gets the percent of packets lost. More...
 
long getPliCount ()
 Gets the PLI count. More...
 
fm.liveswitch.QualityLimitationDurations getQualityLimitationDurations ()
 Gets the durations for which quality has been limited for bandwidth, cpu, none, other. More...
 
String getQualityLimitationReason ()
 Gets the the reason for quality limitation. More...
 
long getQualityLimitationResolutionChanges ()
 Gets the count of resolution changes due to quality limitation. More...
 
boolean getStopped ()
 Gets if the media track is stopped. More...
 
int getTargetBitrate ()
 Gets the target bitrate of the encoder. More...
 
java.util.Date getTimestamp ()
 Gets the timestamp when these stats were generated. More...
 
void setNackCount (long value)
 Sets the NACK count. More...
 
void setPliCount (long value)
 Sets the PLI count. More...
 
String toJson ()
 Serializes this to JSON. More...
 

Static Public Member Functions

static fm.liveswitch.telemetry.MediaStats createOutboundAudioStreamStats (fm.liveswitch.MediaStreamStats audioStreamStats)
 Create outbound audio stats. More...
 
static fm.liveswitch.telemetry.MediaStats createOutboundVideoStats (fm.liveswitch.MediaStreamStats videoStreamStats)
 Create outbound video stats. More...
 
static fm.liveswitch.telemetry.MediaStats fromJson (String mediaStatsJson)
 Derializes media stats from JSON. More...
 
static String toJson (fm.liveswitch.telemetry.MediaStats outboundVideoStats)
 Serializes outbound video stats to JSON. More...
 

Detailed Description

Represents stats collected from the connection.

Member Function Documentation

◆ createOutboundAudioStreamStats()

static fm.liveswitch.telemetry.MediaStats fm.liveswitch.telemetry.MediaStats.createOutboundAudioStreamStats ( fm.liveswitch.MediaStreamStats  audioStreamStats)
static

Create outbound audio stats.

Parameters
audioStreamStats

◆ createOutboundVideoStats()

static fm.liveswitch.telemetry.MediaStats fm.liveswitch.telemetry.MediaStats.createOutboundVideoStats ( fm.liveswitch.MediaStreamStats  videoStreamStats)
static

Create outbound video stats.

Parameters
videoStreamStats

◆ fromJson()

static fm.liveswitch.telemetry.MediaStats fm.liveswitch.telemetry.MediaStats.fromJson ( String  mediaStatsJson)
static

Derializes media stats from JSON.

Parameters
mediaStatsJsonThe media stats JSON.

◆ getAvailableOutgoingBitrate()

long fm.liveswitch.telemetry.MediaStats.getAvailableOutgoingBitrate ( )

Gets the available outgoing bitrate.

◆ getDetached()

boolean fm.liveswitch.telemetry.MediaStats.getDetached ( )

Gets if the media track is detached.

◆ getDirection()

String fm.liveswitch.telemetry.MediaStats.getDirection ( )

Gets the direction the media is being sent.

◆ getFrameHeight()

int fm.liveswitch.telemetry.MediaStats.getFrameHeight ( )

Gets the height of the last encoded frame.

◆ getFrameRate()

double fm.liveswitch.telemetry.MediaStats.getFrameRate ( )

Gets the number of encoded frames sent in the last second.

◆ getFrameWidth()

int fm.liveswitch.telemetry.MediaStats.getFrameWidth ( )

Gets the width of the last encoded frame.

◆ getMediaType()

String fm.liveswitch.telemetry.MediaStats.getMediaType ( )

Gets the type of media.

◆ getMuted()

boolean fm.liveswitch.telemetry.MediaStats.getMuted ( )

Gets if the media track is muted.

◆ getNackCount()

long fm.liveswitch.telemetry.MediaStats.getNackCount ( )

Gets the NACK count.

◆ getPacketsLost()

int fm.liveswitch.telemetry.MediaStats.getPacketsLost ( )

Gets the total packets lost.

◆ getPercentLost()

double fm.liveswitch.telemetry.MediaStats.getPercentLost ( )

Gets the percent of packets lost.

◆ getPliCount()

long fm.liveswitch.telemetry.MediaStats.getPliCount ( )

Gets the PLI count.

◆ getQualityLimitationDurations()

fm.liveswitch.QualityLimitationDurations fm.liveswitch.telemetry.MediaStats.getQualityLimitationDurations ( )

Gets the durations for which quality has been limited for bandwidth, cpu, none, other.

◆ getQualityLimitationReason()

String fm.liveswitch.telemetry.MediaStats.getQualityLimitationReason ( )

Gets the the reason for quality limitation.

◆ getQualityLimitationResolutionChanges()

long fm.liveswitch.telemetry.MediaStats.getQualityLimitationResolutionChanges ( )

Gets the count of resolution changes due to quality limitation.

◆ getStopped()

boolean fm.liveswitch.telemetry.MediaStats.getStopped ( )

Gets if the media track is stopped.

◆ getTargetBitrate()

int fm.liveswitch.telemetry.MediaStats.getTargetBitrate ( )

Gets the target bitrate of the encoder.

◆ getTimestamp()

java.util.Date fm.liveswitch.telemetry.MediaStats.getTimestamp ( )

Gets the timestamp when these stats were generated.

◆ setNackCount()

void fm.liveswitch.telemetry.MediaStats.setNackCount ( long  value)

Sets the NACK count.

◆ setPliCount()

void fm.liveswitch.telemetry.MediaStats.setPliCount ( long  value)

Sets the PLI count.

◆ toJson() [1/2]

String fm.liveswitch.telemetry.MediaStats.toJson ( )

Serializes this to JSON.

◆ toJson() [2/2]

static String fm.liveswitch.telemetry.MediaStats.toJson ( fm.liveswitch.telemetry.MediaStats  outboundVideoStats)
static

Serializes outbound video stats to JSON.

Parameters
outboundVideoStatsThe outbound video stats.