/ fm / liveswitch / CandidatePairInfo

Class: CandidatePairInfo

fm.liveswitch.CandidatePairInfo

Candidate pair information.

Hierarchy

  • Info

    ↳ CandidatePairInfo

Table of contents

Constructors

Methods

Constructors

constructor

+ new CandidatePairInfo(): CandidatePairInfo

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

Returns: CandidatePairInfo

Inherited from: Info

+ new CandidatePairInfo(stats: CandidatePairStats, lastStats: CandidatePairStats): CandidatePairInfo

Parameters:

Name Type
stats CandidatePairStats
lastStats CandidatePairStats

Returns: CandidatePairInfo

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

fmliveswitchCandidatePairInfoInit

▸ PrivatefmliveswitchCandidatePairInfoInit(): void

Returns: void

getId

▸ getId(): string

Gets the identifier.

Returns: string

Inherited from: Info

getLocalCandidateId

▸ getLocalCandidateId(): string

Gets the candidate pair's local candidate identifier.

Returns: string

getNominated

▸ getNominated(): boolean

Gets whether the candidate pair is nominated.

Returns: boolean

getPriority

▸ getPriority(): number

Gets the candidate pair priority.

Returns: number

getRemoteCandidateId

▸ getRemoteCandidateId(): string

Gets the candidate pair's remote candidate identifier.

Returns: string

getReport

▸ getReport(): CandidatePairReport

Gets whether the candidate pair report.

Returns: CandidatePairReport

getState

▸ getState(): string

Gets the candidate pair state.

Returns: string

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Info

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

setId

▸ setId(value: string): void

Sets the identifier.

Parameters:

Name Type
value string

Returns: void

Inherited from: Info

setLocalCandidateId

▸ setLocalCandidateId(value: string): void

Sets the candidate pair's local candidate identifier.

Parameters:

Name Type
value string

Returns: void

setNominated

▸ setNominated(value: boolean): void

Sets whether the candidate pair is nominated.

Parameters:

Name Type
value boolean

Returns: void

setPriority

▸ setPriority(value: number): void

Sets the candidate pair priority.

Parameters:

Name Type
value number

Returns: void

setRemoteCandidateId

▸ setRemoteCandidateId(value: string): void

Sets the candidate pair's remote candidate identifier.

Parameters:

Name Type
value string

Returns: void

setReport

▸ setReport(value: CandidatePairReport): void

Sets whether the candidate pair report.

Parameters:

Name Type
value CandidatePairReport

Returns: void

setState

▸ setState(value: string): void

Sets the candidate pair state.

Parameters:

Name Type
value string

Returns: void

toJson

▸ toJson(): string

Serializes this instance to JSON.

Returns: string

fromJson

▸ StaticfromJson(instanceJson: string): CandidatePairInfo

Deserializes an instance from JSON.

Parameters:

Name Type Description
instanceJson string The instance JSON.

Returns: CandidatePairInfo

The deserialized instance.

fromJsonArray

▸ StaticfromJsonArray(arrayJson: string): CandidatePairInfo[]

Derializes an array from JSON.

Parameters:

Name Type Description
arrayJson string The array JSON.

Returns: CandidatePairInfo[]

The deserialized array.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

toJson

▸ StatictoJson(instance: CandidatePairInfo): string

Serializes an instance to JSON.

Parameters:

Name Type Description
instance CandidatePairInfo The instance.

Returns: string

The serialized instance JSON.

toJsonArray

▸ StatictoJsonArray(array: CandidatePairInfo[]): string

Serializes an array to JSON.

Parameters:

Name Type Description
array CandidatePairInfo[] The array.

Returns: string

The serialized array JSON.