Module Values.PipConfigurationSource

Configuration information specific to Picture-in-Picture (PiP) layout, for 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. videoFillMode : VideoFillMode.t option;
    (*

    Defines how video content fits within the participant tile: FILL (stretched), COVER (cropped), or CONTAIN (letterboxed). Default: COVER.

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

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

    *)
  5. pipParticipantAttribute : AttributeKey.t option;
    (*

    Specifies the participant for the PiP window. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the PiP slot. Default: "" (no PiP participant).

    *)
  6. pipBehavior : PipBehavior.t option;
    (*

    Defines PiP behavior when all participants have left: STATIC (maintains original position/size) or DYNAMIC (expands to full composition). Default: STATIC.

    *)
  7. pipOffset : PipOffset.t option;
    (*

    Sets the PiP window’s offset position in pixels from the closest edges determined by PipPosition. Default: 0.

    *)
  8. pipPosition : PipPosition.t option;
    (*

    Determines the corner position of the PiP window. Default: BOTTOM_RIGHT.

    *)
  9. pipWidth : PipWidth.t option;
    (*

    Specifies the width of the PiP window in pixels. When this is not set explicitly, pipWidth’s value will be based on the size of the composition and the aspect ratio of the participant’s video.

    *)
  10. pipHeight : PipHeight.t option;
    (*

    Specifies the height of the PiP window in pixels. When this is not set explicitly, pipHeight’s value will be based on the size of the composition and the aspect ratio of the participant’s video.

    *)
  11. 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:??? -> ?videoFillMode:??? -> ?gridGap:??? -> ?pipParticipantAttribute:??? -> ?pipBehavior:??? -> ?pipOffset:??? -> ?pipPosition:??? -> ?pipWidth:??? -> ?pipHeight:??? -> ?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