/ fm / liveswitch / LayoutManager

Class: LayoutManager<T>

fm.liveswitch.LayoutManager

A class that supplies simple video frame layout management.

Type parameters

Name
T

Hierarchy

Table of contents

Constructors

Methods

Constructors

constructor

+ new LayoutManager<T>(): LayoutManager<T>

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

Type parameters:

Name
T

Returns: LayoutManager<T>

Inherited from: LayoutPreset

+ new LayoutManager<T>(preset: LayoutPreset): LayoutManager<T>

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

Type parameters:

Name
T

Parameters:

Name Type
preset LayoutPreset

Returns: LayoutManager<T>

Methods

addOnLayout

▸ addOnLayout(value: IAction1<Layout>): void

Adds a handler that is raised when a layout is calculated.

Parameters:

Name Type
value IAction1<Layout>

Returns: void

addRemoteMedia

▸ addRemoteMedia(remoteMedia: IViewableMedia<T>): boolean

Adds remote media to the layout.

Parameters:

Name Type Description
remoteMedia IViewableMedia<T> The remote media.

Returns: boolean

true if successful; otherwise, false.

addRemoteView

▸ addRemoteView(idValue: string, view: T): boolean

Adds a remote view to the layout.

Parameters:

Name Type Description
idValue string The remote view ID.
view T The remote view.

Returns: boolean

true if successful; otherwise, false. Check the logs for additional information.

addRemoteViews

▸ addRemoteViews(ids: string[], views: T[]): boolean

Adds remote views to the layout.

Parameters:

Name Type Description
ids string[] The remote view IDs.
views T[] The remote views.

Returns: boolean

true if successful; otherwise, false. Check the logs for additional information.

addView

▸ Protected AbstractaddView(view: T): void

Adds a view to the container.

Parameters:

Name Type Description
view T The view to add.

Returns: void

applyPreset

▸ applyPreset(preset: LayoutPreset): void

Applies a preset.

Parameters:

Name Type Description
preset LayoutPreset The preset to apply.

Returns: void

Inherited from: LayoutPreset

calculateLayout

▸ calculateLayout(layoutWidth: number, layoutHeight: number, local: boolean, remoteCount: number, origin: LayoutOrigin, localVideoSize: Size, remoteVideoSizes: Size[]): Layout

Gets a video frame layout.

Parameters:

Name Type Description
layoutWidth number The total width of the layout.
layoutHeight number The total height of the layout.
local boolean Whether a local frame is needed.
remoteCount number The number of remote frames.
origin LayoutOrigin The layout origin.
localVideoSize Size The local video size.
remoteVideoSizes Size[] The remote video sizes.

Returns: Layout

The video frame layout.

Inherited from: LayoutPreset

▸ calculateLayout(layoutWidth: number, layoutHeight: number, remoteCount: number, origin: LayoutOrigin): Layout

Gets a video frame layout.

Parameters:

Name Type Description
layoutWidth number The total width of the layout.
layoutHeight number The total height of the layout.
remoteCount number The number of remote frames.
origin LayoutOrigin The layout origin.

Returns: Layout

The video frame layout.

Inherited from: LayoutPreset

copyToPreset

▸ copyToPreset(preset: LayoutPreset): void

Copies this preset's properties to another preset.

Parameters:

Name Type Description
preset LayoutPreset The target preset.

Returns: void

Inherited from: LayoutPreset

dispatchToMainThread

▸ Protected AbstractdispatchToMainThread(action: IAction2<Object, Object>, arg1: Object, arg2: Object): void

Dispatches an action to the main thread.

Parameters:

Name Type Description
action IAction2<Object, Object> The action to invoke.
arg1 Object The first argument.
arg2 Object The second argument.

Returns: void

doGetLocalView

▸ ProtecteddoGetLocalView(): T

Gets the local view.

Returns: T

The local view.

doGetRemoteViews

▸ ProtecteddoGetRemoteViews(idValue: string): T[]

Gets the remote views for a given remote view ID.

