StudioPreviewStreamOpenDto

Endpoints · All schemas

Field	Required	Description
projectId	Yes	Studio project to play
quality	Yes	See definition below
revision	Yes	Stored project revision to play; a superseded revision is refused
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": {
    "projectId": {
      "description": "Studio project to play",
      "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 to play; a superseded revision is refused",
      "maximum": 9007199254740991,
      "minimum": 1,
      "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"
}