Search Results for

    / fm / liveswitch / LayoutPreset

    Class: LayoutPreset

    fm.liveswitch.LayoutPreset

    A layout preset.

    Hierarchy

    • Dynamic

      ↳ LayoutPreset

      ↳↳ LayoutManager

    Table of contents

    Constructors

    • constructor

    Methods

    • applyPreset
    • calculateLayout
    • copyToPreset
    • fmliveswitchLayoutPresetInit
    • getAlignment
    • getBlockHeight
    • getBlockHeightPercent
    • getBlockMarginX
    • getBlockMarginXPercent
    • getBlockMarginY
    • getBlockMarginYPercent
    • getBlockWidth
    • getBlockWidthPercent
    • getDirection
    • getDynamicProperties
    • getDynamicValue
    • getFloatHeight
    • getFloatHeightPercent
    • getFloatMarginX
    • getFloatMarginXPercent
    • getFloatMarginY
    • getFloatMarginYPercent
    • getFloatWidth
    • getFloatWidthPercent
    • getInlineMargin
    • getMode
    • getTypeString
    • setAlignment
    • setBlockHeight
    • setBlockHeightPercent
    • setBlockMarginX
    • setBlockMarginXPercent
    • setBlockMarginY
    • setBlockMarginYPercent
    • setBlockWidth
    • setBlockWidthPercent
    • setDirection
    • setDynamicValue
    • setFloatHeight
    • setFloatHeightPercent
    • setFloatMarginX
    • setFloatMarginXPercent
    • setFloatMarginY
    • setFloatMarginYPercent
    • setFloatWidth
    • setFloatWidthPercent
    • setInlineMargin
    • setMode
    • unsetDynamicValue
    • getFacetime
    • getGoogleHangouts
    • getSkype

    Constructors

    constructor

    + new LayoutPreset(): LayoutPreset

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

    Returns: LayoutPreset

    Inherited from: Dynamic

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:73

    Methods

    applyPreset

    ▸ applyPreset(preset: LayoutPreset): void

    Applies a preset.

    Parameters:

    Name Type Description
    preset LayoutPreset The preset to apply.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:452


    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.

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:828

    ▸ 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.

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:839


    copyToPreset

    ▸ copyToPreset(preset: LayoutPreset): void

    Copies this preset's properties to another preset.

    Parameters:

    Name Type Description
    preset LayoutPreset The target preset.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:897


    fmliveswitchLayoutPresetInit

    ▸ PrivatefmliveswitchLayoutPresetInit(): void

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:54


    getAlignment

    ▸ getAlignment(): LayoutAlignment

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

    Returns: LayoutAlignment

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:980


    getBlockHeight

    ▸ getBlockHeight(): number

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

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:993


    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

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:1007


    getBlockMarginX

    ▸ getBlockMarginX(): number

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

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:1105


    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

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:1119


    getBlockMarginY

    ▸ getBlockMarginY(): number

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

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:1133


    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

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:1147


    getBlockWidth

    ▸ getBlockWidth(): number

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

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:1160


    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

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:1174


    getDirection

    ▸ getDirection(): LayoutDirection

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

    Returns: LayoutDirection

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:1256


    getDynamicProperties

    ▸ getDynamicProperties(): Hash<string, Object>

    Gets all dynamic properties on this instance.

    Returns: Hash<string, Object>

    Inherited from: Dynamic

    Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:37


    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: Dynamic

    Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:58


    getFloatHeight

    ▸ getFloatHeight(): number

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

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:1269


    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

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:1283


    getFloatMarginX

    ▸ getFloatMarginX(): number

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

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:1317


    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

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:1331


    getFloatMarginY

    ▸ getFloatMarginY(): number

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

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:1345


    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

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:1359


    getFloatWidth

    ▸ getFloatWidth(): number

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

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:1389


    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

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:1403


    getInlineMargin

    ▸ getInlineMargin(): number

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

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:1494


    getMode

    ▸ getMode(): LayoutMode

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

    Returns: LayoutMode

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:1633


    getTypeString

    ▸ getTypeString(): string

    Returns: string

    Overrides: Dynamic

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


    setAlignment

    ▸ setAlignment(value: LayoutAlignment): void

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

    Parameters:

    Name Type
    value LayoutAlignment

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:1692


    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

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:1705


    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

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:1721


    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

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:1742


    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

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:1758


    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

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:1779


    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

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:1795


    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

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:1815


    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

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:1831


    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

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:1851


    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: Dynamic

    Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:95


    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

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:1864


    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

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:1880


    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

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:1901


    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

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:1917


    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

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:1938


    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

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:1954


    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

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:1974


    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

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:1990


    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

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:2010


    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

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:2024


    unsetDynamicValue

    ▸ unsetDynamicValue(key: string): boolean

    Removes a property value from the local cache. Returns true if the value was removed and returns false otherwise.

    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: Dynamic

    Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:122


    getFacetime

    ▸ StaticgetFacetime(): LayoutPreset

    Gets a Facetime-style layout preset.

    Returns: LayoutPreset

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:169


    getGoogleHangouts

    ▸ StaticgetGoogleHangouts(): LayoutPreset

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

    Returns: LayoutPreset

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:191


    getSkype

    ▸ StaticgetSkype(): LayoutPreset

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

    Returns: LayoutPreset

    Defined in: Generated/TypeScript/fm.liveswitch/LayoutPreset.ts:234

    In This Article
    Back to top Copyright © LiveSwitch Inc. All Rights Reserved. Doc build for LiveSwitch v1.14.6