Parameters:

Name Type Description
idValue string The remote view ID.

Returns: T[]

The remote views.

doGetRemoteViewsIds

▸ ProtecteddoGetRemoteViewsIds(): string[]

Gets the remote view IDs.

Returns: string[]

The remote view IDs.

fmliveswitchLayoutManagerInit

▸ PrivatefmliveswitchLayoutManagerInit(): void

Returns: void

getAlignment

▸ getAlignment(): LayoutAlignment

Gets the alignment of the layout. Defaults to [[fm.liveswitch.layoutAlignment.BottomRight]].

Returns: LayoutAlignment

Inherited from: LayoutPreset

getBlockHeight

▸ getBlockHeight(): number

Gets the height of block elements in pixels. Overrides [[fm.liveswitch.layoutPreset.blockHeightPercent]].

Returns: number

Inherited from: LayoutPreset

getBlockHeightPercent

▸ getBlockHeightPercent(): number

Gets the height of block elements as a percent of the container height between 0.0 and 1.0. Overrides [[fm.liveswitch.layoutPreset.blockHeight]].

Returns: number

Inherited from: LayoutPreset

getBlockMarginX

▸ getBlockMarginX(): number

Gets the X-margin between block elements and the layout edge in pixels. Overrides [[fm.liveswitch.layoutPreset.blockMarginXPercent]].

Returns: number

Inherited from: LayoutPreset

getBlockMarginXPercent

▸ getBlockMarginXPercent(): number

Gets the X-margin between block elements and the layout edge as a percent of the container width between 0.0 and 1.0. Overrides [[fm.liveswitch.layoutPreset.blockMarginX]].

Returns: number

Inherited from: LayoutPreset

getBlockMarginY

▸ getBlockMarginY(): number

Gets the Y-margin between block elements and the layout edge in pixels. Overrides [[fm.liveswitch.layoutPreset.blockMarginYPercent]].

Returns: number

Inherited from: LayoutPreset

getBlockMarginYPercent

▸ getBlockMarginYPercent(): number

Gets the Y-margin between block elements and the layout edge as a percent of the container height between 0.0 and 1.0. Overrides [[fm.liveswitch.layoutPreset.blockMarginY]].

Returns: number

Inherited from: LayoutPreset

getBlockWidth

▸ getBlockWidth(): number

Gets the width of block elements in pixels. Overrides [[fm.liveswitch.layoutPreset.blockWidthPercent]].

Returns: number

Inherited from: LayoutPreset

getBlockWidthPercent

▸ getBlockWidthPercent(): number

Gets the width of block elements as a percent of the container width between 0.0 and 1.0. Overrides [[fm.liveswitch.layoutPreset.blockWidth]].

Returns: number

Inherited from: LayoutPreset

getDirection

▸ getDirection(): LayoutDirection

Gets the direction of the layout flow. Defaults to [[fm.liveswitch.layoutDirection.Horizontal]].

Returns: LayoutDirection

Inherited from: LayoutPreset

getDynamicProperties

▸ getDynamicProperties(): Hash<string, Object>

Gets the dynamic properties on this instance.

Returns: Hash<string, Object>

Inherited from: LayoutPreset

getDynamicValue

▸ getDynamicValue(key: string): Object

Gets a property value from the local cache.

Parameters:

Name Type Description
key string The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.

Returns: Object

The stored value, if found; otherwise null.

Inherited from: LayoutPreset

getFloatHeight

▸ getFloatHeight(): number

Gets the height of floating elements in pixels. Overrides [[fm.liveswitch.layoutPreset.floatHeightPercent]].

Returns: number

Inherited from: LayoutPreset

getFloatHeightPercent

▸ getFloatHeightPercent(): number

Gets the height of floating elements as a percent of the container height between 0.0 and 1.0. Overrides [[fm.liveswitch.layoutPreset.floatHeight]].

Returns: number

Inherited from: LayoutPreset

getFloatMarginX

▸ getFloatMarginX(): number

