StudioPreviewRequestDto

Endpoints · All schemas

Field	Required	Description
consumerRequestId	No	Opt in to a session-isolated admission; use a fresh UUID for each logical request
projectId	Yes	Studio project the frame belongs to
quality	Yes	See definition below
revision	Yes	Stored project revision the frame is bound to; a superseded revision is refused
seekGeneration	No	The client's monotonic seek counter, echoed back on the result
time	Yes	See definition below
viewportHeight	Yes	integer
viewportWidth	Yes	integer

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

Field definitions: StudioPreviewQuality, StudioPreviewTimeDto

{
  "properties": {
    "consumerRequestId": {
      "description": "Opt in to a session-isolated admission; use a fresh UUID for each logical request",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "type": "string"
    },
    "projectId": {
      "description": "Studio project the frame belongs to",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    },
    "quality": {
      "$ref": "#/components/schemas/StudioPreviewQuality"
    },
    "revision": {
      "description": "Stored project revision the frame is bound to; a superseded revision is refused",
      "maximum": 9007199254740991,
      "minimum": 1,
      "type": "integer"
    },
    "seekGeneration": {
      "default": 0,
      "description": "The client's monotonic seek counter, echoed back on the result",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "time": {
      "$ref": "#/components/schemas/StudioPreviewTimeDto"
    },
    "viewportHeight": {
      "maximum": 7680,
      "minimum": 16,
      "type": "integer"
    },
    "viewportWidth": {
      "maximum": 7680,
      "minimum": 16,
      "type": "integer"
    }
  },
  "required": [
    "projectId",
    "quality",
    "revision",
    "time",
    "viewportHeight",
    "viewportWidth"
  ],
  "type": "object"
}