Layout

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/vonage/main/json-schema/vonage-layout-schema.json",
  "title": "Layout",
  "x-generated": "2026-10-08",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/vonage-video-openapi.yml#/components/schemas/Layout",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "Specify this to assign the initial layout type for the archive. This applies only to composed archives. This object has three properties: type, stylesheet, and screenshareType, which are each strings. 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.) 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. If you do not specify an initial layout type, the archive uses the best fit layout type.",
      "enum": [
        "bestFit",
        "custom",
        "horizontalPresentation",
        "pip",
        "verticalPresentation"
      ]
    },
    "stylesheet": {
      "type": "string",
      "description": "Used for the `custom` layout to define the visual layout"
    },
    "screenshareType": {
      "type": "string",
      "enum": [
        "bestFit",
        "custom",
        "horizontalPresentation",
        "pip",
        "verticalPresentation"
      ],
      "description": "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."
    }
  }
}