Class VideoLayout

A description of the layout within a mixed video view.

Inheritance

System.Object

VideoLayout

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ToString()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: FM.LiveSwitch

Assembly: FM.LiveSwitch.dll

Syntax

public class VideoLayout

Constructors

VideoLayout(Int32, Int32)

Initializes a new instance of the VideoLayout class.

Declaration

public VideoLayout(int width, int height)

Parameters

Type	Name	Description
System.Int32	width
System.Int32	height

VideoLayout(Int32, Int32, Boolean)

Initializes a new instance of the VideoLayout class.

Declaration

public VideoLayout(int width, int height, bool crop)

Parameters

Type	Name	Description
System.Int32	width
System.Int32	height
System.Boolean	crop

VideoLayout(Int32, Int32, Dictionary<String, LayoutFrame>, Dictionary<String, LayoutFrame>)

Initializes a new instance of the VideoLayout class.

Declaration

public VideoLayout(int width, int height, Dictionary<string, LayoutFrame> frames, Dictionary<string, LayoutFrame> bounds)

Parameters

Type	Name	Description
System.Int32	width
System.Int32	height
System.Collections.Generic.Dictionary<System.String, LayoutFrame>	frames
System.Collections.Generic.Dictionary<System.String, LayoutFrame>	bounds

VideoLayout(Int32, Int32, Dictionary<String, LayoutFrame>, Dictionary<String, LayoutFrame>, Boolean)

Initializes a new instance of the VideoLayout class.

Declaration

public VideoLayout(int width, int height, Dictionary<string, LayoutFrame> frames, Dictionary<string, LayoutFrame> bounds, bool crop)

Parameters

Type	Name	Description
System.Int32	width
System.Int32	height
System.Collections.Generic.Dictionary<System.String, LayoutFrame>	frames
System.Collections.Generic.Dictionary<System.String, LayoutFrame>	bounds
System.Boolean	crop

Properties

Bounds

Gets or sets the bounds, keyed by connection ID.

Declaration

public Dictionary<string, LayoutFrame> Bounds { get; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, LayoutFrame>

Crop

Gets or sets whether to crop.

Declaration

public bool Crop { get; }

Property Value

Type	Description
System.Boolean

Frames

Gets or sets the frames, keyed by connection ID.

Declaration

public Dictionary<string, LayoutFrame> Frames { get; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, LayoutFrame>

Height

Gets or sets the video height.

Declaration

public int Height { get; }

Property Value

Type	Description
System.Int32

Regions

Gets the regions within the layout where each region has a frame, bounds, and client/connection information.

Declaration

public VideoLayoutRegion[] Regions { get; }

Property Value

Type	Description
VideoLayoutRegion[]

Width

Gets or sets the video width.

Declaration

public int Width { get; }

Property Value

Type	Description
System.Int32

Methods

FromJson(String)

Deserializes a view from JSON.

Declaration

public static VideoLayout FromJson(string videoLayoutJson)

Parameters

Type	Name	Description
System.String	videoLayoutJson	The layout JSON.

Returns

Type	Description
VideoLayout

IsEquivalent(VideoLayout)

Determines whether the specified video layout is equivalent.

Declaration

public bool IsEquivalent(VideoLayout videoLayout)

Parameters

Type	Name	Description
VideoLayout	videoLayout	The video layout.

Returns

Type	Description
System.Boolean

ToJson()

Serializes this instance to JSON.

Declaration

public string ToJson()

Returns

Type	Description
System.String

ToJson(VideoLayout)

Serializes a view to JSON.

Declaration

public static string ToJson(VideoLayout videoLayout)

Parameters

Type	Name	Description
VideoLayout	videoLayout	The layout.

Returns

Type	Description
System.String