Gets the X-margin between floating elements and the layout edge in pixels. Overrides [[fm.liveswitch.layoutPreset.floatMarginXPercent]].

Returns: number

Inherited from: LayoutPreset

getFloatMarginXPercent

▸ getFloatMarginXPercent(): number

Gets the X-margin between floating elements and the layout edge as a percent of the container width between 0.0 and 1.0. Overrides [[fm.liveswitch.layoutPreset.floatMarginX]].

Returns: number

Inherited from: LayoutPreset

getFloatMarginY

▸ getFloatMarginY(): number

Gets the Y-margin between floating elements and the layout edge in pixels. Overrides [[fm.liveswitch.layoutPreset.floatMarginYPercent]].

Returns: number

Inherited from: LayoutPreset

getFloatMarginYPercent

▸ getFloatMarginYPercent(): number

Gets the Y-margin between floating elements and the layout edge as a percent of the container height between 0.0 and 1.0. Overrides [[fm.liveswitch.layoutPreset.floatMarginY]].

Returns: number

Inherited from: LayoutPreset

getFloatWidth

▸ getFloatWidth(): number

Gets the width of floating elements in pixels. Overrides [[fm.liveswitch.layoutPreset.floatWidthPercent]].

Returns: number

Inherited from: LayoutPreset

getFloatWidthPercent

▸ getFloatWidthPercent(): number

Gets the width of floating elements as a percent of the container width between 0.0 and 1.0. Overrides [[fm.liveswitch.layoutPreset.floatWidth]].

Returns: number

Inherited from: LayoutPreset

getInlineMargin

▸ getInlineMargin(): number

Gets the size of the margin in pixels to use between inline elements.

Returns: number

Inherited from: LayoutPreset

getLayout

▸ ProtectedgetLayout(layoutWidth: number, layoutHeight: number, local: boolean, remoteCount: number): Layout

Gets a video frame layout.

Parameters:

Name Type Description
layoutWidth number The total width of the layout.
layoutHeight number The total height of the layout.
local boolean Whether a local frame is needed.
remoteCount number The number of remote frames.

Returns: Layout

The video frame layout.

▸ ProtectedgetLayout(layoutWidth: number, layoutHeight: number, local: boolean, remoteCount: number, remoteViewIds: string[]): Layout

Gets a video frame layout.

Parameters:

Name Type Description
layoutWidth number The total width of the layout.
layoutHeight number The total height of the layout.
local boolean Whether a local frame is needed.
remoteCount number The number of remote frames.
remoteViewIds string[] The remote view IDs.

Returns: Layout

The video frame layout.

▸ ProtectedgetLayout(layoutWidth: number, layoutHeight: number, local: boolean, remoteCount: number, remoteViewIds: string[], localVideoSize: Size, remoteVideoSizes: Size[]): Layout

Gets a video frame layout.

Parameters:

Name Type Description
layoutWidth number The total width of the layout.
layoutHeight number The total height of the layout.
local boolean Whether a local frame is needed.
remoteCount number The number of remote frames.
remoteViewIds string[] The remote view IDs.
localVideoSize Size The local video size.
remoteVideoSizes Size[] The remote video sizes.

Returns: Layout

The video frame layout.

▸ ProtectedgetLayout(layoutWidth: number, layoutHeight: number, remoteCount: number): Layout

Gets a video frame layout.

Parameters:

Name Type Description
layoutWidth number The total width of the layout.
layoutHeight number The total height of the layout.
remoteCount number The number of remote frames.

Returns: Layout

The video frame layout.

▸ ProtectedgetLayout(layoutWidth: number, layoutHeight: number, remoteCount: number, remoteViewIds: string[]): Layout

Gets a video frame layout.

Parameters:

Name Type Description
layoutWidth number The total width of the layout.
layoutHeight number The total height of the layout.
remoteCount number The number of remote frames.
remoteViewIds string[] The remote view IDs.

Returns: Layout

The video frame layout.

