FMIceLinkLayoutPreset Class Reference

Inherits from FMIceLinkDynamic : FMIceLinkSerializable : NSObject
Declared in FMIceLinkLayoutPreset.h
FMIceLinkLayoutPreset.m

Overview

A layout preset.

– alignment

Gets the alignment of the layout. Defaults to FMIceLinkLayoutAlignmentBottomRight.
- (FMIceLinkLayoutAlignment)alignment

Discussion

Gets the alignment of the layout. Defaults to FMIceLinkLayoutAlignmentBottomRight.

Declared In

FMIceLinkLayoutPreset.h

– applyPreset:

Applies a preset.
- (void)applyPreset:(FMIceLinkLayoutPreset *)preset

Parameters

preset

The preset to apply.

Discussion

Applies a preset.

Declared In

FMIceLinkLayoutPreset.h

– blockHeight

Gets the height of block elements in pixels. Overrides FMIceLinkLayoutPreset#[blockHeightPercent](#//api/name/blockHeightPercent).
- (int)blockHeight

Discussion

Gets the height of block elements in pixels. Overrides FMIceLinkLayoutPreset#[blockHeightPercent](#//api/name/blockHeightPercent).

Declared In

FMIceLinkLayoutPreset.h

– blockHeightPercent

Gets the height of block elements as a percent of the container height between 0.0 and 1.0. Overrides FMIceLinkLayoutPreset#[blockHeight](#//api/name/blockHeight).
- (double)blockHeightPercent

Discussion

Gets the height of block elements as a percent of the container height between 0.0 and 1.0. Overrides FMIceLinkLayoutPreset#[blockHeight](#//api/name/blockHeight).

Declared In

FMIceLinkLayoutPreset.h

– blockMarginX

Gets the X-margin between block elements and the layout edge in pixels. Overrides FMIceLinkLayoutPreset#[blockMarginXPercent](#//api/name/blockMarginXPercent).
- (int)blockMarginX

Discussion

Gets the X-margin between block elements and the layout edge in pixels. Overrides FMIceLinkLayoutPreset#[blockMarginXPercent](#//api/name/blockMarginXPercent).

Declared In

FMIceLinkLayoutPreset.h

– blockMarginXPercent

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 FMIceLinkLayoutPreset#[blockMarginX](#//api/name/blockMarginX).
- (double)blockMarginXPercent

Discussion

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 FMIceLinkLayoutPreset#[blockMarginX](#//api/name/blockMarginX).

Declared In

FMIceLinkLayoutPreset.h

– blockMarginY

Gets the Y-margin between block elements and the layout edge in pixels. Overrides FMIceLinkLayoutPreset#[blockMarginYPercent](#//api/name/blockMarginYPercent).
- (int)blockMarginY

Discussion

Gets the Y-margin between block elements and the layout edge in pixels. Overrides FMIceLinkLayoutPreset#[blockMarginYPercent](#//api/name/blockMarginYPercent).

Declared In

FMIceLinkLayoutPreset.h

– blockMarginYPercent

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 FMIceLinkLayoutPreset#[blockMarginY](#//api/name/blockMarginY).
- (double)blockMarginYPercent

Discussion

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 FMIceLinkLayoutPreset#[blockMarginY](#//api/name/blockMarginY).

Declared In

FMIceLinkLayoutPreset.h

– blockWidth

Gets the width of block elements in pixels. Overrides FMIceLinkLayoutPreset#[blockWidthPercent](#//api/name/blockWidthPercent).
- (int)blockWidth

Discussion

Gets the width of block elements in pixels. Overrides FMIceLinkLayoutPreset#[blockWidthPercent](#//api/name/blockWidthPercent).

Declared In

FMIceLinkLayoutPreset.h

– blockWidthPercent

Gets the width of block elements as a percent of the container width between 0.0 and 1.0. Overrides FMIceLinkLayoutPreset#[blockWidth](#//api/name/blockWidth).
- (double)blockWidthPercent

Discussion

Gets the width of block elements as a percent of the container width between 0.0 and 1.0. Overrides FMIceLinkLayoutPreset#[blockWidth](#//api/name/blockWidth).

Declared In

FMIceLinkLayoutPreset.h

– calculateLayoutWithLayoutWidth:layoutHeight:remoteCount:origin:

Gets a video frame layout.
- (FMIceLinkLayout *)calculateLayoutWithLayoutWidth:(int)layoutWidth layoutHeight:(int)layoutHeight remoteCount:(int)remoteCount origin:(FMIceLinkLayoutOrigin)origin

Parameters

layoutWidth

The total width of the layout.
layoutHeight

The total height of the layout.
remoteCount

The number of remote frames.
origin

The layout origin

Return Value

The video frame layout.

Discussion

Gets a video frame layout.

