/ fm / liveswitch / CandidatePairInfo

Class: CandidatePairInfo

fm.liveswitch.CandidatePairInfo

Candidate pair information.

Hierarchy

• Info

  ↳ CandidatePairInfo

Table of contents

Constructors

• constructor

Methods

• deserializeProperties
• getId
• getLocalCandidateId
• getNominated
• getPriority
• getRemoteCandidateId
• getReport
• getState
• getTypeString
• serializeProperties
• setId
• setLocalCandidateId
• setNominated
• setPriority
• setRemoteCandidateId
• setReport
• setState
• toJson
• fromJson
• fromJsonArray
• processArray
• processBoolean
• processBooleanArray
• processDouble
• processFloat
• processFloatArray
• processInteger
• processIntegerArray
• processLong
• processLongArray
• processObject
• processShort
• processShortArray
• processString
• toJson
• toJsonArray

Constructors

constructor

+ new CandidatePairInfo(): CandidatePairInfo

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

Returns: CandidatePairInfo

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairInfo.ts:24

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

Parameters:

Name	Type
stats	CandidatePairStats
lastStats	CandidatePairStats

Returns: CandidatePairInfo

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairInfo.ts:31

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/CandidatePairInfo.ts:129

---

getId

▸ getId(): string

Gets the identifier.

Returns: string

Inherited from: Info

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

---

getLocalCandidateId

▸ getLocalCandidateId(): string

Gets the candidate pair's local candidate identifier.

Returns: string

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

---

getNominated

▸ getNominated(): boolean

Gets whether the candidate pair is nominated.

Returns: boolean

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

---

getPriority

▸ getPriority(): number

Gets the candidate pair priority.

Returns: number

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

---

getRemoteCandidateId

▸ getRemoteCandidateId(): string

Gets the candidate pair's remote candidate identifier.

Returns: string

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

---

getReport

▸ getReport(): CandidatePairReport

Gets whether the candidate pair report.

Returns: CandidatePairReport

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

---

getState

▸ getState(): string

Gets the candidate pair state.

Returns: string

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

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Info

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairInfo.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/CandidatePairInfo.ts:240

---

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

---

setLocalCandidateId

▸ setLocalCandidateId(value: string): void

Sets the candidate pair's local candidate identifier.

Parameters:

Name	Type
value	string

Returns: void

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

---

setNominated

▸ setNominated(value: boolean): void

Sets whether the candidate pair is nominated.

Parameters:

Name	Type
value	boolean

Returns: void

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

---

setPriority

▸ setPriority(value: number): void

Sets the candidate pair priority.

Parameters:

Name	Type
value	number

Returns: void

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

---

setRemoteCandidateId

▸ setRemoteCandidateId(value: string): void

Sets the candidate pair's remote candidate identifier.

Parameters:

Name	Type
value	string

Returns: void

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

---

setReport

▸ setReport(value: CandidatePairReport): void

Sets whether the candidate pair report.

Parameters:

Name	Type
value	CandidatePairReport

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairInfo.ts:318

---

setState

▸ setState(value: string): void

Sets the candidate pair state.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairInfo.ts:330

---

toJson

▸ toJson(): string

Serializes this instance to JSON.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairInfo.ts:342

---

fromJson

▸ StaticfromJson(instanceJson: string): CandidatePairInfo

Deserializes an instance from JSON.

Parameters:

Name	Type	Description
instanceJson	string	The instance JSON.

Returns: CandidatePairInfo

The deserialized instance.

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairInfo.ts:63

---

fromJsonArray

▸ StaticfromJsonArray(arrayJson: string): CandidatePairInfo[]

Derializes an array from JSON.

Parameters:

Name	Type	Description
arrayJson	string	The array JSON.

Returns: CandidatePairInfo[]

The deserialized array.

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

---

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(instance: CandidatePairInfo): string

Serializes an instance to JSON.

Parameters:

Name	Type	Description
instance	CandidatePairInfo	The instance.

Returns: string

The serialized instance JSON.

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairInfo.ts:99

---

toJsonArray

▸ StatictoJsonArray(array: CandidatePairInfo[]): string

Serializes an array to JSON.

Parameters:

Name	Type	Description
array	CandidatePairInfo[]	The array.

Returns: string

The serialized array JSON.

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairInfo.ts:115