/ fm / liveswitch / DataStreamInfo

Class: DataStreamInfo

fm.liveswitch.DataStreamInfo

Data stream information.

Hierarchy

• StreamInfo

  ↳ DataStreamInfo

Table of contents

Constructors

• constructor

Methods

• deserializeProperties
• getChannels
• getId
• getReport
• getTag
• getTransportId
• getTypeString
• serializeProperties
• setChannels
• setId
• setReport
• setTag
• setTransportId
• toJson
• fromJson
• fromJsonArray
• processArray
• processBoolean
• processBooleanArray
• processDouble
• processFloat
• processFloatArray
• processInteger
• processIntegerArray
• processLong
• processLongArray
• processObject
• processShort
• processShortArray
• processString
• toJson
• toJsonArray

Constructors

constructor

+ new DataStreamInfo(): DataStreamInfo

Returns: DataStreamInfo

Inherited from: StreamInfo

Defined in: Generated/TypeScript/fm.liveswitch/DataStreamInfo.ts:16

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

Defined in: Generated/TypeScript/fm.liveswitch/DataStreamInfo.ts:102

---

getChannels

▸ getChannels(): DataChannelInfo[]

Gets the data stream channels.

Returns: DataChannelInfo[]

Defined in: Generated/TypeScript/fm.liveswitch/DataStreamInfo.ts:124

---

getId

▸ getId(): string

Gets the identifier.

Returns: string

Inherited from: StreamInfo

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

---

getReport

▸ getReport(): DataStreamReport

Gets the data stream report.

Returns: DataStreamReport

Defined in: Generated/TypeScript/fm.liveswitch/DataStreamInfo.ts:136

---

getTag

▸ getTag(): string

Gets the tag.

Returns: string

Inherited from: StreamInfo

Defined in: Generated/TypeScript/fm.liveswitch/StreamInfo.ts:58

---

getTransportId

▸ getTransportId(): string

Gets the transport id.

Returns: string

Inherited from: StreamInfo

Defined in: Generated/TypeScript/fm.liveswitch/StreamInfo.ts:70

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: StreamInfo

Defined in: Generated/TypeScript/fm.liveswitch/DataStreamInfo.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: StreamInfo

Defined in: Generated/TypeScript/fm.liveswitch/DataStreamInfo.ts:177

---

setChannels

▸ setChannels(value: DataChannelInfo[]): void

Sets the data stream channels.

Parameters:

Name	Type
value	DataChannelInfo[]

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/DataStreamInfo.ts:195

---

setId

▸ setId(value: string): void

Sets the identifier.

Parameters:

Name	Type
value	string

Returns: void

Inherited from: StreamInfo

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

---

setReport

▸ setReport(value: DataStreamReport): void

Sets the data stream report.

Parameters:

Name	Type
value	DataStreamReport

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/DataStreamInfo.ts:207

---

setTag

▸ setTag(value: string): void

Sets the tag.

Parameters:

Name	Type
value	string

Returns: void

Inherited from: StreamInfo

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

Inherited from: StreamInfo

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

---

toJson

▸ toJson(): string

Serializes this instance to Json.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/DataStreamInfo.ts:219

---

fromJson

▸ StaticfromJson(dataStreamInfoJson: string): DataStreamInfo

Deserializes Json to a DataStreamInfo.

Parameters:

Name	Type	Description
dataStreamInfoJson	string	The serialized Json.

Returns: DataStreamInfo

The deserialized DataStreamInfo.

Defined in: Generated/TypeScript/fm.liveswitch/DataStreamInfo.ts:36

---

fromJsonArray

▸ StaticfromJsonArray(dataStreamInfosJson: string): DataStreamInfo[]

Deserializes JSON to a DataStreamInfo array.

Parameters:

Name	Type	Description
dataStreamInfosJson	string	The serialized JSON.

Returns: DataStreamInfo[]

The deserialized DataStreamInfo array.

Defined in: Generated/TypeScript/fm.liveswitch/DataStreamInfo.ts:54

---

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

---

toJson

▸ StatictoJson(dataStreamInfo: DataStreamInfo): string

Serializes an instance to Json.

Parameters:

Name	Type	Description
dataStreamInfo	DataStreamInfo	The instance to serialize.

Returns: string

Serialized Json.

Defined in: Generated/TypeScript/fm.liveswitch/DataStreamInfo.ts:72

---

toJsonArray

▸ StatictoJsonArray(dataStreamInfos: DataStreamInfo[]): string

Serializes an instance array to JSON.

Parameters:

Name	Type	Description
dataStreamInfos	DataStreamInfo[]	The instance array to serialize.

Returns: string

Serialized Json.

Defined in: Generated/TypeScript/fm.liveswitch/DataStreamInfo.ts:88