getLayoutOrigin

▸ getLayoutOrigin(): LayoutOrigin

Gets the layout origin. Defaults to TopLeft.

Returns: LayoutOrigin

getLocalView

▸ getLocalView(): T

Gets the local view from the layout.

Returns: T

The local view.

getMode

▸ getMode(): LayoutMode

Gets the mode used by the layout engine. Defaults to [[fm.liveswitch.layoutMode.FloatLocal]].

Returns: LayoutMode

Inherited from: LayoutPreset

getRemoteView

▸ getRemoteView(idValue: string): T

Gets a remote view from the layout.

Parameters:

Name Type Description
idValue string The remote view ID.

Returns: T

The remote view.

getRemoteViewIds

▸ getRemoteViewIds(): string[]

Gets the IDs of the remote views in the layout.

Returns: string[]

The remote view IDs.

getRemoteViews

▸ getRemoteViews(): T[]

Gets all remote views from the layout.

Returns: T[]

The remote views.

▸ getRemoteViews(ids: string[]): T[]

Gets remote views from the layout.

Parameters:

Name Type Description
ids string[] The remote view IDs.

Returns: T[]

The remote views.

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: LayoutPreset

layout

▸ Abstractlayout(): void

Positions the local and remote views within the layout.

Returns: void

layoutOnMainThread

▸ layoutOnMainThread(): void

Positions the local and remote views within the layout after dispatching to the main thread.

Returns: void

removeOnLayout

▸ removeOnLayout(value: IAction1<Layout>): void

Removes a handler that is raised when a layout is calculated.

Parameters:

Name Type
value IAction1<Layout>

Returns: void

removeRemoteMedia

▸ removeRemoteMedia(remoteMedia: IViewableMedia<T>): boolean

Removes remote media from the layout.

Parameters:

Name Type Description
remoteMedia IViewableMedia<T> The remote media.

Returns: boolean

true if successful; otherwise, false.

removeRemoteView

▸ removeRemoteView(idValue: string): boolean

Removes a remote view from the layout.

Parameters:

Name Type Description
idValue string The remote view ID.

Returns: boolean

true if successful; otherwise, false. Check the logs for additional information.

removeRemoteViews

▸ removeRemoteViews(): void

Removes all remote views from the layout.

Returns: void

▸ removeRemoteViews(ids: string[]): boolean

Removes remote views from the layout.

Parameters:

Name Type Description
ids string[] The remote view IDs.

Returns: boolean

true if successful; otherwise, false. Check the logs for additional information.

removeView

▸ Protected AbstractremoveView(view: T): void

Removes a view from the container.

Parameters:

Name Type Description
view T The view to remove.

Returns: void

reset

▸ reset(): void

Removes all remote views from the layout, then removes the local view from the layout.

Returns: void

setAlignment

▸ setAlignment(value: LayoutAlignment): void

Sets the alignment of the layout. Defaults to [[fm.liveswitch.layoutAlignment.BottomRight]].

Parameters:

Name Type
value LayoutAlignment

Returns: void

Inherited from: LayoutPreset

setBlockHeight

▸ setBlockHeight(value: number): void

Sets the height of block elements in pixels. Overrides [[fm.liveswitch.layoutPreset.blockHeightPercent]].

Parameters:

Name Type
value number

Returns: void

Inherited from: LayoutPreset

setBlockHeightPercent

▸ setBlockHeightPercent(value: number): void

Sets the height of block elements as a percent of the container height between 0.0 and 1.0. Overrides [[fm.liveswitch.layoutPreset.blockHeight]].

Parameters:

Name Type
value number

Returns: void

Inherited from: LayoutPreset

setBlockMarginX

▸ setBlockMarginX(value: number): void

Sets the X-margin between block elements and the layout edge in pixels. Overrides [[fm.liveswitch.layoutPreset.blockMarginXPercent]].

Parameters:

Name Type
value number

Returns: void

Inherited from: LayoutPreset

setBlockMarginXPercent

