/ fm / liveswitch / LayoutUtility

Class: LayoutUtility

fm.liveswitch.LayoutUtility

Utility to assist with managing the layout of a combined video feed.

Table of contents

Constructors

• constructor

Methods

• getTypeString
• floatLocalPreview

Constructors

constructor

+ new LayoutUtility(): LayoutUtility

Returns: LayoutUtility

Methods

getTypeString

▸ getTypeString(): string

Returns: string

---

floatLocalPreview

▸ StaticfloatLocalPreview(layout: Layout, videoLayout: VideoLayout, localConnectionId: string): boolean

Floats the local preview over the combined video feed.

Parameters:

Name	Type	Description
layout	Layout	The layout.
videoLayout	VideoLayout	The video layout.
localConnectionId	string	The local connection identifier.

Returns: boolean

▸ StaticfloatLocalPreview(layout: Layout, videoLayout: VideoLayout, localConnectionId: string, viewId: string): boolean

Floats the local preview over the combined video feed.

Parameters:

Name	Type	Description
layout	Layout	The layout.
videoLayout	VideoLayout	The video layout.
localConnectionId	string	The local connection identifier.
viewId	string	The view id to compare with.

Returns: boolean

▸ StaticfloatLocalPreview<T>(layout: Layout, videoLayout: VideoLayout, localConnectionId: string, viewId: string, localViewSink: IViewSink<T>): boolean

Floats the local preview over the combined video feed.

Type parameters:

Name
T

Parameters:

Name	Type	Description
layout	Layout	The layout.
videoLayout	VideoLayout	The video layout.
localConnectionId	string	The local connection identifier.
viewId	string	The view id to compare with.
localViewSink	IViewSink<T>	The local view sink.

Returns: boolean

▸ StaticfloatLocalPreview(localFrame: LayoutFrame, remoteFrame: LayoutFrame, videoLayout: VideoLayout, localConnectionId: string): boolean

Floats the local preview over the combined video feed.

Parameters:

Name	Type	Description
localFrame	LayoutFrame	The local frame.
remoteFrame	LayoutFrame	The remote frame.
videoLayout	VideoLayout	The video layout.
localConnectionId	string	The local connection identifier.

Returns: boolean