Declared In

FMIceLinkLayoutPreset.h

– copyToPreset:

Copies this preset's properties to another preset.
- (void)copyToPreset:(FMIceLinkLayoutPreset *)preset

Parameters

preset

The target preset.

Discussion

Copies this preset's properties to another preset.

Declared In

FMIceLinkLayoutPreset.h

– direction

Gets the direction of the layout flow. Defaults to FMIceLinkLayoutDirectionHorizontal.
- (FMIceLinkLayoutDirection)direction

Discussion

Gets the direction of the layout flow. Defaults to FMIceLinkLayoutDirectionHorizontal.

Declared In

FMIceLinkLayoutPreset.h

+ facetime

Gets a Facetime-style layout preset.
+ (FMIceLinkLayoutPreset *)facetime

Discussion

Gets a Facetime-style layout preset.

Declared In

FMIceLinkLayoutPreset.h

– floatHeight

Gets the height of floating elements in pixels. Overrides FMIceLinkLayoutPreset#[floatHeightPercent](#//api/name/floatHeightPercent).
- (int)floatHeight

Discussion

Gets the height of floating elements in pixels. Overrides FMIceLinkLayoutPreset#[floatHeightPercent](#//api/name/floatHeightPercent).

Declared In

FMIceLinkLayoutPreset.h

– floatHeightPercent

Gets the height of floating elements as a percent of the container height between 0.0 and 1.0. Overrides FMIceLinkLayoutPreset#[floatHeight](#//api/name/floatHeight).
- (double)floatHeightPercent

Discussion

Gets the height of floating elements as a percent of the container height between 0.0 and 1.0. Overrides FMIceLinkLayoutPreset#[floatHeight](#//api/name/floatHeight).

Declared In

FMIceLinkLayoutPreset.h

– floatMarginX

Gets the X-margin between floating elements and the layout edge in pixels. Overrides FMIceLinkLayoutPreset#[floatMarginXPercent](#//api/name/floatMarginXPercent).
- (int)floatMarginX

Discussion

Gets the X-margin between floating elements and the layout edge in pixels. Overrides FMIceLinkLayoutPreset#[floatMarginXPercent](#//api/name/floatMarginXPercent).

Declared In

FMIceLinkLayoutPreset.h

– floatMarginXPercent

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 FMIceLinkLayoutPreset#[floatMarginX](#//api/name/floatMarginX).
- (double)floatMarginXPercent

Discussion

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 FMIceLinkLayoutPreset#[floatMarginX](#//api/name/floatMarginX).

Declared In

FMIceLinkLayoutPreset.h

– floatMarginY

Gets the Y-margin between floating elements and the layout edge in pixels. Overrides FMIceLinkLayoutPreset#[floatMarginYPercent](#//api/name/floatMarginYPercent).
- (int)floatMarginY

Discussion

Gets the Y-margin between floating elements and the layout edge in pixels. Overrides FMIceLinkLayoutPreset#[floatMarginYPercent](#//api/name/floatMarginYPercent).

Declared In

FMIceLinkLayoutPreset.h

– floatMarginYPercent

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 FMIceLinkLayoutPreset#[floatMarginY](#//api/name/floatMarginY).
- (double)floatMarginYPercent

Discussion

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 FMIceLinkLayoutPreset#[floatMarginY](#//api/name/floatMarginY).

Declared In

FMIceLinkLayoutPreset.h

– floatWidth

Gets the width of floating elements in pixels. Overrides FMIceLinkLayoutPreset#[floatWidthPercent](#//api/name/floatWidthPercent).
- (int)floatWidth

Discussion

Gets the width of floating elements in pixels. Overrides FMIceLinkLayoutPreset#[floatWidthPercent](#//api/name/floatWidthPercent).

Declared In

FMIceLinkLayoutPreset.h

– floatWidthPercent

Gets the width of floating elements as a percent of the container width between 0.0 and 1.0. Overrides FMIceLinkLayoutPreset#[floatWidth](#//api/name/floatWidth).
- (double)floatWidthPercent

Discussion

Gets the width of floating elements as a percent of the container width between 0.0 and 1.0. Overrides FMIceLinkLayoutPreset#[floatWidth](#//api/name/floatWidth).

Declared In

FMIceLinkLayoutPreset.h

+ googleHangouts

Gets a Google Hangouts-style layout preset. Note that this will present differently on mobile devices.
+ (FMIceLinkLayoutPreset *)googleHangouts

Discussion

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

Declared In

FMIceLinkLayoutPreset.h

– init

Initializes a new instance of the FMIceLinkLayoutPreset class.
- (instancetype)init

Discussion

Initializes a new instance of the FMIceLinkLayoutPreset class.

Declared In

FMIceLinkLayoutPreset.h

– inlineMargin

