/ fm / liveswitch / MixerReport

Class: MixerReport

fm.liveswitch.MixerReport

Mixer report.

Hierarchy

• Info

  ↳ MixerReport

Table of contents

Constructors

• constructor

Methods

• deserializeProperties
• fmliveswitchMixerReportInit
• getDisabled
• getId
• getInputFormat
• getOutputFormat
• getOutputFrameRate
• getOutputHeight
• getOutputWidth
• getTypeString
• serializeProperties
• setDisabled
• setId
• setInputFormat
• setOutputFormat
• setOutputFrameRate
• setOutputHeight
• setOutputWidth
• processArray
• processBoolean
• processBooleanArray
• processDouble
• processFloat
• processFloatArray
• processInteger
• processIntegerArray
• processLong
• processLongArray
• processObject
• processShort
• processShortArray
• processString

Constructors

constructor

+ new MixerReport(): MixerReport

Returns: MixerReport

Inherited from: Info

Defined in: fm/Generated/TypeScript/fm.liveswitch/MixerReport.ts:30

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: fm/Generated/TypeScript/fm.liveswitch/MixerReport.ts:48

---

fmliveswitchMixerReportInit

▸ PrivatefmliveswitchMixerReportInit(): void

Returns: void

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

---

getDisabled

▸ getDisabled(): boolean

Gets whether the mixer is disabled.

Returns: boolean

Defined in: fm/Generated/TypeScript/fm.liveswitch/MixerReport.ts:83

---

getId

▸ getId(): string

Gets the identifier.

Returns: string

Inherited from: Info

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

---

getInputFormat

▸ getInputFormat(): FormatInfo

Gets the mixer input format.

Returns: FormatInfo

Defined in: fm/Generated/TypeScript/fm.liveswitch/MixerReport.ts:93

---

getOutputFormat

▸ getOutputFormat(): FormatInfo

Gets the mixer output format.

Returns: FormatInfo

Defined in: fm/Generated/TypeScript/fm.liveswitch/MixerReport.ts:103

---

getOutputFrameRate

▸ getOutputFrameRate(): number

Gets the mixer output frame-rate.

Returns: number

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

---

getOutputHeight

▸ getOutputHeight(): number

Gets the mixer output height.

Returns: number

Defined in: fm/Generated/TypeScript/fm.liveswitch/MixerReport.ts:123

---

getOutputWidth

▸ getOutputWidth(): number

Gets the mixer output width.

Returns: number

Defined in: fm/Generated/TypeScript/fm.liveswitch/MixerReport.ts:133

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Info

Defined in: fm/Generated/TypeScript/fm.liveswitch/MixerReport.ts:8

---

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: fm/Generated/TypeScript/fm.liveswitch/MixerReport.ts:144

---

setDisabled

▸ setDisabled(value: boolean): void

Sets whether the mixer is disabled.

Parameters:

Name	Type
value	boolean

Returns: void

Defined in: fm/Generated/TypeScript/fm.liveswitch/MixerReport.ts:172

---

setId

▸ setId(value: string): void

Sets the identifier.

Parameters:

Name	Type
value	string

Returns: void

Inherited from: Info

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

---

setInputFormat

▸ setInputFormat(value: FormatInfo): void

Sets the mixer input format.

Parameters:

Name	Type
value	FormatInfo

Returns: void

Defined in: fm/Generated/TypeScript/fm.liveswitch/MixerReport.ts:182

---

setOutputFormat

▸ setOutputFormat(value: FormatInfo): void

Sets the mixer output format.

Parameters:

Name	Type
value	FormatInfo

Returns: void

Defined in: fm/Generated/TypeScript/fm.liveswitch/MixerReport.ts:192

---

setOutputFrameRate

▸ setOutputFrameRate(value: number): void

Sets the mixer output frame-rate.

Parameters:

Name	Type
value	number

Returns: void

Defined in: fm/Generated/TypeScript/fm.liveswitch/MixerReport.ts:202

---

setOutputHeight

▸ setOutputHeight(value: number): void

Sets the mixer output height.

Parameters:

Name	Type
value	number

Returns: void

Defined in: fm/Generated/TypeScript/fm.liveswitch/MixerReport.ts:212

---

setOutputWidth

▸ setOutputWidth(value: number): void

Sets the mixer output width.

Parameters:

Name	Type
value	number

Returns: void

Defined in: fm/Generated/TypeScript/fm.liveswitch/MixerReport.ts:222

---

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: fm/Generated/TypeScript/fm.liveswitch/Info.ts:30

---

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: fm/Generated/TypeScript/fm.liveswitch/Info.ts:54

---

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: fm/Generated/TypeScript/fm.liveswitch/Info.ts:67

---

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: fm/Generated/TypeScript/fm.liveswitch/Info.ts:91

---

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: fm/Generated/TypeScript/fm.liveswitch/Info.ts:104

---

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: fm/Generated/TypeScript/fm.liveswitch/Info.ts:117

---

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: fm/Generated/TypeScript/fm.liveswitch/Info.ts:141

---

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: fm/Generated/TypeScript/fm.liveswitch/Info.ts:156

---

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: fm/Generated/TypeScript/fm.liveswitch/Info.ts:180

---

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: fm/Generated/TypeScript/fm.liveswitch/Info.ts:195

---

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: fm/Generated/TypeScript/fm.liveswitch/Info.ts:219

---

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: fm/Generated/TypeScript/fm.liveswitch/Info.ts:238

---

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: fm/Generated/TypeScript/fm.liveswitch/Info.ts:253

---

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: fm/Generated/TypeScript/fm.liveswitch/Info.ts:277