Search Results for

    / fm / liveswitch / CandidateStats

    Class: CandidateStats

    fm.liveswitch.CandidateStats

    Candidate stats.

    Hierarchy

    • BaseStats

      ↳ CandidateStats

    Implements

    • IEquivalent<CandidateStats>

    Table of contents

    Constructors

    • constructor

    Methods

    • deserializeProperties
    • fmliveswitchCandidateStatsInit
    • getIPAddress
    • getId
    • getIsHost
    • getIsReflexive
    • getIsRelayed
    • getPort
    • getPriority
    • getProtocol
    • getRelatedIPAddress
    • getRelatedPort
    • getRelayProtocol
    • getTimestamp
    • getTurnProtocol
    • getType
    • getTypeString
    • isEquivalent
    • serializeProperties
    • toJson
    • fromJson
    • fromJsonArray
    • toJson
    • toJsonArray

    Constructors

    constructor

    + new CandidateStats(): CandidateStats

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

    Returns: CandidateStats

    Inherited from: BaseStats

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateStats.ts:35

    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/CandidateStats.ts:127


    fmliveswitchCandidateStatsInit

    ▸ PrivatefmliveswitchCandidateStatsInit(): void

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateStats.ts:30


    getIPAddress

    ▸ getIPAddress(): string

    Gets the IP address.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateStats.ts:167


    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


    getIsHost

    ▸ getIsHost(): boolean

    Gets whether the candidate is host/local.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateStats.ts:179


    getIsReflexive

    ▸ getIsReflexive(): boolean

    Gets whether the candidate is reflexive.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateStats.ts:191


    getIsRelayed

    ▸ getIsRelayed(): boolean

    Gets whether the candidate is relayed.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateStats.ts:203


    getPort

    ▸ getPort(): number

    Gets the port.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateStats.ts:215


    getPriority

    ▸ getPriority(): number

    Gets the priority.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateStats.ts:227


    getProtocol

    ▸ getProtocol(): ProtocolType

    Gets the protocol.

    Returns: ProtocolType

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateStats.ts:239


    getRelatedIPAddress

    ▸ getRelatedIPAddress(): string

    Gets the related IP address.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateStats.ts:251


    getRelatedPort

    ▸ getRelatedPort(): number

    Gets the related port.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateStats.ts:263


    getRelayProtocol

    ▸ getRelayProtocol(): ProtocolType

    Gets the relay protocol.

    Returns: ProtocolType

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateStats.ts:275


    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


    getTurnProtocol

    ▸ getTurnProtocol(): ProtocolType

    Gets the relay protocol.

    deprecated Use RelayProtocol instead.

    Returns: ProtocolType

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateStats.ts:288


    getType

    ▸ getType(): CandidateType

    Gets the type.

    Returns: CandidateType

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateStats.ts:300


    getTypeString

    ▸ getTypeString(): string

    Returns: string

    Overrides: BaseStats

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


    isEquivalent

    ▸ isEquivalent(instance: CandidateStats): boolean

    Checks if a candidate is equivalent to this one.

    Parameters:

    Name Type Description
    instance CandidateStats The candidate.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateStats.ts:313


    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/CandidateStats.ts:329


    toJson

    ▸ toJson(): string

    Serializes this to JSON.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateStats.ts:426


    fromJson

    ▸ StaticfromJson(candidateJson: string): CandidateStats

    Derializes candidate stats from JSON.

    Parameters:

    Name Type Description
    candidateJson string The candidate's stats JSON.

    Returns: CandidateStats

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateStats.ts:64


    fromJsonArray

    ▸ StaticfromJsonArray(candidatesJson: string): CandidateStats[]

    Derializes an array of candidate stats from JSON.

    Parameters:

    Name Type Description
    candidatesJson string The candidates' stats JSON.

    Returns: CandidateStats[]

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateStats.ts:81


    toJson

    ▸ StatictoJson(candidate: CandidateStats): string

    Serializes candidate stats to JSON.

    Parameters:

    Name Type Description
    candidate CandidateStats The candidate's stats.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateStats.ts:98


    toJsonArray

    ▸ StatictoJsonArray(candidates: CandidateStats[]): string

    Serializes an array of candidate stats to JSON.

    Parameters:

    Name Type Description
    candidates CandidateStats[] The candidates' stats.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateStats.ts:113

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