/ fm / liveswitch / StreamInfo
Class: StreamInfo
fm.liveswitch.StreamInfo
Stream information.
Hierarchy
-
↳ StreamInfo
Table of contents
Constructors
Methods
- deserializeProperties
- getId
- getTag
- getTransportId
- getTypeString
- serializeProperties
- setId
- setTag
- setTransportId
- processArray
- processBoolean
- processBooleanArray
- processDouble
- processFloat
- processFloatArray
- processInteger
- processIntegerArray
- processLong
- processLongArray
- processObject
- processShort
- processShortArray
- processString
Constructors
constructor
+ new StreamInfo(): StreamInfo
Returns: StreamInfo
Inherited from: Info
Defined in: Generated/TypeScript/fm.liveswitch/StreamInfo.ts:16
Methods
deserializeProperties
▸ Protected
deserializeProperties(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/StreamInfo.ts:36
getId
▸ getId(): string
Gets the identifier.
Returns: string
Inherited from: Info
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:336
getTag
▸ getTag(): string
Gets the tag.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/StreamInfo.ts:58
getTransportId
▸ getTransportId(): string
Gets the transport id.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/StreamInfo.ts:70
getTypeString
▸ getTypeString(): string
Returns: string
Overrides: Info
Defined in: Generated/TypeScript/fm.liveswitch/StreamInfo.ts:10
serializeProperties
▸ Protected
serializeProperties(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/StreamInfo.ts:83
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
setTag
▸ setTag(value
: string): void
Sets the tag.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/StreamInfo.ts:101
setTransportId
▸ setTransportId(value
: string): void
Sets the transport id.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/StreamInfo.ts:113
processArray
▸ Static
processArray<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
▸ Static
processBoolean(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
▸ Static
processBooleanArray(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
▸ Static
processDouble(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
▸ Static
processFloat(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
▸ Static
processFloatArray(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
▸ Static
processInteger(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
▸ Static
processIntegerArray(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
▸ Static
processLong(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
▸ Static
processLongArray(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
▸ Static
processObject<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
▸ Static
processShort(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
▸ Static
processShortArray(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
▸ Static
processString(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