Search Results for

    / fm / liveswitch / TransportInfo

    Class: TransportInfo

    fm.liveswitch.TransportInfo

    Transport Information.

    Hierarchy

    • Info

      ↳ TransportInfo

    Table of contents

    Constructors

    • constructor

    Methods

    • deserializeProperties
    • getActiveCandidatePairId
    • getCandidatePairs
    • getId
    • getLocalCandidates
    • getLocalCertificate
    • getRemoteCandidates
    • getRemoteCertificate
    • getReport
    • getTypeString
    • serializeProperties
    • setActiveCandidatePairId
    • setCandidatePairs
    • setId
    • setLocalCandidates
    • setLocalCertificate
    • setRemoteCandidates
    • setRemoteCertificate
    • setReport
    • toJson
    • fromJson
    • fromJsonArray
    • processArray
    • processBoolean
    • processBooleanArray
    • processDouble
    • processFloat
    • processFloatArray
    • processInteger
    • processIntegerArray
    • processLong
    • processLongArray
    • processObject
    • processShort
    • processShortArray
    • processString
    • toJson
    • toJsonArray

    Constructors

    constructor

    + new TransportInfo(): TransportInfo

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

    Returns: TransportInfo

    Inherited from: Info

    Defined in: Generated/TypeScript/fm.liveswitch/TransportInfo.ts:26

    + new TransportInfo(stats: TransportStats, lastStats: TransportStats): TransportInfo

    Parameters:

    Name Type
    stats TransportStats
    lastStats TransportStats

    Returns: TransportInfo

    Defined in: Generated/TypeScript/fm.liveswitch/TransportInfo.ts:33

    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: Info

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


    getActiveCandidatePairId

    ▸ getActiveCandidatePairId(): string

    Gets the active candidate pair identifier.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/TransportInfo.ts:234


    getCandidatePairs

    ▸ getCandidatePairs(): CandidatePairInfo[]

    Gets the candidate pairs.

    Returns: CandidatePairInfo[]

    Defined in: Generated/TypeScript/fm.liveswitch/TransportInfo.ts:246


    getId

    ▸ getId(): string

    Gets the identifier.

    Returns: string

    Inherited from: Info

    Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:336


    getLocalCandidates

    ▸ getLocalCandidates(): CandidateInfo[]

    Gets the local candidates.

    Returns: CandidateInfo[]

    Defined in: Generated/TypeScript/fm.liveswitch/TransportInfo.ts:258


    getLocalCertificate

    ▸ getLocalCertificate(): CertificateInfo

    Gets the local certificate.

    Returns: CertificateInfo

    Defined in: Generated/TypeScript/fm.liveswitch/TransportInfo.ts:270


    getRemoteCandidates

    ▸ getRemoteCandidates(): CandidateInfo[]

    Gets the remote candidates.

    Returns: CandidateInfo[]

    Defined in: Generated/TypeScript/fm.liveswitch/TransportInfo.ts:282


    getRemoteCertificate

    ▸ getRemoteCertificate(): CertificateInfo

    Gets the remote certificate.

    Returns: CertificateInfo

    Defined in: Generated/TypeScript/fm.liveswitch/TransportInfo.ts:294


    getReport

    ▸ getReport(): TransportReport

    Gets the transport report.

    Returns: TransportReport

    Defined in: Generated/TypeScript/fm.liveswitch/TransportInfo.ts:306


    getTypeString

    ▸ getTypeString(): string

    Returns: string

    Overrides: Info

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


    serializeProperties

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

    Serializes the properties.

    Parameters:

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

    Returns: void

    Overrides: Info

    Defined in: Generated/TypeScript/fm.liveswitch/TransportInfo.ts:319


    setActiveCandidatePairId

    ▸ setActiveCandidatePairId(value: string): void

    Sets the active candidate pair identifier.

    Parameters:

    Name Type
    value string

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/TransportInfo.ts:352


    setCandidatePairs

    ▸ setCandidatePairs(value: CandidatePairInfo[]): void

    Sets the candidate pairs.

    Parameters:

    Name Type
    value CandidatePairInfo[]

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/TransportInfo.ts:364


    setId

    ▸ setId(value: string): void

    Sets the identifier.

    Parameters:

    Name Type
    value string

    Returns: void

    Inherited from: Info

    Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:363


    setLocalCandidates

    ▸ setLocalCandidates(value: CandidateInfo[]): void

    Sets the local candidates.

    Parameters:

    Name Type
    value CandidateInfo[]

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/TransportInfo.ts:376


    setLocalCertificate

    ▸ setLocalCertificate(value: CertificateInfo): void

    Sets the local certificate.

    Parameters:

    Name Type
    value CertificateInfo

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/TransportInfo.ts:388


    setRemoteCandidates

    ▸ setRemoteCandidates(value: CandidateInfo[]): void

    Sets the remote candidates.

    Parameters:

    Name Type
    value CandidateInfo[]

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/TransportInfo.ts:400


    setRemoteCertificate

    ▸ setRemoteCertificate(value: CertificateInfo): void

    Sets the remote certificate.

    Parameters:

    Name Type
    value CertificateInfo

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/TransportInfo.ts:412


    setReport

    ▸ setReport(value: TransportReport): void

    Sets the transport report.

    Parameters:

    Name Type
    value TransportReport

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/TransportInfo.ts:424


    toJson

    ▸ toJson(): string

    Serializes this instance to Json.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/TransportInfo.ts:436


    fromJson

    ▸ StaticfromJson(transportReportJson: string): TransportInfo

    Deserializes Json to a TransportReport.

    Parameters:

    Name Type Description
    transportReportJson string The serialized Json.

    Returns: TransportInfo

    The deserialized TransportReport.

    Defined in: Generated/TypeScript/fm.liveswitch/TransportInfo.ts:101


    fromJsonArray

    ▸ StaticfromJsonArray(transportInfosJson: string): TransportInfo[]

    Deserializes an array from JSON.

    Parameters:

    Name Type Description
    transportInfosJson string The serialized JSON.

    Returns: TransportInfo[]

    The deserialized array.

    Defined in: Generated/TypeScript/fm.liveswitch/TransportInfo.ts:119


    processArray

    ▸ StaticprocessArray<T>(newValues: T[], oldValues: T[]): T[]

    Processes an array for an info.

    Type parameters:

    Name Type
    T IEquivalent<T, T>

    Parameters:

    Name Type Description
    newValues T[] The new values.
    oldValues T[] The old values.

    Returns: T[]

    The new values, if the new values are not equivalent to the old values; otherwise null.

    Inherited from: Info

    Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:34


    processBoolean

    ▸ StaticprocessBoolean(newValue: boolean, oldValue: boolean): boolean

    Processes a boolean for an info.

    Parameters:

    Name Type Description
    newValue boolean The new value.
    oldValue boolean The old value.

    Returns: boolean

    The new value, if the new value does not equal the old value; otherwise null.

    Inherited from: Info

    Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:60


    processBooleanArray

    ▸ StaticprocessBooleanArray(newValues: boolean[], oldValues: boolean[]): boolean[]

    Processes a boolean array for an info.

    Parameters:

    Name Type Description
    newValues boolean[] The new values.
    oldValues boolean[] The old values.

    Returns: boolean[]

    The new values, if the new values do not equal the old values; otherwise null.

    Inherited from: Info

    Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:75


    processDouble

    ▸ StaticprocessDouble(newValue: number, oldValue: number): number

    Processes a double for an info.

    Parameters:

    Name Type Description
    newValue number The new value.
    oldValue number The old value.

    Returns: number

    The new value, if the new value does not equal the old value; otherwise null.

    Inherited from: Info

    Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:101


    processFloat

    ▸ StaticprocessFloat(newValue: number, oldValue: number): number

    Processes a float for an info.

    Parameters:

    Name Type Description
    newValue number The new value.
    oldValue number The old value.

    Returns: number

    The new value, if the new value does not equal the old value; otherwise null.

    Inherited from: Info

    Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:116


    processFloatArray

    ▸ StaticprocessFloatArray(newValues: number[], oldValues: number[]): number[]

    Processes a float array for an info.

    Parameters:

    Name Type Description
    newValues number[] The new values.
    oldValues number[] The old values.

    Returns: number[]

    The new values, if the new values do not equal the old values; otherwise null.

    Inherited from: Info

    Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:131


    processInteger

    ▸ StaticprocessInteger(newValue: number, oldValue: number): number

    Processes an integer for an info.

    Parameters:

    Name Type Description
    newValue number The new value.
    oldValue number The old value.

    Returns: number

    The new value, if the new value does not equal the old value; otherwise null.

    Inherited from: Info

    Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:157


    processIntegerArray

    ▸ StaticprocessIntegerArray(newValues: number[], oldValues: number[]): number[]

    Processes a integer array for an info.

    Parameters:

    Name Type Description
    newValues number[] The new values.
    oldValues number[] The old values.

    Returns: number[]

    The new values, if the new values do not equal the old values; otherwise null.

    Inherited from: Info

    Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:174


    processLong

    ▸ StaticprocessLong(newValue: number, oldValue: number): number

    Processes a long for an info.

    Parameters:

    Name Type Description
    newValue number The new value.
    oldValue number The old value.

    Returns: number

    The new value, if the new value does not equal the old value; otherwise null.

    Inherited from: Info

    Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:200


    processLongArray

    ▸ StaticprocessLongArray(newValues: number[], oldValues: number[]): number[]

    Processes a long array for an info.

    Parameters:

    Name Type Description
    newValues number[] The new values.
    oldValues number[] The old values.

    Returns: number[]

    The new values, if the new values do not equal the old values; otherwise null.

    Inherited from: Info

    Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:217


    processObject

    ▸ StaticprocessObject<T>(newValue: T, oldValue: T): T

    Processes an object for an info.

    Type parameters:

    Name Type
    T Object & IEquivalent<T, T>

    Parameters:

    Name Type Description
    newValue T The new value.
    oldValue T The old value.

    Returns: T

    The new value, if the new value does not equal the old value; otherwise null.

    Inherited from: Info

    Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:243


    processShort

    ▸ StaticprocessShort(newValue: number, oldValue: number): number

    Processes a short for an info.

    Parameters:

    Name Type Description
    newValue number The new value.
    oldValue number The old value.

    Returns: number

    The new value, if the new value does not equal the old value; otherwise null.

    Inherited from: Info

    Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:264


    processShortArray

    ▸ StaticprocessShortArray(newValues: number[], oldValues: number[]): number[]

    Processes a short array for an info.

    Parameters:

    Name Type Description
    newValues number[] The new values.
    oldValues number[] The old values.

    Returns: number[]

    The new values, if the new values do not equal the old values; otherwise null.

    Inherited from: Info

    Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:281


    processString

    ▸ StaticprocessString(newValue: string, oldValue: string): string

    Processes a string for an info.

    Parameters:

    Name Type Description
    newValue string The new value.
    oldValue string The old value.

    Returns: string

    The new value, if the new value does not equal the old value; otherwise null.

    Inherited from: Info

    Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:307


    toJson

    ▸ StatictoJson(transportReport: TransportInfo): string

    Serializes an instance to Json.

    Parameters:

    Name Type Description
    transportReport TransportInfo The instance to serialize.

    Returns: string

    Serialized Json.

    Defined in: Generated/TypeScript/fm.liveswitch/TransportInfo.ts:137


    toJsonArray

    ▸ StatictoJsonArray(transportInfos: TransportInfo[]): string

    Serializes an array to JSON.

    Parameters:

    Name Type Description
    transportInfos TransportInfo[] The array to serialize.

    Returns: string

    The serialized JSON.

    Defined in: Generated/TypeScript/fm.liveswitch/TransportInfo.ts:153

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