fm.liveswitch.MediaTrackStats Class Reference

Media track stats. More...

Public Member Functions
int	getBitrate ()
	Gets the bitrate. More...
boolean	getDetached ()
	Gets whether the track is detached. More...
double	getExpectedFrameRate ()
	Gets the expected frame rate. More...
int	getFrameHeight ()
	Gets the frame height. More...
double	getFrameRate ()
	Gets the number of decoded frames in the last second. More...
long	getFramesCorrupted ()
	Gets the number of corrupted frames. More...
long	getFramesDecoded ()
	Gets the number of frames decoded. More...
long	getFramesDropped ()
	Gets the number of frames dropped. More...
long	getFramesEncoded ()
	Gets the number of frames encoded. More...
long	getFramesReceived ()
	Gets the number of frames received. More...
long	getFramesSent ()
	Gets the number of frames sent. More...
int	getFrameWidth ()
	Gets the frame width. More...
int	getMaxBitrate ()
	Gets the maximum bitrate. More...
double	getMediaQuality (boolean audio)
	Gets the track's estimated media quality. More...
int	getMinBitrate ()
	Gets the minimum bitrate. More...
boolean	getMuted ()
	Gets whether the track is muted. More...
String	getRepairedRtpStreamId ()
	Gets the first repaired RTP stream identifier. More...
String[]	getRepairedRtpStreamIds ()
	Gets the repaired RTP stream identifiers. More...
String	getRtpStreamId ()
	Gets the first RTP stream identifier. More...
String[]	getRtpStreamIds ()
	Gets the RTP stream identifiers. More...
boolean	getStopped ()
	Gets whether the track is stopped. More...
long	getSynchronizationSource ()
	Gets the first synchronization source. More...
long[]	getSynchronizationSources ()
	Gets the synchronization sources. More...
boolean	isEquivalent (fm.liveswitch.MediaTrackStats instance)
	Checks if a track is equivalent to this one. More...
	MediaTrackStats ()
String	toJson ()
	Serializes this to JSON. 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.MediaTrackStats >
abstract boolean	isEquivalent (T instance)
	Checks if an instance is equivalent to this one. More...

Static Public Member Functions
static fm.liveswitch.MediaTrackStats	fromJson (String mediaTrackJson)
	Derializes media track stats from JSON. More...
static fm.liveswitch.MediaTrackStats[]	fromJsonArray (String mediaTracksJson)
	Derializes an array of media track stats from JSON. More...
static String	toJson (fm.liveswitch.MediaTrackStats mediaTrack)
	Serializes media track stats to JSON. More...
static String	toJsonArray (fm.liveswitch.MediaTrackStats[] mediaTracks)
	Serializes an array of media track stats 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.BaseStats
	BaseStats ()

Detailed Description

Media track stats.

Constructor & Destructor Documentation

MediaTrackStats()

fm.liveswitch.MediaTrackStats.MediaTrackStats

(

)

Member Function Documentation

deserializeProperties()

void fm.liveswitch.MediaTrackStats.deserializeProperties ( String  key, String  valueJson  )

protected

Deserializes the properties.

Parameters

key	The key.
valueJson	The value in JSON format.

Reimplemented from fm.liveswitch.BaseStats.

fromJson()

static fm.liveswitch.MediaTrackStats fm.liveswitch.MediaTrackStats.fromJson ( String  mediaTrackJson )

static

Derializes media track stats from JSON.

Parameters

mediaTrackJson

The media track's stats JSON.

fromJsonArray()

static fm.liveswitch.MediaTrackStats [] fm.liveswitch.MediaTrackStats.fromJsonArray ( String  mediaTracksJson )

static

Derializes an array of media track stats from JSON.

Parameters

mediaTracksJson

The media tracks' stats JSON.

getBitrate()

int fm.liveswitch.MediaTrackStats.getBitrate

(

)

Gets the bitrate.

Set by the encoder.

getDetached()

boolean fm.liveswitch.MediaTrackStats.getDetached

(

)

Gets whether the track is detached.

getExpectedFrameRate()

double fm.liveswitch.MediaTrackStats.getExpectedFrameRate

(

)

Gets the expected frame rate.

Video-only. Set by the stream.

