Module Values.GridConfigurationSource

Configuration information specific to Grid layout, for server-side composition. See "Layouts" in Server-Side Composition.

Sourcetype nonrec t = {
  1. featuredParticipantAttribute : AttributeKey.t option;
    (*

    This attribute name identifies the featured slot. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the featured slot. Default: "" (no featured participant).

    *)
  2. omitStoppedVideo : OmitStoppedVideo.t option;
    (*

    Determines whether to omit participants with stopped video in the composition. Default: false.

    *)
  3. videoAspectRatio : VideoAspectRatio.t option;
    (*

    Sets the non-featured participant display mode, to control the aspect ratio of video tiles. VIDEO is 16:9, SQUARE is 1:1, and PORTRAIT is 3:4. Default: VIDEO.

    *)
  4. videoFillMode : VideoFillMode.t option;
    (*

    Defines how video content fits within the participant tile: FILL (stretched), COVER (cropped), or CONTAIN (letterboxed). When not set, videoFillMode defaults to COVER fill mode for participants in the grid and to CONTAIN fill mode for featured participants.

    *)
  5. gridGap : GridGap.t option;
    (*

    Specifies the spacing between participant tiles in pixels. Default: 2.

    *)
  6. participantOrderAttribute : AttributeKey.t option;
    (*

    Attribute name in ParticipantTokenConfiguration identifying the participant ordering key. Participants with participantOrderAttribute set to "" or not specified are ordered based on their arrival time into the stage.

    *)
}
Sourceval make : ?featuredParticipantAttribute:??? -> ?omitStoppedVideo:??? -> ?videoAspectRatio:??? -> ?videoFillMode:??? -> ?gridGap:??? -> ?participantOrderAttribute:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of OmitStoppedVideo.t | `Enum of string | `Integer of GridGap.t | `String of AttributeKey.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t