/ fm / liveswitch / SinkOutput

Class: SinkOutput

fm.liveswitch.SinkOutput

A sink output (e.g. device, track, screen).

Table of contents

Constructors

• constructor

Methods

• getId
• getName
• getTypeString
• toJson
• toString
• fromJson
• fromJsonArray
• toJson
• toJsonArray

Constructors

constructor

+ new SinkOutput(): SinkOutput

Returns: SinkOutput

Defined in: Generated/TypeScript/fm.liveswitch/SinkOutput.ts:15

+ new SinkOutput(idValue: string, name: string): SinkOutput

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

Parameters:

Name	Type	Description
idValue	string	The identifier.
name	string	The name.

Returns: SinkOutput

Defined in: Generated/TypeScript/fm.liveswitch/SinkOutput.ts:17

Methods

getId

▸ getId(): string

Gets the identifier.

Returns: string

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

---

getName

▸ getName(): string

Gets the name.

Returns: string

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

---

getTypeString

▸ getTypeString(): string

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/SinkOutput.ts:9

---

toJson

▸ toJson(): string

Serializes this instance to JSON.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/SinkOutput.ts:164

---

toString

▸ toString(): string

Returns a string that represents this instance.

Returns: string

A string that represents this instance.

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

---

fromJson

▸ StaticfromJson(sinkOutputJson: string): SinkOutput

Deserializes an instance from JSON.

Parameters:

Name	Type	Description
sinkOutputJson	string	The sink output JSON.

Returns: SinkOutput

Defined in: Generated/TypeScript/fm.liveswitch/SinkOutput.ts:49

---

fromJsonArray

▸ StaticfromJsonArray(sinkOutputsJson: string): SinkOutput[]

Deserializes an instance array from JSON.

Parameters:

Name	Type	Description
sinkOutputsJson	string	The sink outputs JSON.

Returns: SinkOutput[]

Defined in: Generated/TypeScript/fm.liveswitch/SinkOutput.ts:75

---

toJson

▸ StatictoJson(sinkOutput: SinkOutput): string

Serializes an instance to JSON.

Parameters:

Name	Type	Description
sinkOutput	SinkOutput	The sink output.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/SinkOutput.ts:92

---

toJsonArray

▸ StatictoJsonArray(sinkOutputs: SinkOutput[]): string

Serializes an instance array to JSON.

Parameters:

Name	Type	Description
sinkOutputs	SinkOutput[]	The sink outputs.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/SinkOutput.ts:112