Class Layout

Namespace

Vonage.Server

Assembly

Vonage.dll

Represents a layout.

public record Layout : IEquatable<Layout>

Inheritance

object

Layout

Implements

IEquatable<Layout>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Layout(LayoutType?, string, LayoutType)

Represents a layout.

public Layout(LayoutType? ScreenshareType, string Stylesheet, LayoutType Type)

Parameters

ScreenshareType LayoutType?

Set the screenshareType property to the layout type to use when there is a screen-sharing stream in the session. (This property is optional.) Note if you set the screenshareType property, you must set the type property to "bestFit" and leave the stylesheet property unset.

Stylesheet string

Used for the custom layout to define the visual layout.

Type LayoutType

Specify this to assign the initial layout type for the archive. This applies only to composed archives. Valid values for the layout property are "bestFit" (best fit), "custom" (custom), "horizontalPresentation" (horizontal presentation), "pip" (picture-in-picture), and "verticalPresentation" (vertical presentation)). If you specify a "custom" layout type, set the stylesheet property of the layout object to the stylesheet. (For other layout types, do not set a stylesheet property.).

Properties

ScreenshareType

Set the screenshareType property to the layout type to use when there is a screen-sharing stream in the session. (This property is optional.) Note if you set the screenshareType property, you must set the type property to "bestFit" and leave the stylesheet property unset.

[JsonPropertyOrder(2)]
public LayoutType? ScreenshareType { get; init; }

Property Value

LayoutType?

Stylesheet

Used for the custom layout to define the visual layout.

[JsonPropertyOrder(1)]
public string Stylesheet { get; init; }

Property Value

string

Type

Specify this to assign the initial layout type for the archive. This applies only to composed archives. Valid values for the layout property are "bestFit" (best fit), "custom" (custom), "horizontalPresentation" (horizontal presentation), "pip" (picture-in-picture), and "verticalPresentation" (vertical presentation)). If you specify a "custom" layout type, set the stylesheet property of the layout object to the stylesheet. (For other layout types, do not set a stylesheet property.).

[JsonPropertyOrder(0)]
public LayoutType Type { get; init; }

Property Value

LayoutType