Search Results for

    Show / Hide Table of Contents

    Class CandidatePairStats

    Candidate pair stats.

    Inheritance
    System.Object
    BaseStats
    CandidatePairStats
    Implements
    IEquivalent<CandidatePairStats>
    Inherited Members
    BaseStats.Id
    BaseStats.Timestamp
    Namespace: FM.LiveSwitch
    Assembly: FM.LiveSwitch.dll
    Syntax
    public class CandidatePairStats : BaseStats, IEquivalent<CandidatePairStats>

    Constructors

    CandidatePairStats()

    Initializes a new instance of the CandidatePairStats class.

    Declaration
    public CandidatePairStats()

    Properties

    BytesReceived

    Gets the number of bytes received.

    Declaration
    public long BytesReceived { get; }
    Property Value
    Type Description
    System.Int64

    BytesSent

    Gets the number of bytes sent.

    Declaration
    public long BytesSent { get; }
    Property Value
    Type Description
    System.Int64

    ConsentRequestsReceived

    Gets the number of consent requests received.

    Declaration
    public long ConsentRequestsReceived { get; }
    Property Value
    Type Description
    System.Int64

    ConsentRequestsSent

    Gets the number of consent requests sent.

    Declaration
    public long ConsentRequestsSent { get; }
    Property Value
    Type Description
    System.Int64

    ConsentResponsesReceived

    Gets the number of consent responses received.

    Declaration
    public long ConsentResponsesReceived { get; }
    Property Value
    Type Description
    System.Int64

    ConsentResponsesSent

    Gets the number of consent responses sent.

    Declaration
    public long ConsentResponsesSent { get; }
    Property Value
    Type Description
    System.Int64

    CurrentRoundTripTime

    Gets the current round trip time in milliseconds.

    Declaration
    public int CurrentRoundTripTime { get; }
    Property Value
    Type Description
    System.Int32

    LocalCandidateId

    Gets the local candidate identifier.

    Declaration
    public string LocalCandidateId { get; }
    Property Value
    Type Description
    System.String

    Nominated

    Gets whether the candidate pair is nominated.

    Declaration
    public bool Nominated { get; }
    Property Value
    Type Description
    System.Boolean

    Priority

    Gets the priority.

    Declaration
    public long Priority { get; }
    Property Value
    Type Description
    System.Int64

    RemoteCandidateId

    Gets the remote candidate identifier.

    Declaration
    public string RemoteCandidateId { get; }
    Property Value
    Type Description
    System.String

    RequestsReceived

    Gets the number of requests received.

    Declaration
    public long RequestsReceived { get; }
    Property Value
    Type Description
    System.Int64

    RequestsSent

    Gets the number of requests sent.

    Declaration
    public long RequestsSent { get; }
    Property Value
    Type Description
    System.Int64

    ResponsesReceived

    Gets the number of responses received.

    Declaration
    public long ResponsesReceived { get; }
    Property Value
    Type Description
    System.Int64

    ResponsesSent

    Gets the number of responses sent.

    Declaration
    public long ResponsesSent { get; }
    Property Value
    Type Description
    System.Int64

    State

    Gets the state.

    Declaration
    public CandidatePairState State { get; }
    Property Value
    Type Description
    CandidatePairState

    TotalRoundTripTime

    Gets the total round trip time in milliseconds.

    Declaration
    public int TotalRoundTripTime { get; }
    Property Value
    Type Description
    System.Int32

    TransportId

    Gets the transport identifier.

    Declaration
    public string TransportId { get; }
    Property Value
    Type Description
    System.String

    Methods

    DeserializeProperties(String, String)

    Deserializes the properties.

    Declaration
    protected override void DeserializeProperties(string key, string valueJson)
    Parameters
    Type Name Description
    System.String key

    The key.

    System.String valueJson

    The value in JSON format.

    Overrides
    BaseStats.DeserializeProperties(String, String)

    FromJson(String)

    Derializes candidate pair stats from JSON.

    Declaration
    public static CandidatePairStats FromJson(string candidatePairJson)
    Parameters
    Type Name Description
    System.String candidatePairJson

    The candidate pair's stats JSON.

    Returns
    Type Description
    CandidatePairStats

    FromJsonArray(String)

    Derializes an array of candidate pair stats from JSON.

    Declaration
    public static CandidatePairStats[] FromJsonArray(string candidatePairsJson)
    Parameters
    Type Name Description
    System.String candidatePairsJson

    The candidate pairs' stats JSON.

    Returns
    Type Description
    CandidatePairStats[]

    IsEquivalent(CandidatePairStats)

    Checks if a candidate pair is equivalent to this one.

    Declaration
    public bool IsEquivalent(CandidatePairStats instance)
    Parameters
    Type Name Description
    CandidatePairStats instance

    The candidate pair.

    Returns
    Type Description
    System.Boolean

    SerializeProperties(Dictionary<String, String>)

    Serializes the properties.

    Declaration
    protected override void SerializeProperties(Dictionary<string, string> jsonObject)
    Parameters
    Type Name Description
    Dictionary<System.String, System.String> jsonObject

    The JSON object.

    Overrides
    BaseStats.SerializeProperties(Dictionary<String, String>)

    ToJson()

    Serializes this to JSON.

    Declaration
    public string ToJson()
    Returns
    Type Description
    System.String

    ToJson(CandidatePairStats)

    Serializes candidate pair stats to JSON.

    Declaration
    public static string ToJson(CandidatePairStats candidatePair)
    Parameters
    Type Name Description
    CandidatePairStats candidatePair

    The candidate pair's stats.

    Returns
    Type Description
    System.String

    ToJsonArray(CandidatePairStats[])

    Serializes an array of candidate pair stats to JSON.

    Declaration
    public static string ToJsonArray(CandidatePairStats[] candidatePairs)
    Parameters
    Type Name Description
    CandidatePairStats[] candidatePairs

    The candidate pairs' stats.

    Returns
    Type Description
    System.String

    Implements

    IEquivalent<T>
    In This Article
    Back to top Copyright © LiveSwitch Inc. All Rights Reserved. Doc build for LiveSwitch v1.15.0