Class LayoutPreset
A layout preset.
Implements
Inherited Members
Namespace: FM.LiveSwitch
Assembly: FM.LiveSwitch.dll
Syntax
public class LayoutPreset : Dynamic, IEquatable<NSObject>, INSObjectProtocol, INativeObject, IDisposableConstructors
LayoutPreset()
Initializes a new instance of the LayoutPreset class.
Declaration
public LayoutPreset()Properties
Alignment
Gets or sets the alignment of the layout. Defaults to BottomRight.
Declaration
public virtual LayoutAlignment Alignment { get; set; }Property Value
| Type | Description |
|---|---|
| LayoutAlignment |
BlockHeight
Gets or sets the height of block elements in pixels. Overrides BlockHeightPercent.
Declaration
public int BlockHeight { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
BlockHeightPercent
Gets or sets the height of block elements as a percent of the container height between 0.0 and 1.0. Overrides BlockHeight.
Declaration
public double BlockHeightPercent { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double |
BlockMarginX
Gets or sets the X-margin between block elements and the layout edge in pixels. Overrides BlockMarginXPercent.
Declaration
public int BlockMarginX { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
BlockMarginXPercent
Gets or 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 BlockMarginX.
Declaration
public double BlockMarginXPercent { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double |
BlockMarginY
Gets or sets the Y-margin between block elements and the layout edge in pixels. Overrides BlockMarginYPercent.
Declaration
public int BlockMarginY { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
BlockMarginYPercent
Gets or 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 BlockMarginY.
Declaration
public double BlockMarginYPercent { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double |
BlockWidth
Gets or sets the width of block elements in pixels. Overrides BlockWidthPercent.
Declaration
public int BlockWidth { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
BlockWidthPercent
Gets or sets the width of block elements as a percent of the container width between 0.0 and 1.0. Overrides BlockWidth.
Declaration
public double BlockWidthPercent { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double |
Direction
Gets or sets the direction of the layout flow. Defaults to Horizontal.
Declaration
public virtual LayoutDirection Direction { get; set; }Property Value
| Type | Description |
|---|---|
| LayoutDirection |
Facetime
Gets a Facetime-style layout preset.
Declaration
public static LayoutPreset Facetime { get; }Property Value
| Type | Description |
|---|---|
| LayoutPreset |
FloatHeight
Gets or sets the height of floating elements in pixels. Overrides FloatHeightPercent.
Declaration
public int FloatHeight { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
FloatHeightPercent
Gets or sets the height of floating elements as a percent of the container height between 0.0 and 1.0. Overrides FloatHeight.
Declaration
public double FloatHeightPercent { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double |
FloatMarginX
Gets or sets the X-margin between floating elements and the layout edge in pixels. Overrides FloatMarginXPercent.
Declaration
public int FloatMarginX { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
FloatMarginXPercent
Gets or 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 FloatMarginX.
Declaration
public double FloatMarginXPercent { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double |
FloatMarginY
Gets or sets the Y-margin between floating elements and the layout edge in pixels. Overrides FloatMarginYPercent.
Declaration
public int FloatMarginY { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
FloatMarginYPercent
Gets or 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 FloatMarginY.
Declaration
public double FloatMarginYPercent { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double |
FloatWidth
Gets or sets the width of floating elements in pixels. Overrides FloatWidthPercent.
Declaration
public int FloatWidth { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
FloatWidthPercent
Gets or sets the width of floating elements as a percent of the container width between 0.0 and 1.0. Overrides FloatWidth.
Declaration
public double FloatWidthPercent { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double |
GoogleHangouts
Gets a Google Hangouts-style layout preset. Note that this will present differently on mobile devices.
Declaration
public static LayoutPreset GoogleHangouts { get; }Property Value
| Type | Description |
|---|---|
| LayoutPreset |
InlineMargin
Gets or sets the size of the margin in pixels to use between inline elements.
Declaration
public int InlineMargin { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
Mode
Gets or sets the mode used by the layout engine. Defaults to FloatLocal.
Declaration
public virtual LayoutMode Mode { get; set; }Property Value
| Type | Description |
|---|---|
| LayoutMode |
Skype
Gets a Skype-style layout preset. Note that this will present differently on mobile devices.
Declaration
public static LayoutPreset Skype { get; }Property Value
| Type | Description |
|---|---|
| LayoutPreset |
Methods
ApplyPreset(LayoutPreset)
Applies a preset.
Declaration
public void ApplyPreset(LayoutPreset preset)Parameters
| Type | Name | Description |
|---|---|---|
| LayoutPreset | preset | The preset to apply. |
CalculateLayout(Int32, Int32, Boolean, Int32, LayoutOrigin, Size, Size[])
Gets a video frame layout.
Declaration
public Layout CalculateLayout(int layoutWidth, int layoutHeight, bool local, int remoteCount, LayoutOrigin origin, Size localVideoSize, Size[] remoteVideoSizes)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | layoutWidth | The total width of the layout. |
| System.Int32 | layoutHeight | The total height of the layout. |
| System.Boolean | local | Whether a local frame is needed. |
| System.Int32 | remoteCount | The number of remote frames. |
| LayoutOrigin | origin | The layout origin. |
| Size | localVideoSize | The local video size. |
| Size[] | remoteVideoSizes | The remote video sizes. |
Returns
| Type | Description |
|---|---|
| Layout | The video frame layout. |
CalculateLayout(Int32, Int32, Int32, LayoutOrigin)
Gets a video frame layout.
Declaration
public Layout CalculateLayout(int layoutWidth, int layoutHeight, int remoteCount, LayoutOrigin origin)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | layoutWidth | The total width of the layout. |
| System.Int32 | layoutHeight | The total height of the layout. |
| System.Int32 | remoteCount | The number of remote frames. |
| LayoutOrigin | origin | The layout origin. |
Returns
| Type | Description |
|---|---|
| Layout | The video frame layout. |
CopyToPreset(LayoutPreset)
Copies this preset's properties to another preset.
Declaration
public void CopyToPreset(LayoutPreset preset)Parameters
| Type | Name | Description |
|---|---|---|
| LayoutPreset | preset | The target preset. |