▸ setBlockMarginXPercent(value: number): void

Sets the X-margin between block elements and the layout edge as a percent of the container width between 0.0 and 1.0. Overrides [[fm.liveswitch.layoutPreset.blockMarginX]].

Parameters:

Name Type
value number

Returns: void

Inherited from: LayoutPreset

setBlockMarginY

▸ setBlockMarginY(value: number): void

Sets the Y-margin between block elements and the layout edge in pixels. Overrides [[fm.liveswitch.layoutPreset.blockMarginYPercent]].

Parameters:

Name Type
value number

Returns: void

Inherited from: LayoutPreset

setBlockMarginYPercent

▸ setBlockMarginYPercent(value: number): void

Sets the Y-margin between block elements and the layout edge as a percent of the container height between 0.0 and 1.0. Overrides [[fm.liveswitch.layoutPreset.blockMarginY]].

Parameters:

Name Type
value number

Returns: void

Inherited from: LayoutPreset

setBlockWidth

▸ setBlockWidth(value: number): void

Sets the width of block elements in pixels. Overrides [[fm.liveswitch.layoutPreset.blockWidthPercent]].

Parameters:

Name Type
value number

Returns: void

Inherited from: LayoutPreset

setBlockWidthPercent

▸ setBlockWidthPercent(value: number): void

Sets the width of block elements as a percent of the container width between 0.0 and 1.0. Overrides [[fm.liveswitch.layoutPreset.blockWidth]].

Parameters:

Name Type
value number

Returns: void

Inherited from: LayoutPreset

setDirection

▸ setDirection(value: LayoutDirection): void

Sets the direction of the layout flow. Defaults to [[fm.liveswitch.layoutDirection.Horizontal]].

Parameters:

Name Type
value LayoutDirection

Returns: void

Inherited from: LayoutPreset

setDynamicValue

▸ setDynamicValue(key: string, value: Object): void

Sets a property value in the local cache.

Parameters:

Name Type Description
key string The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.
value Object The property value. This can be any object that needs to be stored for future use.

Returns: void

Inherited from: LayoutPreset

setFloatHeight

▸ setFloatHeight(value: number): void

Sets the height of floating elements in pixels. Overrides [[fm.liveswitch.layoutPreset.floatHeightPercent]].

Parameters:

Name Type
value number

Returns: void

Inherited from: LayoutPreset

setFloatHeightPercent

▸ setFloatHeightPercent(value: number): void

Sets the height of floating elements as a percent of the container height between 0.0 and 1.0. Overrides [[fm.liveswitch.layoutPreset.floatHeight]].

Parameters:

Name Type
value number

Returns: void

Inherited from: LayoutPreset

setFloatMarginX

▸ setFloatMarginX(value: number): void

Sets the X-margin between floating elements and the layout edge in pixels. Overrides [[fm.liveswitch.layoutPreset.floatMarginXPercent]].

Parameters:

Name Type
value number

Returns: void

Inherited from: LayoutPreset

setFloatMarginXPercent

▸ setFloatMarginXPercent(value: number): void

Sets the X-margin between floating elements and the layout edge as a percent of the container width between 0.0 and 1.0. Overrides [[fm.liveswitch.layoutPreset.floatMarginX]].

Parameters:

Name Type
value number

Returns: void

Inherited from: LayoutPreset

setFloatMarginY

▸ setFloatMarginY(value: number): void

Sets the Y-margin between floating elements and the layout edge in pixels. Overrides [[fm.liveswitch.layoutPreset.floatMarginYPercent]].

Parameters:

Name Type
value number

Returns: void

Inherited from: LayoutPreset

setFloatMarginYPercent

▸ setFloatMarginYPercent(value: number): void

Sets the Y-margin between floating elements and the layout edge as a percent of the container height between 0.0 and 1.0. Overrides [[fm.liveswitch.layoutPreset.floatMarginY]].

Parameters:

Name Type
value number

Returns: void

Inherited from: LayoutPreset

setFloatWidth