Gets the size of the margin in pixels to use between inline elements.
- (int)inlineMargin

Discussion

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

Declared In

FMIceLinkLayoutPreset.h

+ layoutPreset

Initializes a new instance of the FMIceLinkLayoutPreset class.
+ (FMIceLinkLayoutPreset *)layoutPreset

Discussion

Initializes a new instance of the FMIceLinkLayoutPreset class.

Declared In

FMIceLinkLayoutPreset.h

– mode

Gets the mode used by the layout engine. Defaults to FMIceLinkLayoutModeFloatLocal.
- (FMIceLinkLayoutMode)mode

Discussion

Gets the mode used by the layout engine. Defaults to FMIceLinkLayoutModeFloatLocal.

Declared In

FMIceLinkLayoutPreset.h

– setAlignment:

Sets the [alignment](#//api/name/alignment) of the layout. Defaults to FMIceLinkLayoutAlignmentBottomRight.
- (void)setAlignment:(FMIceLinkLayoutAlignment)value

Discussion

Sets the [alignment](#//api/name/alignment) of the layout. Defaults to FMIceLinkLayoutAlignmentBottomRight.

Declared In

FMIceLinkLayoutPreset.h

– setBlockHeight:

Sets the height of block elements in pixels. Overrides FMIceLinkLayoutPreset#[blockHeightPercent](#//api/name/blockHeightPercent).
- (void)setBlockHeight:(int)value

Discussion

Sets the height of block elements in pixels. Overrides FMIceLinkLayoutPreset#[blockHeightPercent](#//api/name/blockHeightPercent).

Declared In

FMIceLinkLayoutPreset.h

– setBlockHeightPercent:

Sets the height of block elements as a percent of the container height between 0.0 and 1.0. Overrides FMIceLinkLayoutPreset#[blockHeight](#//api/name/blockHeight).
- (void)setBlockHeightPercent:(double)value

Discussion

Sets the height of block elements as a percent of the container height between 0.0 and 1.0. Overrides FMIceLinkLayoutPreset#[blockHeight](#//api/name/blockHeight).

Declared In

FMIceLinkLayoutPreset.h

– setBlockMarginX:

Sets the X-margin between block elements and the layout edge in pixels. Overrides FMIceLinkLayoutPreset#[blockMarginXPercent](#//api/name/blockMarginXPercent).
- (void)setBlockMarginX:(int)value

Discussion

Sets the X-margin between block elements and the layout edge in pixels. Overrides FMIceLinkLayoutPreset#[blockMarginXPercent](#//api/name/blockMarginXPercent).

Declared In

FMIceLinkLayoutPreset.h

– setBlockMarginXPercent:

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 FMIceLinkLayoutPreset#[blockMarginX](#//api/name/blockMarginX).
- (void)setBlockMarginXPercent:(double)value

Discussion

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 FMIceLinkLayoutPreset#[blockMarginX](#//api/name/blockMarginX).

Declared In

FMIceLinkLayoutPreset.h

– setBlockMarginY:

Sets the Y-margin between block elements and the layout edge in pixels. Overrides FMIceLinkLayoutPreset#[blockMarginYPercent](#//api/name/blockMarginYPercent).
- (void)setBlockMarginY:(int)value

Discussion

Sets the Y-margin between block elements and the layout edge in pixels. Overrides FMIceLinkLayoutPreset#[blockMarginYPercent](#//api/name/blockMarginYPercent).

Declared In

FMIceLinkLayoutPreset.h

– setBlockMarginYPercent:

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 FMIceLinkLayoutPreset#[blockMarginY](#//api/name/blockMarginY).
- (void)setBlockMarginYPercent:(double)value

Discussion

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 FMIceLinkLayoutPreset#[blockMarginY](#//api/name/blockMarginY).

Declared In

FMIceLinkLayoutPreset.h

– setBlockWidth:

Sets the width of block elements in pixels. Overrides FMIceLinkLayoutPreset#[blockWidthPercent](#//api/name/blockWidthPercent).
- (void)setBlockWidth:(int)value

Discussion

Sets the width of block elements in pixels. Overrides FMIceLinkLayoutPreset#[blockWidthPercent](#//api/name/blockWidthPercent).

Declared In

FMIceLinkLayoutPreset.h

– setBlockWidthPercent:

Sets the width of block elements as a percent of the container width between 0.0 and 1.0. Overrides FMIceLinkLayoutPreset#[blockWidth](#//api/name/blockWidth).
- (void)setBlockWidthPercent:(double)value

Discussion

Sets the width of block elements as a percent of the container width between 0.0 and 1.0. Overrides FMIceLinkLayoutPreset#[blockWidth](#//api/name/blockWidth).

Declared In

FMIceLinkLayoutPreset.h

– setDirection:

Sets the [direction](#//api/name/direction) of the layout flow. Defaults to FMIceLinkLayoutDirectionHorizontal.
- (void)setDirection:(FMIceLinkLayoutDirection)value

Discussion

Sets the [direction](#//api/name/direction) of the layout flow. Defaults to FMIceLinkLayoutDirectionHorizontal.

Declared In

FMIceLinkLayoutPreset.h

– setFloatHeight:

Sets the height of floating elements in pixels. Overrides FMIceLinkLayoutPreset#[floatHeightPercent](#//api/name/floatHeightPercent).
- (void)setFloatHeight:(int)value

Discussion

Sets the height of floating elements in pixels. Overrides FMIceLinkLayoutPreset#[floatHeightPercent](#//api/name/floatHeightPercent).

Declared In

FMIceLinkLayoutPreset.h

– setFloatHeightPercent:

Sets the height of floating elements as a percent of the container height between 0.0 and 1.0. Overrides FMIceLinkLayoutPreset#[floatHeight](#//api/name/floatHeight).
- (void)setFloatHeightPercent:(double)value

Discussion

Sets the height of floating elements as a percent of the container height between 0.0 and 1.0. Overrides FMIceLinkLayoutPreset#[floatHeight](#//api/name/floatHeight).

Declared In

FMIceLinkLayoutPreset.h

– setFloatMarginX:

Sets the X-margin between floating elements and the layout edge in pixels. Overrides FMIceLinkLayoutPreset#[floatMarginXPercent](#//api/name/floatMarginXPercent).
- (void)setFloatMarginX:(int)value

Discussion

Sets the X-margin between floating elements and the layout edge in pixels. Overrides FMIceLinkLayoutPreset#[floatMarginXPercent](#//api/name/floatMarginXPercent).

Declared In

FMIceLinkLayoutPreset.h

– setFloatMarginXPercent:

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 FMIceLinkLayoutPreset#[floatMarginX](#//api/name/floatMarginX).
- (void)setFloatMarginXPercent:(double)value

Discussion

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 FMIceLinkLayoutPreset#[floatMarginX](#//api/name/floatMarginX).

Declared In

FMIceLinkLayoutPreset.h

– setFloatMarginY:

Sets the Y-margin between floating elements and the layout edge in pixels. Overrides FMIceLinkLayoutPreset#[floatMarginYPercent](#//api/name/floatMarginYPercent).
- (void)setFloatMarginY:(int)value

Discussion

Sets the Y-margin between floating elements and the layout edge in pixels. Overrides FMIceLinkLayoutPreset#[floatMarginYPercent](#//api/name/floatMarginYPercent).

Declared In

FMIceLinkLayoutPreset.h

– setFloatMarginYPercent:

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 FMIceLinkLayoutPreset#[floatMarginY](#//api/name/floatMarginY).
- (void)setFloatMarginYPercent:(double)value

Discussion

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 FMIceLinkLayoutPreset#[floatMarginY](#//api/name/floatMarginY).

Declared In

FMIceLinkLayoutPreset.h

– setFloatWidth:

Sets the width of floating elements in pixels. Overrides FMIceLinkLayoutPreset#[floatWidthPercent](#//api/name/floatWidthPercent).
- (void)setFloatWidth:(int)value

Discussion

Sets the width of floating elements in pixels. Overrides FMIceLinkLayoutPreset#[floatWidthPercent](#//api/name/floatWidthPercent).

Declared In

FMIceLinkLayoutPreset.h

– setFloatWidthPercent:

Sets the width of floating elements as a percent of the container width between 0.0 and 1.0. Overrides FMIceLinkLayoutPreset#[floatWidth](#//api/name/floatWidth).
- (void)setFloatWidthPercent:(double)value

Discussion

Sets the width of floating elements as a percent of the container width between 0.0 and 1.0. Overrides FMIceLinkLayoutPreset#[floatWidth](#//api/name/floatWidth).

Declared In

FMIceLinkLayoutPreset.h

– setInlineMargin:

Sets the size of the margin in pixels to use between inline elements.
- (void)setInlineMargin:(int)value

Discussion

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

Declared In

FMIceLinkLayoutPreset.h

– setMode:

Sets the [mode](#//api/name/mode) used by the layout engine. Defaults to FMIceLinkLayoutModeFloatLocal.
- (void)setMode:(FMIceLinkLayoutMode)value

Discussion

Sets the [mode](#//api/name/mode) used by the layout engine. Defaults to FMIceLinkLayoutModeFloatLocal.

Declared In

FMIceLinkLayoutPreset.h

+ skype

Gets a Skype-style layout preset. Note that this will present differently on mobile devices.
+ (FMIceLinkLayoutPreset *)skype

Discussion

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

Declared In

FMIceLinkLayoutPreset.h