Skip to content

MemoryHighlightResponseDto

Endpoints · All schemas

FieldRequiredDescription
audioYesSee definition below
destinationYesSee definition below
lengthSecondsYesTarget length in seconds
progressYesRender progress, 0 to 100
resolutionYesSee definition below
savedAssetIdYesThe library asset the highlight was saved as, once saved

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: MemoryHighlightAudio, MemoryHighlightDestination, StudioExportResolution

{
  "properties": {
    "audio": {
      "$ref": "#/components/schemas/MemoryHighlightAudio"
    },
    "destination": {
      "$ref": "#/components/schemas/MemoryHighlightDestination"
    },
    "lengthSeconds": {
      "description": "Target length in seconds",
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    },
    "progress": {
      "description": "Render progress, 0 to 100",
      "maximum": 100,
      "minimum": 0,
      "type": "integer"
    },
    "resolution": {
      "$ref": "#/components/schemas/StudioExportResolution"
    },
    "savedAssetId": {
      "description": "The library asset the highlight was saved as, once saved",
      "format": "uuid",
      "nullable": true,
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    }
  },
  "required": [
    "audio",
    "destination",
    "lengthSeconds",
    "progress",
    "resolution",
    "savedAssetId"
  ],
  "type": "object"
}