StudioPreviewDto

Endpoints · All schemas

Field	Required	Description
admissionReleased	No	Delivery was durably fenced; does not establish renderer termination
cancellationState	No	string
consumerRequestId	No	Captured opt-in consumer admission identity
contentType	Yes	string
errorCode	Yes	Stable code the client turns into a message
etag	Yes	Revision-bound entity tag for the frame endpoint
expiresAt	Yes	string
framePts	Yes	string
framePtsTimebase	Yes	string
id	Yes	Preview frame ID
operationId	Yes	The durable job rendering this frame, when one has been created
projectId	Yes	string
quality	Yes	See definition below
readyAt	Yes	string
rendererReleased	No	True only after the captured operation acknowledged cancellation with resources released
requestedAt	Yes	string
revision	Yes	The stored project revision this frame was rendered for
revisionDigest	Yes	Digest of the authorized resolution the frame is bound to; changes with the revision and whenever access is re-resolved
seekGeneration	Yes	The seek this frame answers
sizeInBytes	Yes	string
status	Yes	See definition below
time	Yes	See definition below
toneMapped	Yes	The frame is an explicitly tone-mapped SDR rendering; never the colour authority
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, StudioPreviewStatus, StudioPreviewTimeDto

{
  "properties": {
    "admissionReleased": {
      "description": "Delivery was durably fenced; does not establish renderer termination",
      "type": "boolean"
    },
    "cancellationState": {
      "enum": [
        "not-needed",
        "requested",
        "acknowledged",
        "unavailable"
      ],
      "type": "string"
    },
    "consumerRequestId": {
      "description": "Captured opt-in consumer admission identity",
      "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"
    },
    "contentType": {
      "nullable": true,
      "type": "string"
    },
    "errorCode": {
      "description": "Stable code the client turns into a message",
      "nullable": true,
      "type": "string"
    },
    "etag": {
      "description": "Revision-bound entity tag for the frame endpoint",
      "type": "string"
    },
    "expiresAt": {
      "format": "date-time",
      "nullable": true,
      "type": "string"
    },
    "framePts": {
      "nullable": true,
      "type": "string"
    },
    "framePtsTimebase": {
      "nullable": true,
      "type": "string"
    },
    "id": {
      "description": "Preview frame ID",
      "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"
    },
    "operationId": {
      "description": "The durable job rendering this frame, when one has been created",
      "format": "uuid",
      "nullable": true,
      "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"
    },
    "projectId": {
      "type": "string"
    },
    "quality": {
      "$ref": "#/components/schemas/StudioPreviewQuality"
    },
    "readyAt": {
      "format": "date-time",
      "nullable": true,
      "type": "string"
    },
    "rendererReleased": {
      "description": "True only after the captured operation acknowledged cancellation with resources released",
      "nullable": true,
      "type": "boolean"
    },
    "requestedAt": {
      "format": "date-time",
      "type": "string"
    },
    "revision": {
      "description": "The stored project revision this frame was rendered for",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "revisionDigest": {
      "description": "Digest of the authorized resolution the frame is bound to; changes with the revision and whenever access is re-resolved",
      "type": "string"
    },
    "seekGeneration": {
      "description": "The seek this frame answers",
      "type": "string"
    },
    "sizeInBytes": {
      "nullable": true,
      "type": "string"
    },
    "status": {
      "$ref": "#/components/schemas/StudioPreviewStatus"
    },
    "time": {
      "$ref": "#/components/schemas/StudioPreviewTimeDto"
    },
    "toneMapped": {
      "description": "The frame is an explicitly tone-mapped SDR rendering; never the colour authority",
      "type": "boolean"
    },
    "viewportHeight": {
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    },
    "viewportWidth": {
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    }
  },
  "required": [
    "contentType",
    "errorCode",
    "etag",
    "expiresAt",
    "framePts",
    "framePtsTimebase",
    "id",
    "operationId",
    "projectId",
    "quality",
    "readyAt",
    "requestedAt",
    "revision",
    "revisionDigest",
    "seekGeneration",
    "sizeInBytes",
    "status",
    "time",
    "toneMapped",
    "viewportHeight",
    "viewportWidth"
  ],
  "type": "object"
}