/ fm / liveswitch / Layout

Class: Layout

fm.liveswitch.Layout

A layout definition, including local and remote frame definitions.

Table of contents

Constructors

• constructor

Methods

• fmliveswitchLayoutInit
• getAllFrames
• getHeight
• getLocalFrame
• getOrigin
• getRemoteFrames
• getTypeString
• getWidth
• setHeight
• setLocalFrame
• setOrigin
• setRemoteFrames
• setWidth
• swapFrames
• swapLocalFrame
• swapRemoteFrames

Constructors

constructor

+ new Layout(): Layout

Returns: Layout

Defined in: Generated/TypeScript/fm.liveswitch/Layout.ts:28

Methods

fmliveswitchLayoutInit

▸ PrivatefmliveswitchLayoutInit(): void

Returns: void

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

---

getAllFrames

▸ getAllFrames(): LayoutFrame[]

Gets all frames (local and remote).

Returns: LayoutFrame[]

Defined in: Generated/TypeScript/fm.liveswitch/Layout.ts:48

---

getHeight

▸ getHeight(): number

Gets the layout height.

Returns: number

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

---

getLocalFrame

▸ getLocalFrame(): LayoutFrame

Gets the local frame.

Returns: LayoutFrame

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

---

getOrigin

▸ getOrigin(): LayoutOrigin

Gets the layout origin.

Returns: LayoutOrigin

Defined in: Generated/TypeScript/fm.liveswitch/Layout.ts:87

---

getRemoteFrames

▸ getRemoteFrames(): LayoutFrame[]

Gets the remote frames.

Returns: LayoutFrame[]

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

---

getTypeString

▸ getTypeString(): string

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Layout.ts:10

---

getWidth

▸ getWidth(): number

Gets the layout width.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/Layout.ts:111

---

setHeight

▸ setHeight(value: number): void

Sets the layout height.

Parameters:

Name	Type
value	number

Returns: void

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

---

setLocalFrame

▸ setLocalFrame(value: LayoutFrame): void

Sets the local frame.

Parameters:

Name	Type
value	LayoutFrame

Returns: void

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

---

setOrigin

▸ setOrigin(value: LayoutOrigin): void

Sets the layout origin.

Parameters:

Name	Type
value	LayoutOrigin

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Layout.ts:152

---

setRemoteFrames

▸ setRemoteFrames(value: LayoutFrame[]): void

Sets the remote frames.

Parameters:

Name	Type
value	LayoutFrame[]

Returns: void

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

---

setWidth

▸ setWidth(value: number): void

Sets the layout width.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Layout.ts:180

---

swapFrames

▸ swapFrames(frame1: LayoutFrame, frame2: LayoutFrame): void

Swaps the properties of two frames.

Parameters:

Name	Type	Description
frame1	LayoutFrame	The first frame.
frame2	LayoutFrame	The second frame.

Returns: void

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

---

swapLocalFrame

▸ swapLocalFrame(remoteFrameIndex: number): void

Swaps the local frame with a remote frame.

Parameters:

Name	Type	Description
remoteFrameIndex	number	The index of the remote frame.

Returns: void

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

---

swapRemoteFrames

▸ swapRemoteFrames(remoteFrameIndex1: number, remoteFrameIndex2: number): void

Swaps two remote frames.

Parameters:

Name	Type	Description
remoteFrameIndex1	number	The index of the first remote frame.
remoteFrameIndex2	number	The index of the second remote frame.

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Layout.ts:238