▸ setFloatWidth(value: number): void

Sets the width of floating elements in pixels. Overrides [[fm.liveswitch.layoutPreset.floatWidthPercent]].

Parameters:

Name Type
value number

Returns: void

Inherited from: LayoutPreset

setFloatWidthPercent

▸ setFloatWidthPercent(value: number): void

Sets the width of floating elements as a percent of the container width between 0.0 and 1.0. Overrides [[fm.liveswitch.layoutPreset.floatWidth]].

Parameters:

Name Type
value number

Returns: void

Inherited from: LayoutPreset

setInlineMargin

▸ setInlineMargin(value: number): void

Sets the size of the margin in pixels to use between inline elements.

Parameters:

Name Type
value number

Returns: void

Inherited from: LayoutPreset

setLayoutOrigin

▸ ProtectedsetLayoutOrigin(value: LayoutOrigin): void

Sets the layout origin. Defaults to TopLeft.

Parameters:

Name Type
value LayoutOrigin

Returns: void

setLocalMedia

▸ setLocalMedia(localMedia: IViewableMedia<T>): boolean

Adds the local media to the layout.

Parameters:

Name Type Description
localMedia IViewableMedia<T> The local media.

Returns: boolean

true if successful; otherwise, false.

setLocalView

▸ setLocalView(view: T): boolean

Adds the local view to the layout.

Parameters:

Name Type Description
view T The local view.

Returns: boolean

true if successful; otherwise, false. Check the logs for additional information.

setMode

▸ setMode(value: LayoutMode): void

Sets the mode used by the layout engine. Defaults to [[fm.liveswitch.layoutMode.FloatLocal]].

Parameters:

Name Type
value LayoutMode

Returns: void

Inherited from: LayoutPreset

swapRemoteMedia

▸ swapRemoteMedia(remoteMediaToRemove: IViewableMedia<T>, remoteMediaToAdd: IViewableMedia<T>): boolean

Swaps remote media in the layout.

Parameters:

Name Type Description
remoteMediaToRemove IViewableMedia<T> The remote media to remove.
remoteMediaToAdd IViewableMedia<T> The remote media to add.

Returns: boolean

swapRemoteView

▸ swapRemoteView(idToRemove: string, idToAdd: string, viewToAdd: T): boolean

Swaps a remote view in the layout.

Parameters:

Name Type Description
idToRemove string The remote view ID to remove.
idToAdd string The remote view ID to add.
viewToAdd T The remote view to add.

Returns: boolean

swapRemoteViews

▸ swapRemoteViews(idsToRemove: string[], idsToAdd: string[], viewsToAdd: T[]): boolean

Swaps remote views in the layout.

Parameters:

Name Type Description
idsToRemove string[] The remote view IDs to remove.
idsToAdd string[] The remote view IDs to add.
viewsToAdd T[] The remote views to add.

Returns: boolean

true if successful; otherwise, false. Check the logs for additional information.

unsetDynamicValue

▸ unsetDynamicValue(key: string): boolean

Unsets a property value in the local cache.

Parameters:

Name Type Description
key string The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.

Returns: boolean

true if the value was removed; otherwise, false.

Inherited from: LayoutPreset

unsetLocalView

▸ unsetLocalView(): boolean

Removes the local view from the layout.

Returns: boolean

true if successful; otherwise, false. Check the logs for additional information.

getFacetime

▸ StaticgetFacetime(): LayoutPreset

Gets a Facetime-style layout preset.

Returns: LayoutPreset

Inherited from: LayoutPreset

getGoogleHangouts

▸ StaticgetGoogleHangouts(): LayoutPreset

Gets a Google Hangouts-style layout preset. Note that this will present differently on mobile devices.

Returns: LayoutPreset

Inherited from: LayoutPreset

getSkype

▸ StaticgetSkype(): LayoutPreset

Gets a Skype-style layout preset. Note that this will present differently on mobile devices.

Returns: LayoutPreset

Inherited from: LayoutPreset