Search Results for

    / fm / liveswitch / CandidatePairStats

    Class: CandidatePairStats

    fm.liveswitch.CandidatePairStats

    Candidate pair stats.

    Hierarchy

    • BaseStats

      ↳ CandidatePairStats

    Implements

    • IEquivalent<CandidatePairStats>

    Table of contents

    Constructors

    • constructor

    Methods

    • deserializeProperties
    • fmliveswitchCandidatePairStatsInit
    • getBytesReceived
    • getBytesSent
    • getConsentRequestsReceived
    • getConsentRequestsSent
    • getConsentResponsesReceived
    • getConsentResponsesSent
    • getCurrentRoundTripTime
    • getId
    • getLocalCandidateId
    • getNominated
    • getPriority
    • getRemoteCandidateId
    • getRequestsReceived
    • getRequestsSent
    • getResponsesReceived
    • getResponsesSent
    • getState
    • getTimestamp
    • getTotalRoundTripTime
    • getTransportId
    • getTypeString
    • isEquivalent
    • serializeProperties
    • toJson
    • fromJson
    • fromJsonArray
    • toJson
    • toJsonArray

    Constructors

    constructor

    + new CandidatePairStats(): CandidatePairStats

    Initializes a new instance of the [[fm.liveswitch.candidatePairStats]] class.

    Returns: CandidatePairStats

    Inherited from: BaseStats

    Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairStats.ts:66

    Methods

    deserializeProperties

    ▸ ProtecteddeserializeProperties(key: string, valueJson: string): void

    Deserializes the properties.

    Parameters:

    Name Type Description
    key string The key.
    valueJson string The value in JSON format.

    Returns: void

    Overrides: BaseStats

    Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairStats.ts:154


    fmliveswitchCandidatePairStatsInit

    ▸ PrivatefmliveswitchCandidatePairStatsInit(): void

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairStats.ts:50


    getBytesReceived

    ▸ getBytesReceived(): number

    Gets the number of bytes received.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairStats.ts:224


    getBytesSent

    ▸ getBytesSent(): number

    Gets the number of bytes sent.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairStats.ts:236


    getConsentRequestsReceived

    ▸ getConsentRequestsReceived(): number

    Gets the number of consent requests received.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairStats.ts:248


    getConsentRequestsSent

    ▸ getConsentRequestsSent(): number

    Gets the number of consent requests sent.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairStats.ts:260


    getConsentResponsesReceived

    ▸ getConsentResponsesReceived(): number

    Gets the number of consent responses received.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairStats.ts:272


    getConsentResponsesSent

    ▸ getConsentResponsesSent(): number

    Gets the number of consent responses sent.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairStats.ts:284


    getCurrentRoundTripTime

    ▸ getCurrentRoundTripTime(): number

    Gets the current round trip time in milliseconds.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairStats.ts:296


    getId

    ▸ getId(): string

    Gets the identifier of the object generating these stats.

    Returns: string

    Inherited from: BaseStats

    Defined in: Generated/TypeScript/fm.liveswitch/BaseStats.ts:57


    getLocalCandidateId

    ▸ getLocalCandidateId(): string

    Gets the local candidate identifier.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairStats.ts:308


    getNominated

    ▸ getNominated(): boolean

    Gets whether the candidate pair is nominated.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairStats.ts:320


    getPriority

    ▸ getPriority(): number

    Gets the priority.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairStats.ts:332


    getRemoteCandidateId

    ▸ getRemoteCandidateId(): string

    Gets the remote candidate identifier.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairStats.ts:344


    getRequestsReceived

    ▸ getRequestsReceived(): number

    Gets the number of requests received.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairStats.ts:356


    getRequestsSent

    ▸ getRequestsSent(): number

    Gets the number of requests sent.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairStats.ts:368


    getResponsesReceived

    ▸ getResponsesReceived(): number

    Gets the number of responses received.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairStats.ts:380


    getResponsesSent

    ▸ getResponsesSent(): number

    Gets the number of responses sent.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairStats.ts:392


    getState

    ▸ getState(): CandidatePairState

    Gets the state.

    Returns: CandidatePairState

    Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairStats.ts:404


    getTimestamp

    ▸ getTimestamp(): DateTime

    Gets the timestamp when these stats were generated.

    Returns: DateTime

    Inherited from: BaseStats

    Defined in: Generated/TypeScript/fm.liveswitch/BaseStats.ts:70


    getTotalRoundTripTime

    ▸ getTotalRoundTripTime(): number

    Gets the total round trip time in milliseconds.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairStats.ts:416


    getTransportId

    ▸ getTransportId(): string

    Gets the transport identifier.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairStats.ts:428


    getTypeString

    ▸ getTypeString(): string

    Returns: string

    Overrides: BaseStats

    Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairStats.ts:10


    isEquivalent

    ▸ isEquivalent(instance: CandidatePairStats): boolean

    Checks if a candidate pair is equivalent to this one.

    Parameters:

    Name Type Description
    instance CandidatePairStats The candidate pair.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairStats.ts:441


    serializeProperties

    ▸ ProtectedserializeProperties(jsonObject: Hash<string, string>): void

    Serializes the properties.

    Parameters:

    Name Type Description
    jsonObject Hash<string, string> The JSON object.

    Returns: void

    Overrides: BaseStats

    Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairStats.ts:457


    toJson

    ▸ toJson(): string

    Serializes this to JSON.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairStats.ts:650


    fromJson

    ▸ StaticfromJson(candidatePairJson: string): CandidatePairStats

    Derializes candidate pair stats from JSON.

    Parameters:

    Name Type Description
    candidatePairJson string The candidate pair's stats JSON.

    Returns: CandidatePairStats

    Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairStats.ts:91


    fromJsonArray

    ▸ StaticfromJsonArray(candidatePairsJson: string): CandidatePairStats[]

    Derializes an array of candidate pair stats from JSON.

    Parameters:

    Name Type Description
    candidatePairsJson string The candidate pairs' stats JSON.

    Returns: CandidatePairStats[]

    Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairStats.ts:108


    toJson

    ▸ StatictoJson(candidatePair: CandidatePairStats): string

    Serializes candidate pair stats to JSON.

    Parameters:

    Name Type Description
    candidatePair CandidatePairStats The candidate pair's stats.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairStats.ts:125


    toJsonArray

    ▸ StatictoJsonArray(candidatePairs: CandidatePairStats[]): string

    Serializes an array of candidate pair stats to JSON.

    Parameters:

    Name Type Description
    candidatePairs CandidatePairStats[] The candidate pairs' stats.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairStats.ts:140

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