getFrameHeight()

int fm.liveswitch.MediaTrackStats.getFrameHeight

(

)

Gets the frame height.

Video-only. Set by the encoder or decoder.

getFrameRate()

double fm.liveswitch.MediaTrackStats.getFrameRate

(

)

Gets the number of decoded frames in the last second.

Video-only. Set by the encoder or decoder.

getFramesCorrupted()

long fm.liveswitch.MediaTrackStats.getFramesCorrupted

(

)

Gets the number of corrupted frames.

Video-only. Set by the depacketizer.

getFramesDecoded()

long fm.liveswitch.MediaTrackStats.getFramesDecoded

(

)

Gets the number of frames decoded.

Set by the decoder.

getFramesDropped()

long fm.liveswitch.MediaTrackStats.getFramesDropped

(

)

Gets the number of frames dropped.

Video-only. Set by the depacketizer.

getFramesEncoded()

long fm.liveswitch.MediaTrackStats.getFramesEncoded

(

)

Gets the number of frames encoded.

Set by the encoder.

getFramesReceived()

long fm.liveswitch.MediaTrackStats.getFramesReceived

(

)

Gets the number of frames received.

Set by the depacketizer.

getFramesSent()

long fm.liveswitch.MediaTrackStats.getFramesSent

(

)

Gets the number of frames sent.

Set by the packetizer.

getFrameWidth()

int fm.liveswitch.MediaTrackStats.getFrameWidth

(

)

Gets the frame width.

Video-only. Set by the encoder or decoder.

getMaxBitrate()

int fm.liveswitch.MediaTrackStats.getMaxBitrate

(

)

Gets the maximum bitrate.

Set by the encoder.

getMediaQuality()

double fm.liveswitch.MediaTrackStats.getMediaQuality

(

boolean

audio

)

Gets the track'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

audio

Whether these are audio stats.

getMinBitrate()

int fm.liveswitch.MediaTrackStats.getMinBitrate

(

)

Gets the minimum bitrate.

Set by the encoder.

getMuted()

boolean fm.liveswitch.MediaTrackStats.getMuted

(

)

Gets whether the track is muted.

getRepairedRtpStreamId()

String fm.liveswitch.MediaTrackStats.getRepairedRtpStreamId

(

)

Gets the first repaired RTP stream identifier.

getRepairedRtpStreamIds()

String [] fm.liveswitch.MediaTrackStats.getRepairedRtpStreamIds

(

)

Gets the repaired RTP stream identifiers.

getRtpStreamId()

String fm.liveswitch.MediaTrackStats.getRtpStreamId

(

)

Gets the first RTP stream identifier.

getRtpStreamIds()

String [] fm.liveswitch.MediaTrackStats.getRtpStreamIds

(

)

Gets the RTP stream identifiers.

getStopped()

boolean fm.liveswitch.MediaTrackStats.getStopped

(

)

Gets whether the track is stopped.

Set by source.

getSynchronizationSource()

long fm.liveswitch.MediaTrackStats.getSynchronizationSource

(

)

Gets the first synchronization source.

getSynchronizationSources()

long [] fm.liveswitch.MediaTrackStats.getSynchronizationSources

(

)

Gets the synchronization sources.

isEquivalent()

boolean fm.liveswitch.MediaTrackStats.isEquivalent

(

fm.liveswitch.MediaTrackStats

instance

)

Checks if a track is equivalent to this one.

Parameters

instance

The track.

serializeProperties()

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

protected

Serializes the properties.

Parameters

jsonObject

The JSON object.

Reimplemented from fm.liveswitch.BaseStats.

toJson() [1/2]

String fm.liveswitch.MediaTrackStats.toJson

(

)

Serializes this to JSON.

toJson() [2/2]

static String fm.liveswitch.MediaTrackStats.toJson ( fm.liveswitch.MediaTrackStats  mediaTrack )

static

Serializes media track stats to JSON.

Parameters

mediaTrack

The media track's stats.

toJsonArray()

static String fm.liveswitch.MediaTrackStats.toJsonArray ( fm.liveswitch.MediaTrackStats[]  mediaTracks )

static

Serializes an array of media track stats to JSON.

Parameters

mediaTracks

The media tracks' stats.