Class MediaStats

Represents stats collected from the connection.

Inheritance

System.Object

MediaStats

Namespace: FM.LiveSwitch.Telemetry

Assembly: FM.LiveSwitch.dll

Syntax

public class MediaStats : object

Properties

AvailableOutgoingBitrate

Gets the available outgoing bitrate.

Declaration

public long AvailableOutgoingBitrate { get; }

Property Value

Type	Description
System.Int64

Detached

Gets if the media track is detached.

Declaration

public bool Detached { get; }

Property Value

Type	Description
System.Boolean

Direction

Gets the direction the media is being sent.

Declaration

public string Direction { get; }

Property Value

Type	Description
System.String

FrameHeight

Gets the height of the last encoded frame.

Declaration

public int FrameHeight { get; }

Property Value

Type	Description
System.Int32

FrameRate

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

Declaration

public double FrameRate { get; }

Property Value

Type	Description
System.Double

FrameWidth

Gets the width of the last encoded frame.

Declaration

public int FrameWidth { get; }

Property Value

Type	Description
System.Int32

MediaType

Gets the type of media.

Declaration

public string MediaType { get; }

Property Value

Type	Description
System.String

Muted

Gets if the media track is muted.

Declaration

public bool Muted { get; }

Property Value

Type	Description
System.Boolean

NackCount

Gets or sets the NACK count.

Declaration

public long NackCount { get; set; }

Property Value

Type	Description
System.Int64

PacketsLost

Gets the total packets lost.

Declaration

public int PacketsLost { get; }

Property Value

Type	Description
System.Int32

PercentLost

Gets the percent of packets lost.

Declaration

public double PercentLost { get; }

Property Value

Type	Description
System.Double

PliCount

Gets or sets the PLI count.

Declaration

public long PliCount { get; set; }

Property Value

Type	Description
System.Int64

QualityLimitationDurations

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

Declaration

public QualityLimitationDurations QualityLimitationDurations { get; }

Property Value

Type	Description
QualityLimitationDurations

QualityLimitationReason

Gets the the reason for quality limitation.

Declaration

public string QualityLimitationReason { get; }

Property Value

Type	Description
System.String

QualityLimitationResolutionChanges

Gets the count of resolution changes due to quality limitation.

Declaration

public long QualityLimitationResolutionChanges { get; }

Property Value

Type	Description
System.Int64

Stopped

Gets if the media track is stopped.

Declaration

public bool Stopped { get; }

Property Value

Type	Description
System.Boolean

TargetBitrate

Gets the target bitrate of the encoder.

Declaration

public int TargetBitrate { get; }

Property Value

Type	Description
System.Int32

Timestamp

Gets the timestamp when these stats were generated.

Declaration

public DateTime Timestamp { get; }

Property Value

Type	Description
DateTime

Methods

CreateOutboundAudioStreamStats(MediaStreamStats)

Create outbound audio stats.

Declaration

public static MediaStats CreateOutboundAudioStreamStats(MediaStreamStats audioStreamStats)

Parameters

Type	Name	Description
MediaStreamStats	audioStreamStats

Returns

Type	Description
MediaStats

CreateOutboundVideoStats(MediaStreamStats)

Create outbound video stats.

Declaration

public static MediaStats CreateOutboundVideoStats(MediaStreamStats videoStreamStats)

Parameters

Type	Name	Description
MediaStreamStats	videoStreamStats

Returns

Type	Description
MediaStats

FromJson(String)

Derializes media stats from JSON.

Declaration

public static MediaStats FromJson(string mediaStatsJson)

Parameters

Type	Name	Description
System.String	mediaStatsJson	The media stats JSON.

Returns

Type	Description
MediaStats

ToJson()

Serializes this to JSON.

Declaration

public string ToJson()

Returns

Type	Description
System.String

ToJson(MediaStats)

Serializes outbound video stats to JSON.

Declaration

public static string ToJson(MediaStats outboundVideoStats)

Parameters

Type	Name	Description
MediaStats	outboundVideoStats	The outbound video stats.

Returns

Type	Description
System.String