Transloadit

Änderungen einer Assembly live streamen

Streamt die Statusänderungen für eine Assembly als Server-Sent Events.

GET{UPDATE_STREAM_URL}

Nach dem Erstellen einer Assembly finden Sie in der Antwort zwei Felder zum Abrufen des Assembly Status: assembly_ssl_url und update_stream_url. Sie können den aktuellen Assembly Status abrufen, und zwar über die in assembly_ssl_url angegebene URL. Um Informationen über den Fortschritt der Assembly zu erhalten, können Sie diese URL entweder regelmäßig abfragen oder den Update-Stream abonnieren, der in diesem Dokument beschrieben wird.

Server-Sent Events

Die Eigenschaft update_stream_url im Assembly Status definiert eine URL, unter der der Update-Stream für die zugehörige Assembly per Server-Sent Events verfügbar ist.

Server-Sent Events sind eine Webtechnologie zum Senden von Live-Benachrichtigungen vom Server an einen Client über HTTP. Sie ähneln Web Sockets, erlauben jedoch nur unidirektionale Nachrichten vom Server an den Client und bestehen aus einem einfachen, textbasierten Format.

Während sich die Assembly entweder im Upload- oder im Ausführungszustand befindet, kann sich ein Client mit diesem Endpunkt verbinden, indem er eine GET-Anfrage mit dem Header-Feld Accept: text/event-stream an die in update_stream_url angegebene URL sendet und den Antwortstream parst. Der Server kann eine Mischung aus Nachrichten und Events an den Client senden. Der Unterschied zwischen beiden besteht darin, dass Events eine zusätzliche Nutzlast mit Informationen enthalten, Nachrichten hingegen nicht.

Mehrere Clients können dieselbe Assembly abonnieren. Wird eine Verbindung geschlossen, bleiben die anderen verbunden. Während ein Uploader heruntergefahren wird, werden bestehende Streams geschlossen, und neue Verbindungen erhalten eine leere HTTP-503-Antwort. Rufen Sie den aktuellen Assembly Status ab, um zu prüfen, ob die Verarbeitung beendet ist.

Nachrichten

Eine Nachricht besteht aus dem Nachrichtennamen und hat keine zusätzliche Nutzlast. Auf Übertragungsebene sieht eine Nachricht mit dem Namen assembly_finished so aus ([NL] steht für einen Zeilenumbruch):

data: assembly_finished[NL]
[NL]

Transloadit sendet die folgenden Nachrichten:

  • assembly_upload_meta_data_extracted wird ausgelöst, wenn alle Uploads abgeschlossen sind und die Metadaten für alle Uploads extrahiert wurden.
  • assembly_uploading_finished wird ausgelöst, wenn alle Uploads für diese Assembly abgeschlossen sind und die Assembly vom Upload- in den Ausführungszustand übergeht.
  • assembly_finished wird ausgelöst, wenn die Assembly beendet ist, nicht unbedingt dann, wenn die Verarbeitung erfolgreich war. Die Nachricht wird auch nach einem Abbruch gesendet oder wenn eine Verbindung zu einer bereits beendeten Assembly hergestellt wird, auch zu einer fehlgeschlagenen. Der Server beendet den Stream nach dieser Nachricht. Rufen Sie assembly_ssl_url ab und prüfen Sie den endgültigen Status: ok: "ASSEMBLY_COMPLETED" zeigt Erfolg an, ok: "ASSEMBLY_CANCELED" zeigt einen Abbruch an und error zeigt einen Fehlschlag an.
  • ping wird regelmäßig ausgelöst, um die Verbindung aufrechtzuerhalten, während die Assembly verarbeitet wird. Derzeit wird es jede Minute gesendet, dieses Intervall kann sich jedoch künftig ändern.

Events

Ein Event besteht aus dem Event-Namen und einer zusätzlichen Nutzlast. Auf Übertragungsebene sieht ein Event mit dem Namen assembly_result_finished so aus ([NL] steht für einen Zeilenumbruch):

event: assembly_result_finished[NL]
data: ["avatar",{"id":"5789e06b48ad450aa55f9b3721376581","basename":"lesereihe","field":"file","md5hash":"e9df77e5ee87e8ec3b4453bcddf191bc","ext":"pdf","meta":{"width":1238,"height":1750,"page_count":1},"mime":"application/pdf","name":"lesereihe.pdf","size":120456,"type":"pdf"}][NL]
[NL]

Transloadit sendet die folgenden Events:

  • assembly_error wird ausgelöst, wenn während der Ausführung der Assembly ein Fehler auftritt. Der Server beendet den Stream nach diesem Event. Zusätzliche Informationen zum Fehler sind enthalten, zum Beispiel:

    {
  "error": "FILE_FILTER_DECLINED_FILE",
  "message": "One of your files was declined",
  "step": "filter",
  "previousStep": ":original",
  "http_code": 400
}

  • assembly_upload_finished wird für jeden abgeschlossenen Upload ausgelöst. Zusätzliche Informationen über die hochgeladene Datei sind enthalten. Die Struktur entspricht der eines Objekts im Array uploads aus dem Assembly Status, zum Beispiel:

    {
  "id": "6bb16f6cd49a44b4ae431f576e016c6d",
  "name": "lesereihe.doc",
  "basename": "lesereihe",
  "ext": "doc",
  "size": 61440,
  "mime": "application/msword",
  "type": "office",
  "field": "file",
  "md5hash": "154a9349b8f9111865a07ed0a7050f55",
  "original_id": "6bb16f6cd49a44b4ae431f576e016c6d",
  "url": null,
  "meta": {}
}

  • assembly_result_finished wird ausgelöst, sobald ein neues Ergebnis eines Steps verfügbar ist. Die Nutzlast ist ein Tupel [stepName, file]. Das Dateiobjekt hat dieselbe Struktur wie ein Eintrag in results[stepName] aus dem Assembly Status, zum Beispiel:

    [
  "avatar",
  {
    "id": "5789e06b48ad450aa55f9b3721376581",
    "basename": "lesereihe",
    "field": "file",
    "md5hash": "e9df77e5ee87e8ec3b4453bcddf191bc",
    "ext": "pdf",
    "meta": {
      "width": 1238,
      "height": 1750,
      "page_count": 1
    },
    "mime": "application/pdf",
    "name": "lesereihe.pdf",
    "size": 120456,
    "type": "pdf"
  }
]

  • assembly_execution_progress wird in regelmäßigen Abständen mit Informationen über den gesamten Execution Progress der Assembly und ihrer Dateien ausgelöst. Die Struktur und die Mechanismen werden in Assembly Execution Progress ausführlich beschrieben, zum Beispiel:

    {
  "progress_combined": 50,
  "progress_per_original_file": [
    {
      "original_id": "6bb16f6cd49a44b4ae431f576e016c6d",
      "progress": 50
    }
  ]
}

    Hinweis: progress_per_original_file ist nach original_id geschlüsselt. Importierte Dateien ohne original_id erscheinen nicht in dieser Liste.

Der Stream liefert frühere Events nicht nachträglich aus. Insbesondere kann ein assembly_error-Listener keinen Fehler melden, der aufgetreten ist, bevor Sie sich verbunden haben. Sobald sich die Assembly nicht mehr im Speicher des Uploaders befindet, gibt die Stream-URL HTTP 404 zurück. Bei einem Verbindungsabbruch oder einem nicht verfügbaren Stream rufen Sie assembly_ssl_url ab; wenn sich die Assembly noch im Upload oder in der Ausführung befindet, fragen Sie diese URL weiterhin regelmäßig ab. Ein geschlossener Stream allein belegt keinen Erfolg.

Beispiel in JavaScript

Moderne Browser unterstützen Server-Sent Events nativ über den Konstruktor EventSource. Angenommen, der Assembly Status ist in der Variablen assembly_status gespeichert, dann kann der Client wie folgt auf die Nachricht assembly_finished, die Nachricht assembly_uploading_finished und das Event assembly_result_finished hören: Wenn die Verbindung des Streams abbricht, wechselt dieses Beispiel zu einer Abfrage alle zwei Sekunden, bis die Assembly einen Endstatus erreicht. HTTP- oder Netzwerkfehler werden gemeldet, statt als Erfolg behandelt zu werden.

const stream = new EventSource(assembly_status.update_stream_url)
const activeStatuses = ["ASSEMBLY_UPLOADING","ASSEMBLY_EXECUTING","ASSEMBLY_REPLAYING"]
let pollingStarted = false

async function checkAssemblyStatus() {
  while (true) {
    const response = await fetch(assembly_status.assembly_ssl_url)
    if (!response.ok) {
      throw new Error(`Assembly status request failed: ${response.status}`)
    }
    const status = await response.json()
    if (status.error) {
      console.error('Assembly failed', status.error)
      return
    }
    if (status.ok === 'ASSEMBLY_COMPLETED') {
      console.log('Assembly completed', status.results)
      return
    }
    if (status.ok === 'ASSEMBLY_CANCELED') {
      console.warn('Assembly was canceled')
      return
    }
    if (!activeStatuses.includes(status.ok)) {
      throw new Error(`Assembly did not complete successfully: ${status.ok}`)
    }
    console.log('Assembly is not complete; continue polling its status URL', status.ok)
    await new Promise((resolve) => setTimeout(resolve, 2000))
  }
}

function closeStreamAndCheckStatus() {
  if (pollingStarted) return
  pollingStarted = true
  stream.close()
  checkAssemblyStatus().catch(console.error)
}

// Listen for the assembly_finished and assembly_uploading_finished messages
stream.addEventListener('message', (event) => {
  switch (event.data) {
    case 'assembly_finished':
      closeStreamAndCheckStatus()
      break
    case 'assembly_uploading_finished':
      console.log('All uploads are finished')
      break
  }
})

// Handle terminal Assembly errors without reconnecting the stream
stream.addEventListener('assembly_error', (event) => {
  const error = JSON.parse(event.data)
  console.error('Assembly failed', error)
  closeStreamAndCheckStatus()
})

// Recover from a disconnected or unavailable stream using the status URL
stream.addEventListener('error', closeStreamAndCheckStatus)

// Listen for the assembly_result_finished event
stream.addEventListener('assembly_result_finished', (event) => {
  const result = JSON.parse(event.data)
  console.log('Assembly result is available', result)
})

Anfragebeispiel

Setzen Sie UPDATE_STREAM_URL auf die vollständige URL aus update_stream_url in der Antwort auf die Erstellung der Assembly. Ersetzen Sie ihren Hostnamen nicht.

curl --fail-with-body -sS --request GET --no-buffer \
  --url "${UPDATE_STREAM_URL:?Set UPDATE_STREAM_URL}" \
  --header 'accept: text/event-stream'

Erforderliche Request-Header

  • accept (fester Wert), erforderlich. Akzeptierter Wert: "text/event-stream". Wiederholte Header-Werte werden vor dem Abgleich zusammengefügt.

Optionale Query-Parameter für die Antwort

  • callback (JavaScript-Callback-Name). Umschließt JSON-Antworten mit einem JSONP-Callback. Der Callback-Name muss ^(?:_jqjsp[0-9]*|jQuery[0-9]+_[0-9]+)$ entsprechen. Nur das letzte Vorkommen wird verwendet; ein leerer Wert wird ignoriert. Ungültige Callback-Namen geben HTTP 403 zurück. Die transformierte Antwort verwendet HTTP 200. Der Callback wird nach der Serialisierung der Antwort angewendet.

Anfrage

Es sind weder ein zusätzlicher Request-Body noch weitere Felder erforderlich.

Antwort

Hier sehen Sie ein Beispiel für einen Antworttext:

data: assembly_uploading_finished

event: assembly_upload_finished
data: {"id":"6bb16f6cd49a44b4ae431f576e016c6d","name":"lesereihe.doc","basename":"lesereihe","ext":"doc","size":61440,"mime":"application/msword","type":"office","field":"file","md5hash":"154a9349b8f9111865a07ed0a7050f55","original_id":"6bb16f6cd49a44b4ae431f576e016c6d","url":null,"meta":{}}

data: assembly_upload_meta_data_extracted

event: assembly_result_finished
data: ["avatar",{"id":"5789e06b48ad450aa55f9b3721376581","basename":"lesereihe","field":"file","md5hash":"e9df77e5ee87e8ec3b4453bcddf191bc","ext":"pdf","meta":{"width":1238,"height":1750,"page_count":1},"mime":"application/pdf","name":"lesereihe.pdf","size":120456,"type":"pdf"}]

event: assembly_execution_progress
data: {"progress_combined":100,"progress_per_original_file":[]}

data: assembly_finished

2xx-Erfolg

Antwortstream mit Server-Sent Events. text/event-stream

assembly_error

Benanntes Ereignis mit einer JSON-Nutzlast im Feld data. Der Server schließt den Stream nach dieser Benachrichtigung. Rufen Sie den endgültigen Status der Ressource ab, um das Ergebnis zu ermitteln.

Event-Payload
Vollständiges JSON Schema

JSON in einem neuen Tab öffnen

Auch Felder, die nicht für dieses Objekt aufgeführt sind, werden akzeptiert.

FeldTyp und Beschreibung
error
string (minimale Länge: 1)

Fehlercode, sofern verfügbar. Rufen Sie den finalen Assembly Status auch dann ab, wenn dieses Feld fehlt.

Bekannte Werte (363); andere Werte sind möglich
  • "ADMIN_PERMISSIONS_REQUIRED"
  • "AI_CHAT_VALIDATION"
  • "ASSEMBLY_ACCOUNT_MISMATCH"
  • "ASSEMBLY_CANNOT_BE_REPLAYED"
  • "ASSEMBLY_COULD_NOT_BE_CREATED"
  • "ASSEMBLY_CRASHED"
  • "ASSEMBLY_DISALLOWED_ROBOTS_USED"
  • "ASSEMBLY_EMPTY_STEPS"
  • "ASSEMBLY_EXECUTION_PROGRESS_NOT_ENABLED"
  • "ASSEMBLY_EXPIRED"
  • "ASSEMBLY_FILE_NOT_RESERVED"
  • "ASSEMBLY_INFINITE"
  • "ASSEMBLY_INVALID_NOTIFY_URL"
  • "ASSEMBLY_INVALID_NUM_EXPECTED_UPLOAD_FILES_PARAM"
  • "ASSEMBLY_INVALID_STEPS"
  • "ASSEMBLY_JOB_ENQUEUE_ERROR"
  • "ASSEMBLY_LIST_ERROR"
  • "ASSEMBLY_MEMORY_LIMIT_EXCEEDED"
  • "ASSEMBLY_NOTIFICATIONS_LIST_ERROR"
  • "ASSEMBLY_NOTIFICATION_LIST_ERROR"
  • "ASSEMBLY_NOTIFICATION_NOT_PERSISTED"
  • "ASSEMBLY_NOTIFICATION_NOT_REPLAYED"
  • "ASSEMBLY_NOT_CAPABLE"
  • "ASSEMBLY_NOT_FINISHED"
  • "ASSEMBLY_NOT_FOUND"
  • "ASSEMBLY_NOT_REPLAYED"
  • "ASSEMBLY_NO_CHARGEABLE_STEP"
  • "ASSEMBLY_NO_NOTIFY_URL"
  • "ASSEMBLY_NO_STEPS"
  • "ASSEMBLY_PLAN_FILE_SIZE_LIMIT_EXCEEDED"
  • "ASSEMBLY_ROBOT_MISSING"
  • "ASSEMBLY_SATURATED"
  • "ASSEMBLY_STATS_ERROR"
  • "ASSEMBLY_STATS_INVALID_TIME"
  • "ASSEMBLY_STATS_MISSING_REGION"
  • "ASSEMBLY_STATUS_FETCHING_RATE_LIMIT_REACHED"
  • "ASSEMBLY_STATUS_NOT_FOUND"
  • "ASSEMBLY_STATUS_PARSE_ERROR"
  • "ASSEMBLY_STEP_INVALID"
  • "ASSEMBLY_STEP_INVALID_ROBOT"
  • "ASSEMBLY_STEP_INVALID_USE"
  • "ASSEMBLY_STEP_NO_ROBOT"
  • "ASSEMBLY_STEP_UNKNOWN_ROBOT"
  • "ASSEMBLY_STEP_UNKNOWN_USE"
  • "ASSEMBLY_URL_TRANSFORM_MISSING"
  • "AUDIO_ARTWORK_VALIDATION"
  • "AUDIO_CONCAT_INVALID_INPUT"
  • "AUDIO_CONCAT_VALIDATION"
  • "AUDIO_ENCODE_VALIDATION"
  • "AUDIO_LOOP_VALIDATION"
  • "AUDIO_MERGE_VALIDATION"
  • "AUDIO_SPLIT_NO_OUTPUT"
  • "AUDIO_SPLIT_VALIDATION"
  • "AUDIO_WAVEFORM_VALIDATION"
  • "AUTH_EXPIRED"
  • "AUTH_KEYS_NOT_FOUND"
  • "AUTH_KEY_SCOPES_NOT_FOUND"
  • "AUTH_SECRET_NOT_RETRIEVED"
  • "AZURE_IMPORT_ACCESS_DENIED"
  • "AZURE_IMPORT_FAILURE"
  • "AZURE_IMPORT_NOT_FOUND"
  • "AZURE_IMPORT_VALIDATION"
  • "AZURE_STORE_ACCESS_DENIED"
  • "AZURE_STORE_NOT_FOUND"
  • "AZURE_STORE_VALIDATION"
  • "BACKBLAZE_IMPORT_ACCESS_DENIED"
  • "BACKBLAZE_IMPORT_FAILURE"
  • "BACKBLAZE_IMPORT_NOT_FOUND"
  • "BACKBLAZE_IMPORT_VALIDATION"
  • "BACKBLAZE_STORE_ACCESS_DENIED"
  • "BACKBLAZE_STORE_FAILURE"
  • "BACKBLAZE_STORE_VALIDATION"
  • "BAD_PRICING"
  • "BEARER_TOKEN_AUTH_KEY_MISMATCH"
  • "BEARER_TOKEN_EXPIRED"
  • "BEARER_TOKEN_INVALID"
  • "BILL_LIMIT_EXCEEDED"
  • "BOX_IMPORT_ACCESS_DENIED"
  • "BOX_IMPORT_FAILURE"
  • "BOX_IMPORT_NOT_FOUND"
  • "BOX_IMPORT_VALIDATION"
  • "BOX_STORE_COULD_NOT_PARSE_URL"
  • "BOX_STORE_VALIDATION"
  • "CANNOT_ACCEPT_NEW_ASSEMBLIES"
  • "CDN_REQUIRED"
  • "CLOUDFILES_IMPORT_ACCESS_DENIED"
  • "CLOUDFILES_IMPORT_FAILURE"
  • "CLOUDFILES_IMPORT_NOT_FOUND"
  • "CLOUDFILES_IMPORT_VALIDATION"
  • "CLOUDFILES_STORE_ACCESS_DENIED"
  • "CLOUDFILES_STORE_ERROR"
  • "CLOUDFILES_STORE_VALIDATION"
  • "CLOUDFLARE_IMPORT_ACCESS_DENIED"
  • "CLOUDFLARE_IMPORT_FAILURE"
  • "CLOUDFLARE_IMPORT_NOT_FOUND"
  • "CLOUDFLARE_IMPORT_VALIDATION"
  • "CLOUDFLARE_STORE_ACCESS_DENIED"
  • "CLOUDFLARE_STORE_NOT_FOUND"
  • "CLOUDFLARE_STORE_URL_VERIFICATION_FAILURE"
  • "CLOUDFLARE_STORE_VALIDATION"
  • "CLOUDFLARE_STORE_WRONG_REGION"
  • "CLOUD_AI_IMAGE_VALIDATION"
  • "DAM_STORAGE_UNAVAILABLE"
  • "DIGITALOCEAN_IMPORT_ACCESS_DENIED"
  • "DIGITALOCEAN_IMPORT_FAILURE"
  • "DIGITALOCEAN_IMPORT_NOT_FOUND"
  • "DIGITALOCEAN_IMPORT_VALIDATION"
  • "DIGITALOCEAN_STORE_ACCESS_DENIED"
  • "DIGITALOCEAN_STORE_NOT_FOUND"
  • "DIGITALOCEAN_STORE_VALIDATION"
  • "DIGITALOCEAN_STORE_WRONG_REGION"
  • "DOCUMENT_AUTOROTATE_VALIDATION"
  • "DOCUMENT_CONVERT_UNSUPPORTED_CONVERSION"
  • "DOCUMENT_CONVERT_VALIDATION"
  • "DOCUMENT_EXTRACT_VALIDATION"
  • "DOCUMENT_MERGE_UNSUPPORTED_CONVERSION"
  • "DOCUMENT_MERGE_VALIDATION"
  • "DOCUMENT_OCR_VALIDATION"
  • "DOCUMENT_OPTIMIZE_UNSUPPORTED_INPUT"
  • "DOCUMENT_OPTIMIZE_VALIDATION"
  • "DOCUMENT_SPLIT_VALIDATION"
  • "DOCUMENT_THUMBS_INVALID_INPUT"
  • "DOCUMENT_THUMBS_VALIDATION"
  • "DO_NOT_REUSE_ASSEMBLY_IDS"
  • "DROPBOX_IMPORT_ACCESS_DENIED"
  • "DROPBOX_IMPORT_FAILURE"
  • "DROPBOX_IMPORT_NOT_FOUND"
  • "DROPBOX_IMPORT_VALIDATION"
  • "DROPBOX_STORE_COULD_NOT_PARSE_URL"
  • "DROPBOX_STORE_VALIDATION"
  • "FILE_COMPRESS_INVALID_INPUT"
  • "FILE_COMPRESS_VALIDATION"
  • "FILE_DECOMPRESS_INVALID_INPUT"
  • "FILE_DECOMPRESS_PASSWORD_INCORRECT"
  • "FILE_DECOMPRESS_PASSWORD_REQUIRED"
  • "FILE_DECOMPRESS_VALIDATION"
  • "FILE_DOWNLOAD_ERROR"
  • "FILE_FILTER_DECLINED_FILE"
  • "FILE_FILTER_INVALID_OPERATOR"
  • "FILE_FILTER_VALIDATION"
  • "FILE_HASH_VALIDATION"
  • "FILE_META_DATA_ERROR"
  • "FILE_PREVIEW_VALIDATION"
  • "FILE_READ_VALIDATION_ERROR"
  • "FILE_SERVE_NO_RESULT"
  • "FILE_SERVE_VALIDATION"
  • "FILE_VERIFY_INVALID_FILE"
  • "FILE_VERIFY_VALIDATION"
  • "FILE_VIRUSSCAN_DECLINED_FILE"
  • "FILE_VIRUSSCAN_INVALID_INPUT"
  • "FILE_VIRUSSCAN_VALIDATION"
  • "FTP_IMPORT_ACCESS_DENIED"
  • "FTP_IMPORT_FAILURE"
  • "FTP_IMPORT_NOT_FOUND"
  • "FTP_IMPORT_VALIDATION"
  • "FTP_STORE_VALIDATION"
  • "GET_ACCOUNT_DB_ERROR"
  • "GET_ACCOUNT_UNKNOWN_AUTH_KEY"
  • "GOOGLE_IMPORT_ACCESS_DENIED"
  • "GOOGLE_IMPORT_FAILURE"
  • "GOOGLE_IMPORT_NOT_FOUND"
  • "GOOGLE_IMPORT_VALIDATION"
  • "GOOGLE_STORE_INVALID_INPUT"
  • "GOOGLE_STORE_VALIDATION"
  • "HTML_CONVERT_VALIDATION"
  • "HTTP_IMPORT_ACCESS_DENIED"
  • "HTTP_IMPORT_FAILURE"
  • "HTTP_IMPORT_NOT_FOUND"
  • "HTTP_IMPORT_VALIDATION"
  • "HTTP_REQUEST_FAILURE"
  • "HTTP_REQUEST_VALIDATION"
  • "IMAGE_BGREMOVE_VALIDATION"
  • "IMAGE_COPYRIGHT_DETECT_DECLINED_FILE"
  • "IMAGE_COPYRIGHT_DETECT_VALIDATION"
  • "IMAGE_DESCRIBE_VALIDATION"
  • "IMAGE_ENHANCE_NO_INPUT_FILE"
  • "IMAGE_ENHANCE_VALIDATION"
  • "IMAGE_FACEDETECT_VALIDATION"
  • "IMAGE_GENERATE_VALIDATION"
  • "IMAGE_MERGE_FAILURE"
  • "IMAGE_MERGE_VALIDATION"
  • "IMAGE_OCR_VALIDATION"
  • "IMAGE_OPTIMIZE_VALIDATION"
  • "IMAGE_RESIZE_ERROR"
  • "IMAGE_RESIZE_INVALID_BLUR_REGION"
  • "IMAGE_RESIZE_INVALID_TEXT_OBJECT_VALUE"
  • "IMAGE_RESIZE_INVALID_TEXT_VALUE"
  • "IMAGE_RESIZE_INVALID_WATERMARK_OFFSET"
  • "IMAGE_RESIZE_INVALID_WATERMARK_POSITION"
  • "IMAGE_RESIZE_NO_CLUT_FILE"
  • "IMAGE_RESIZE_NO_INPUT_FILE"
  • "IMAGE_RESIZE_VALIDATION"
  • "IMAGE_UPSCALE_VALIDATION"
  • "IMPORT_FILE_ERROR"
  • "INCOMPLETE_PRICING"
  • "INSUFFICIENT_AUTH_SCOPE"
  • "INTERNAL_COMMAND_ERROR"
  • "INTERNAL_COMMAND_TIMEOUT"
  • "INVALID_ASSEMBLY_STATUS"
  • "INVALID_AUTH_EXPIRES_PARAMETER"
  • "INVALID_AUTH_KEY_PARAMETER"
  • "INVALID_AUTH_MAX_NUMBER_OF_FILES_PARAMETER"
  • "INVALID_AUTH_MAX_SIZE_PARAMETER"
  • "INVALID_AUTH_REFERER_PARAMETER"
  • "INVALID_FILE_META_DATA"
  • "INVALID_FORM_DATA"
  • "INVALID_INPUT_ERROR"
  • "INVALID_PARAMS_FIELD"
  • "INVALID_SIGNATURE"
  • "INVALID_STEP_NAME"
  • "INVALID_TEMPLATE_FIELD"
  • "INVALID_UPLOAD_HANDLE_STEP_NAME"
  • "INVALID_URL_ENCODING"
  • "MAX_NUMBER_OF_FILES_EXCEEDED"
  • "MAX_SIZE_EXCEEDED"
  • "MEGA_IMPORT_ACCESS_DENIED"
  • "MEGA_IMPORT_FAILURE"
  • "MEGA_IMPORT_NOT_FOUND"
  • "MEGA_IMPORT_VALIDATION"
  • "MEGA_STORE_ACCESS_DENIED"
  • "MEGA_STORE_NOT_FOUND"
  • "MEGA_STORE_VALIDATION"
  • "MEGA_STORE_WRONG_REGION"
  • "META_WRITE_VALIDATION"
  • "MINIO_IMPORT_ACCESS_DENIED"
  • "MINIO_IMPORT_FAILURE"
  • "MINIO_IMPORT_NOT_FOUND"
  • "MINIO_IMPORT_VALIDATION"
  • "MINIO_STORE_ACCESS_DENIED"
  • "MINIO_STORE_NOT_FOUND"
  • "MINIO_STORE_VALIDATION"
  • "MINIO_STORE_WRONG_REGION"
  • "NO_AUTH_EXPIRES_PARAMETER"
  • "NO_AUTH_KEY_PARAMETER"
  • "NO_AUTH_PARAMETER"
  • "NO_COUNTRY"
  • "NO_OBJECT_AUTH_PARAMETER"
  • "NO_OBJECT_PARAMS_FIELD"
  • "NO_PARAMS_FIELD"
  • "NO_PRICING"
  • "NO_RESULT_STEP_FOUND"
  • "NO_RPC_RESULT_FROM_IMAGE_RESIZER"
  • "NO_SIGNATURE_FIELD"
  • "NO_TEMPLATE_ID"
  • "PLAN_LIMIT_EXCEEDED"
  • "POSSIBLY_MALICIOUS_FILE_FOUND"
  • "PRIORITY_JOB_SLOTS_NOT_FOUND"
  • "PRIORITY_JOB_SLOT_STATS_ERROR"
  • "PRIORITY_JOB_SLOT_STATS_INVALID_AGGREGATION"
  • "PRIORITY_JOB_SLOT_STATS_INVALID_TIME"
  • "PRIORITY_JOB_SLOT_STATS_MISSING_REGION"
  • "RATE_LIMIT_REACHED"
  • "REFERER_MISMATCH"
  • "REQUEST_PREMATURE_CLOSED"
  • "ROBOT_VALIDATION_BASE_ERROR"
  • "S3_ACCESS_DENIED"
  • "S3_IMPORT_ACCESS_DENIED"
  • "S3_IMPORT_FAILURE"
  • "S3_IMPORT_NOT_FOUND"
  • "S3_IMPORT_VALIDATION"
  • "S3_NOT_FOUND"
  • "S3_STORE_ACCESS_DENIED"
  • "S3_STORE_FAILURE"
  • "S3_STORE_NOT_FOUND"
  • "S3_STORE_URL_VERIFICATION_FAILURE"
  • "S3_STORE_VALIDATION"
  • "S3_STORE_WRONG_REGION"
  • "S3_WRONG_REGION"
  • "SCRIPT_RUN_VALIDATION"
  • "SERVER_403"
  • "SERVER_404"
  • "SERVER_500"
  • "SFTP_IMPORT_ACCESS_DENIED"
  • "SFTP_IMPORT_FAILURE"
  • "SFTP_IMPORT_NOT_FOUND"
  • "SFTP_IMPORT_VALIDATION"
  • "SFTP_STORE_VALIDATION"
  • "SIGNATURE_REUSE_DETECTED"
  • "SPEECH_TRANSCRIBE_VALIDATION"
  • "STORAGE_GRANT_NOT_CREATED"
  • "SUPABASE_IMPORT_ACCESS_DENIED"
  • "SUPABASE_IMPORT_FAILURE"
  • "SUPABASE_IMPORT_NOT_FOUND"
  • "SUPABASE_IMPORT_VALIDATION"
  • "SUPABASE_STORE_ACCESS_DENIED"
  • "SUPABASE_STORE_NOT_FOUND"
  • "SUPABASE_STORE_VALIDATION"
  • "SUPABASE_STORE_WRONG_REGION"
  • "SWIFT_IMPORT_ACCESS_DENIED"
  • "SWIFT_IMPORT_FAILURE"
  • "SWIFT_IMPORT_NOT_FOUND"
  • "SWIFT_IMPORT_VALIDATION"
  • "SWIFT_STORE_ACCESS_DENIED"
  • "SWIFT_STORE_NOT_FOUND"
  • "SWIFT_STORE_VALIDATION"
  • "SWIFT_STORE_WRONG_REGION"
  • "TEMPLATE_CREDENTIALS_INJECTION_ERROR"
  • "TEMPLATE_DB_ERROR"
  • "TEMPLATE_DENIES_STEPS_OVERRIDE"
  • "TEMPLATE_INVALID_JSON"
  • "TEMPLATE_NOT_FOUND"
  • "TEXT_SPEAK_VALIDATION"
  • "TEXT_TRANSLATE_VALIDATION"
  • "TIGRIS_IMPORT_ACCESS_DENIED"
  • "TIGRIS_IMPORT_FAILURE"
  • "TIGRIS_IMPORT_NOT_FOUND"
  • "TIGRIS_IMPORT_VALIDATION"
  • "TIGRIS_STORE_ACCESS_DENIED"
  • "TIGRIS_STORE_NOT_FOUND"
  • "TIGRIS_STORE_VALIDATION"
  • "TIGRIS_STORE_WRONG_REGION"
  • "TMP_FILE_DOWNLOAD_ERROR"
  • "TOKEN_INVALID_CREDENTIALS"
  • "TRANSIENT_STORAGE_SERVICE_ERROR"
  • "TRANSLOADIT_IMPORT_ACCESS_DENIED"
  • "TRANSLOADIT_IMPORT_FAILURE"
  • "TRANSLOADIT_IMPORT_NOT_FOUND"
  • "TRANSLOADIT_IMPORT_VALIDATION"
  • "TRANSLOADIT_STORE_CONFLICT"
  • "TRANSLOADIT_STORE_FAILURE"
  • "TRANSLOADIT_STORE_UNAVAILABLE"
  • "TRANSLOADIT_STORE_VALIDATION"
  • "TUS_STORE_VALIDATION"
  • "USER_COMMAND_ERROR"
  • "VERIFIED_EMAIL_REQUIRED"
  • "VIDEO_ADAPTIVE_VALIDATION"
  • "VIDEO_ARTWORK_VALIDATION"
  • "VIDEO_CONCAT_INVALID_INPUT"
  • "VIDEO_CONCAT_NO_OUTPUT"
  • "VIDEO_CONCAT_VALIDATION"
  • "VIDEO_ENCODE_INVALID_VIDEO_CODEC"
  • "VIDEO_ENCODE_INVALID_WATERMARK_POSITION"
  • "VIDEO_ENCODE_VALIDATION"
  • "VIDEO_GENERATE_VALIDATION"
  • "VIDEO_MERGE_NO_IMAGE_FOUND"
  • "VIDEO_MERGE_VALIDATION"
  • "VIDEO_ONDEMAND_NOT_FOUND"
  • "VIDEO_ONDEMAND_VALIDATION"
  • "VIDEO_SPLIT_NO_OUTPUT"
  • "VIDEO_SPLIT_VALIDATION"
  • "VIDEO_SUBTITLE_VALIDATION"
  • "VIDEO_THUMBS_INVALID_COUNT_VALUE"
  • "VIDEO_THUMBS_INVALID_FORMAT"
  • "VIDEO_THUMBS_INVALID_INPUT"
  • "VIDEO_THUMBS_VALIDATION"
  • "VIMEO_IMPORT_ACCESS_DENIED"
  • "VIMEO_IMPORT_FAILURE"
  • "VIMEO_IMPORT_NOT_FOUND"
  • "VIMEO_IMPORT_VALIDATION"
  • "VIMEO_STORE_ACCESS_DENIED"
  • "VIMEO_STORE_PROBLEM_SENDING_FILE"
  • "VIMEO_STORE_VALIDATION"
  • "WASABI_IMPORT_ACCESS_DENIED"
  • "WASABI_IMPORT_FAILURE"
  • "WASABI_IMPORT_NOT_FOUND"
  • "WASABI_IMPORT_VALIDATION"
  • "WASABI_STORE_ACCESS_DENIED"
  • "WASABI_STORE_NOT_FOUND"
  • "WASABI_STORE_VALIDATION"
  • "WASABI_STORE_WRONG_REGION"
  • "WORKER_JOB_ERROR"
  • "YOUTUBE_STORE_PROBLEM_SENDING_FILE"
  • "YOUTUBE_STORE_VALIDATION"
http_code
number

Der dem Fehler zugeordnete HTTP-Status. Dieses Feld ändert nicht den HTTP-Status des bereits geöffneten Streams.

message
string

Eine für Menschen verständliche Meldung, die den Status dieser Assembly erläutert. Sie ist nicht immer vorhanden.

previousStep
string

Name des vorhergehenden Steps, der mit dem Fehler zusammenhängt, sofern verfügbar.

reason
null | string | number | boolean | Array<beliebiger Wert> | object

Optionale Diagnosedetails. Gehen Sie nicht davon aus, dass dieser Wert ein String ist, und zeigen Sie ihn nicht direkt an. Verwenden Sie für menschenlesbaren Text message. Diagnosedetails können variieren. Verwenden Sie für die programmatische Fehlerbehandlung den error-Code.

Eines der folgenden Schemas kann gelten:

null
string
number
boolean
Array<beliebiger Wert>
Array<beliebiger Wert>
Schema eines Array-Elements
beliebiger Wert
object
object
Schema für zusätzliche Eigenschaften
beliebiger Wert
step
string

Name des Steps, der mit dem Fehler zusammenhängt, sofern verfügbar.

assembly_execution_progress

Benanntes Ereignis mit einer JSON-Nutzlast im Feld data.

Event-Payload
Vollständiges JSON Schema

JSON in einem neuen Tab öffnen

Auch Felder, die nicht für dieses Objekt aufgeführt sind, werden akzeptiert.

FeldTyp und Beschreibung
progress_combined

erforderlich

number | null

Geschätzter Gesamtfortschritt als Prozentwert. Der Wert null bedeutet, dass sich der Gesamtfortschritt nicht schätzen lässt.

progress_per_original_file

erforderlich

Array<object>

Fortschrittsschätzungen für ursprüngliche Eingabedateien. Importierte Dateien ohne ursprüngliche ID sind nicht enthalten.

Schema eines Array-Elements
object

progress_per_original_file[]: Auch Felder, die nicht für dieses Objekt aufgeführt sind, werden akzeptiert.

FeldTyp und Beschreibung
progress_per_original_file[].original_id

erforderlich

string

ID der ursprünglichen Eingabedatei, zu der diese Fortschrittsschätzung gehört.

progress_per_original_file[].progress

erforderlich

number

Geschätzter Verarbeitungsfortschritt für diese Originaldatei in Prozent.

assembly_finished

Nachricht, deren data-Feld diesen Namen als reinen Text enthält, ohne event-Feld. Der Server schließt den Stream nach dieser Benachrichtigung. Rufen Sie den endgültigen Status der Ressource ab, um das Ergebnis zu ermitteln.

ping

Nachricht, deren data-Feld diesen Namen als reinen Text enthält, ohne event-Feld.

assembly_result_finished

Benanntes Ereignis mit einer JSON-Nutzlast im Feld data.

Event-Payload
Vollständiges JSON Schema

JSON in einem neuen Tab öffnen

[string, object] (minimale Anzahl Elemente: 2, maximale Anzahl Elemente: 2)
Tupel-Element 1
string
Tupel-Element 2

[1]: Auch Felder, die nicht für dieses Objekt aufgeführt sind, werden akzeptiert.

FeldTyp und Beschreibung
[1].as
string | Array<string> | null

Eines der folgenden Schemas kann gelten:

string
Array<string>
Array<string>
Schema eines Array-Elements
string
null
[1].asset_id
string

Stabile Identität einer durch /transloadit/store gespeicherten Datei. Bewahren Sie diese zusammen mit dem zugehörigen Workspace und version_id auf; die gewöhnliche Datei-id ist keine Storage-Asset-ID.

[1].asset_version
number

Numerische Revision des gespeicherten Assets. Verwenden Sie version_id, nicht diese Zahl, um die exakten aufbewahrten Bytes auszuwählen.

[1].basename
null | string

Der Name der Datei ohne die Dateierweiterung.

[1].cost
number | null
[1].duration
number | null
[1].duration_human
null | string
[1].execTime
number | null
[1].exec_time
number | null
[1].ext
null | string

Die Dateiendung. Kann null sein, wenn keine Dateiendung ermittelt wurde, oder eine leere Zeichenfolge bei einem Namen ohne Dateiendung.

[1].field
null | string

Der Name des Formularfelds, über das diese Datei übermittelt wurde.

[1].filepath
null | string
[1].forcedFileExt
string
[1].from_batch_import
boolean
[1].has_alpha
boolean

Gibt an, ob diese gespeicherte Bildversion einen Alphakanal hat, sofern bekannt.

[1].height
number | null
[1].hls_url
string
[1].id
string

Eine zufällige, eindeutige ID, die Transloadit intern zur Nachverfolgung der Datei verwendet.

[1].import_url
string
[1].ios_url
string
[1].is_temp_url
boolean
[1].is_tus_file
boolean
[1].md5hash
null | string
[1].meta
object | null

Ein Objekt mit zusätzlichen Metadaten, die aus der Datei extrahiert wurden, wie unten gezeigt. Mehrfach vorkommende Datums-Tags können als Listen ihrer ursprünglichen Werte zurückgegeben werden. Prüfen Sie den Typ des Werts, bevor Sie ihn als einzelnen Zeitstempel verwenden.

Eines der folgenden Schemas kann gelten:

object
object

[1].meta: Auch Felder, die nicht für dieses Objekt aufgeführt sind, werden akzeptiert.

FeldTyp und Beschreibung
[1].meta.album
string | number | null

Eines der folgenden Schemas kann gelten:

string | number
string | number
null
[1].meta.aperture
number | null

Die Blendeneinstellung für dieses Bild, z. B. 5.7.

[1].meta.archive_directory
null | string
[1].meta.artist
string | number | null

Viele Anwendungen, die Audio erzeugen, schreiben zusätzliche Informationen in die Audiodatei, etwa artist, year, album, genre.

Eines der folgenden Schemas kann gelten:

string | number
string | number
null
[1].meta.aspect_ratio
number | string | null

Das Seitenverhältnis des Bildes, also seine Breite geteilt durch seine Höhe. Ist 0, falls die Bildhöhe aus irgendeinem Grund 0 ist.

[1].meta.audio_bitrate
number | null

Die Audio-Bitrate in Bits pro Sekunde über alle Kanäle hinweg, zum Beispiel 128000.

[1].meta.audio_channel_layout
null | string
[1].meta.audio_channels
number | null

Die Anzahl der Audiokanäle, typischerweise 2 für Stereo.

[1].meta.audio_codec
null | string

Der Audio-Codec, zum Beispiel "faad". Siehe die unterstützten Audio-Codecs.

[1].meta.audio_profile
null | string
[1].meta.audio_sample_format
null | string
[1].meta.audio_samplerate
number | null

Die Audio-Abtastrate in Hertz, zum Beispiel 44100.

[1].meta.author
string | number | null

Der Autor, der das Bild aufgenommen hat. Manche Kameras füllen dieses Feld anstelle von creator aus.

Eines der folgenden Schemas kann gelten:

string | number
string | number
null
[1].meta.average_color
null | string

Nicht zu verwechseln mit der dominanten Farbe, die die einzelne am häufigsten vorkommende Pixelfarbe zählt und nur begrenzte Anwendungsfälle hat. Die durchschnittliche Farbe wird berechnet, indem das Eingabebild zunächst auf 1 Pixel skaliert wird.

[1].meta.band
null | string
[1].meta.bandwidth
number | null
[1].meta.beats_per_minute
number | null
[1].meta.bit_depth
number | null
[1].meta.character_count
number | null
[1].meta.character_count_with_spaces
number | null
[1].meta.city
null | string

Die Stadt, in der dieses Bild aufgenommen wurde, z. B. "Berlin".

[1].meta.closed_captions
boolean | null
[1].meta.cmd
string | Array<string | number>

Weitere Schemadetails finden Sie im vollständigen JSON Schema.

[1].meta.codecs
null | string
[1].meta.colorprimaries
null | string
[1].meta.colorspace
null | string

Der erkannte Farbraum des Mediums, zum Beispiel "sRGB" oder "Gray". Der Farbraum eines Videos ist verfügbar, wenn er bei aktivierter Metadatenextraktion erkannt wird; dafür ist output_meta.colorspace: true nicht erforderlich. Wenn Sie output_meta: false setzen, wird die Metadatenextraktion deaktiviert.

[1].meta.colortransfer
null | string
[1].meta.comment
null | string
[1].meta.copyright
string | number | object | null

Das Metadatenfeld für das Copyright.

Weitere Schemadetails finden Sie im vollständigen JSON Schema.

[1].meta.copyright_notice
string | number | null

Das Metadatenfeld für den Urheberrechtshinweis.

Eines der folgenden Schemas kann gelten:

string | number
string | number
null
[1].meta.country
null | string

Das Land, in dem dieses Bild aufgenommen wurde, zum Beispiel "Germany".

[1].meta.country_code
null | string

Der Ländercode des Landes, in dem dieses Bild aufgenommen wurde, zum Beispiel "de".

[1].meta.create_date
string | number | Array<string | number> | null

Weitere Schemadetails finden Sie im vollständigen JSON Schema.

[1].meta.creator
string | number | Array<string> | null

Der Urheber, der das Bild aufgenommen hat.

Weitere Schemadetails finden Sie im vollständigen JSON Schema.

[1].meta.date_file_created
string | number | Array<string | number> | null

Der in den Medienmetadaten angegebene Erstellungszeitstempel, sofern verfügbar.

Weitere Schemadetails finden Sie im vollständigen JSON Schema.

[1].meta.date_file_modified
string | number | Array<string | number> | null

Der vom Dateisystem oder von eingebetteten Medienmetadaten gemeldete Änderungszeitstempel.

Weitere Schemadetails finden Sie im vollständigen JSON Schema.

[1].meta.date_recorded
string | number | Array<string | number> | null

Das Datum und die Uhrzeit, zu denen das Medium aufgezeichnet wurde. Ein einzelner gültiger Zeitstempel in Form einer Zeichenfolge wird auf YYYY/MM/DD HH:MM:SS normalisiert. Wenn eine Zeitzone vorhanden ist, wird der Zeitstempel in UTC/GMT umgerechnet und endet auf GMT. Nicht interpretierbare Zeitstempel-Zeichenfolgen werden zu null. Numerische Zeitstempel und Listen mit wiederholten Datums-Tags behalten ihre ursprünglichen Werte.

Weitere Schemadetails finden Sie im vollständigen JSON Schema.

[1].meta.description
string | number | null

Eine Beschreibung dieses Bildes, zum Beispiel "This tree is very old.".

Eines der folgenden Schemas kann gelten:

string | number
string | number
null
[1].meta.descriptions
Array<string | object>

Weitere Schemadetails finden Sie im vollständigen JSON Schema.

[1].meta.device_name
string | number | null

Der Name des Geräts, mit dem die Medien aufgenommen wurden, zum Beispiel "iPhone 3GS".

Eines der folgenden Schemas kann gelten:

string | number
string | number
null
[1].meta.device_software
string | number | null

Die Softwareversion des Geräts, mit dem die Medien aufgenommen wurden, zum Beispiel "3.1.2".

Eines der folgenden Schemas kann gelten:

string | number
string | number
null
[1].meta.device_vendor
null | string

Der Hersteller des Geräts, mit dem die Medien aufgenommen wurden, z. B. "Apple".

[1].meta.disc
string | number | null

Eines der folgenden Schemas kann gelten:

string | number
string | number
null
[1].meta.dominant_colors
Array<string> | null

Gibt ein Array mit bis zu 10 dominanten Bildfarben als Hexadezimalwerte zurück. Lassen Sie output_meta.dominant_colors weg, um diese Extraktion zu überspringen. Wenn die Eigenschaft angegeben wird, auch mit false, wird die Extraktion angefordert, und es können zusätzliche Nutzungsgebühren anfallen, wenn Farben zurückgegeben werden. Wenn output_meta selbst auf false gesetzt wird, ist die Extraktion zusätzlicher Metadaten deaktiviert. Grundlegende Prüfungen von Dateityp und Dateigröße können dennoch ausgeführt werden.

Weitere Schemadetails finden Sie im vollständigen JSON Schema.

[1].meta.duration
number | null

Die Länge der Audiodatei in Sekunden.

[1].meta.encoder
null | string
[1].meta.encoding_level
null | string
[1].meta.encoding_profile
null | string
[1].meta.ends_at
null | string
[1].meta.exitCode
number | null
[1].meta.exitSignal
null | string
[1].meta.exposure_compensation
number | string | null

Die Belichtungskorrektur für dieses Bild, zum Beispiel "+4/3".

Eines der folgenden Schemas kann gelten:

number | string
number | string
null
[1].meta.exposure_mode
null | string

Der Belichtungsmodus dieses Bildes, zum Beispiel "Auto".

[1].meta.exposure_time
number | string | null

Die Belichtungszeit dieses Bildes, zum Beispiel "1/30".

Eines der folgenden Schemas kann gelten:

number | string
number | string
null
[1].meta.f_number
number | null

Die Blendenzahl dieses Bildes, z. B. 5.6.

[1].meta.faces
Array<object> | null

Weitere Schemadetails finden Sie im vollständigen JSON Schema.

[1].meta.field_order
null | string

Die von FFprobe gemeldete Halbbildreihenfolge, zum Beispiel "tt", "bb", "tb", "bt" oder "progressive". Setzen Sie output_meta.interlaced auf true, um die Erkennung anzufordern, die dieses Diagnosefeld befüllt. Dieser Schlüssel kann mit dem Wert null vorhanden sein, wenn die Erkennung nicht angefordert wurde oder die Halbbildreihenfolge nicht verfügbar war. Verwenden Sie interlaced für eine einfache Fallunterscheidung zwischen Interlaced und Progressive.

[1].meta.flash
null | string

Die Blitzeinstellungen für dieses Bild, zum Beispiel "Off, Did not fire".

[1].meta.focal_length
null | string

Die Brennweite für dieses Bild, zum Beispiel "55.0 mm".

[1].meta.frame_count
number | null

Die Anzahl der Frames in einer animierten GIF-Datei. Für alle anderen Bildtypen ist dieser Wert standardmäßig 1.

[1].meta.framerate
number | null

Die Bildrate des Videos, zum Beispiel 29.5.

[1].meta.genre
string | number | null

Eines der folgenden Schemas kann gelten:

string | number
string | number
null
[1].meta.has_alpha
boolean

Gibt an, ob das Originalbild einen Alphakanal hat, einschließlich vollständig deckender Bilder mit Alphakanal. Wird zusammen mit thumbhash zurückgegeben; fehlt der Wert, bedeutet das „unbekannt“.

[1].meta.has_alpha_channel
boolean | null
[1].meta.has_artwork
boolean | null
[1].meta.has_clipping_path
boolean

Ist true, wenn das Bild einen Beschneidungspfad enthält, andernfalls false.

[1].meta.has_transparency
boolean | null

Gibt an, ob das Bild transparente Bereiche hat. Setzen Sie output_meta.has_transparency auf true, um eine Transparenzprüfung anzufordern. Bereits bekannte false-Werte, etwa false für JPEG-Bilder, können auch dann zurückgegeben werden, wenn diese Option weggelassen wird oder false ist. Wenn Sie output_meta selbst auf false setzen, wird die zusätzliche Extraktion von Metadaten übersprungen. Grundlegende Prüfungen von Dateityp und Dateigröße können dennoch ausgeführt werden.

[1].meta.height
number | null

Die Höhe des Mediums in Pixeln.

[1].meta.interlace_detection
object | null

Diagnosedetails aus dem Interlace-Detektor von Transloadit. Dieses Objekt kann sampled_frames, tff, bff, progressive, undetermined, confidence, method und ffprobe_field_order enthalten. Setzen Sie output_meta.interlaced auf true, um die Erkennung anzufordern. Dieser Schlüssel kann mit dem Wert null vorhanden sein, wenn keine Erkennung angefordert wurde. Prüfen Sie daher, ob ein Objekt ungleich null vorliegt, bevor Sie dessen Eigenschaften lesen.

Weitere Schemadetails finden Sie im vollständigen JSON Schema.

[1].meta.interlaced
boolean | null

Gibt an, ob das Video Zeilensprungverfahren (Interlacing) zu verwenden scheint: true für Videos im Zeilensprungverfahren oder false für Videos mit progressiver Abtastung. Setzen Sie output_meta.interlaced auf true, um die Erkennung anzufordern. Dieser Schlüssel kann mit dem Wert null vorhanden sein, wenn die Erkennung nicht angefordert wurde oder wenn die angeforderte Erkennung kein eindeutiges Ergebnis lieferte. Das bloße Vorhandensein des Felds zeigt nicht, dass die Erkennung durchgeführt wurde.

[1].meta.iso
number | null

Der ISO-Wert für dieses Bild, zum Beispiel 800.

[1].meta.keywords
string | number | Array<string | number | boolean> | null

Aus den Metadaten der Datei extrahierte Schlüsselwörter: ein String, eine endliche Zahl oder ein Array, dessen Einträge Strings, endliche Zahlen oder boolesche Werte sein können. Zum Beispiel ["tree", "nature"]. Das Feld kann fehlen oder null sein. Prüfen Sie den Typ, bevor Sie darüber iterieren; Array-Einträge sind nicht unbedingt Strings.

Weitere Schemadetails finden Sie im vollständigen JSON Schema.

[1].meta.latitude
number | null

Der Breitengrad, an dem das Medium aufgenommen wurde, zum Beispiel 52.5374.

[1].meta.light_value
number | null

Der Lichtwert dieses Bildes, z. B. 6.9.

[1].meta.line_count
number | null
[1].meta.location
null | string

Der Ort, an dem dieses Bild aufgenommen wurde, in der Regel die Straße, zum Beispiel "Zingster Str. 32".

[1].meta.longitude
number | null

Der Längengrad, an dem das Medium aufgenommen wurde, zum Beispiel 13.4034.

[1].meta.lyrics
null | string
[1].meta.mean_volume
number | null

Die mittlere Lautstärke der Audiodatei. Setzen Sie output_meta.mean_volume auf true, um die Messung anzufordern. Dieser Schlüssel kann mit dem Wert null vorhanden sein, wenn keine Messung angefordert wurde oder der Wert nicht verfügbar war. Allein das Vorhandensein des Felds zeigt nicht, dass die Messung durchgeführt wurde.

[1].meta.metering_mode
null | string

Der Belichtungsmessmodus für dieses Bild, zum Beispiel "Multi-segment".

[1].meta.modify_date
string | number | Array<string | number> | null

Weitere Schemadetails finden Sie im vollständigen JSON Schema.

[1].meta.num_audio_streams
number | null
[1].meta.num_subtitles
number | null
[1].meta.num_video_streams
number | null
[1].meta.orientation
string | number | null

Eines der folgenden Schemas kann gelten:

string | number
string | number
null
[1].meta.overall_bitrate
number | null
[1].meta.page_count
number | null
[1].meta.page_size
null | string
[1].meta.paragraph_count
number | null
[1].meta.performer
null | string
[1].meta.pixel_format
null | string
[1].meta.previousStep
string
[1].meta.producer
null | string
[1].meta.reason
string
[1].meta.recognized_text
Array<string> | Array<object>

Weitere Schemadetails finden Sie im vollständigen JSON Schema.

[1].meta.reference_count
number | null
[1].meta.relative_path
null | string
[1].meta.resolution
null | string
[1].meta.rights
string | number | null

Eines der folgenden Schemas kann gelten:

string | number
string | number
null
[1].meta.rotation
number | null
[1].meta.seekable
boolean | null

Gibt an, ob das Format des Videos das Springen zu einer bestimmten Position (Seeking) unterstützt, zum Beispiel true.

[1].meta.segment_index
number | null
[1].meta.shutter_speed
number | string | null

Die Verschlusszeit dieses Bildes, zum Beispiel "1/32".

Eines der folgenden Schemas kann gelten:

number | string
number | string
null
[1].meta.starts_at
null | string
[1].meta.state
string | number | null

Das Bundesland oder der Staat, in dem dieses Bild aufgenommen wurde, z. B. "Berlin".

Eines der folgenden Schemas kann gelten:

string | number
string | number
null
[1].meta.stderr
string
[1].meta.stdout
string
[1].meta.step
string
[1].meta.storage_url
string
[1].meta.streams
object | null

Weitere Schemadetails finden Sie im vollständigen JSON Schema.

[1].meta.svgViewBoxHeight
number | null
[1].meta.svgViewBoxWidth
number | null
[1].meta.thumb_index
number | null

Der Index des aktuellen Thumbnails, beginnend bei 0. Dieser Schlüssel ist nur bei Ergebnissen von 🤖/video/thumbs vorhanden.

[1].meta.thumb_offset
number | string | null

Der Offset für das aktuelle Thumbnail in Sekunden. Dieser Schlüssel ist nur bei Ergebnissen von 🤖/video/thumbs vorhanden.

  • number
  • string
    Validierungsmuster (regulärer Ausdruck)^[\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]*[+-]?[0-9]+
  • null
[1].meta.thumbhash
string

Base64-kodierter ThumbHash des gemäß EXIF ausgerichteten Bildes. Fordern Sie output_meta.thumbhash im erzeugenden Step an. Wird weggelassen, wenn er nicht angefordert wurde, nicht unterstützt wird, das Bild mehr als 40 Megapixel hat oder die Extraktion fehlschlägt. Behandeln Sie den Hash als private Bilddaten, wenn das Original privat ist.

Validierungsmuster (regulärer Ausdruck)^(?:[A-Za-z0-9+/]{4}){1,15}(?:[A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)$
[1].meta.time_base
null | string
[1].meta.title
string | number | null

Der Titel dieses Bildes, z. B. "Tree".

Eines der folgenden Schemas kann gelten:

string | number
string | number
null
[1].meta.track
string | number | null

Eines der folgenden Schemas kann gelten:

string | number
string | number
null
[1].meta.turbo
boolean | null
[1].meta.version_id
string
[1].meta.video_bitrate
number | null

Die Videobitrate des Videos, zum Beispiel 500000.

[1].meta.video_codec
null | string

Der Video-Codec des Videos, zum Beispiel "ffh264".

[1].meta.white_balance
null | string

Die Weißabgleich-Einstellung für dieses Bild, zum Beispiel "Manual".

[1].meta.width
number | null

Die Breite des Mediums in Pixeln. Bei Videos, deren Anzeigeseitenverhältnis von ihrem Pixelseitenverhältnis abweicht, ist dies die vorgesehene Anzeigebreite.

[1].meta.word_count
number | null
[1].meta.xp_comment
null | string
[1].meta.xp_keywords
string | number | null

Eines der folgenden Schemas kann gelten:

string | number
string | number
null
[1].meta.xp_subject
string | number | null

Eines der folgenden Schemas kann gelten:

string | number
string | number
null
[1].meta.xp_title
string | number | null

Eines der folgenden Schemas kann gelten:

string | number
string | number
null
[1].meta.year
string | number | null

Eines der folgenden Schemas kann gelten:

string | number
string | number
null
null
[1].mime
null | string

Der ermittelte MIME-Typ dieser Datei.

[1].name
null | string

Der Name der Datei. Transloadit ändert die Erweiterung in diesem Feld, wenn die Datei durch Verarbeitung in ein anderes Format umgewandelt wird.

[1].original_basename
null | string
[1].original_id
string | Array<null | string>

Die eindeutige ID der ursprünglich hochgeladenen Datei, aus der diese Datei erzeugt wurde. Damit können Sie auch nach mehreren Steps der Verarbeitung bestimmen, welche Datei eines Uploads mit mehreren Dateien zur Erzeugung einer bestimmten Datei verwendet wurde.

Eines der folgenden Schemas kann gelten:

string
Array<null | string>
Array<null | string>
Schema eines Array-Elements
null | string
[1].original_md5hash
null | string
[1].original_name
null | string
[1].original_path
null | string
[1].path
null | string
[1].playlists
Array<object>
Schema eines Array-Elements
object

[1].playlists[]: Auch Felder, die nicht für dieses Objekt aufgeführt sind, werden akzeptiert.

FeldTyp und Beschreibung
[1].playlists[].content
string
[1].playlists[].meta
object

Weitere Schemadetails finden Sie im vollständigen JSON Schema.

[1].playlists[].name
string | number
[1].playlists[].relative_path
string
[1].playlists[].stream
string
[1].preview
null | string
[1].queue
null | string
[1].queueTime
number | null
[1].queue_time
number | null
[1].remote_path
string
[1].sha256
string

SHA-256-Prüfsumme der gespeicherten Bytes in Kleinbuchstaben, sofern verfügbar.

Validierungsmuster (regulärer Ausdruck)^[a-f0-9]{64}$
[1].signed_ssl_url
string
[1].signed_url
string
[1].size
number | null

Die Größe der Datei in Bytes.

[1].size_human
null | string
[1].ssl_url
null | string
[1].streaming_url
string
[1].thumbhash
string

Base64-codierter ThumbHash, der mit dieser gespeicherten Bildversion aufbewahrt wird, sofern verfügbar. Schützen Sie diese Bilddaten mit denselben Zugriffskontrollen wie das Original.

Validierungsmuster (regulärer Ausdruck)^(?:[A-Za-z0-9+/]{4}){1,15}(?:[A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)$
[1].tus_upload_url
null | string
[1].type
null | string

Eine abstrakte Kategorie zur Beschreibung der Datei. Bekannte Werte sind "audio", "document", "image", "office", "pdf", "swf", "video", "xls" oder null, wenn keine Kategorie erkannt wurde. Clients sollten weitere Zeichenfolgen akzeptieren, damit zukünftige Kategorien kompatibel bleiben.

[1].url
null | string

Eine URL, über die die Datei heruntergeladen werden kann, oder null, wenn keine Auslieferungs-URL verfügbar ist. Temporäre URLs auf unseren Servern laufen nach einigen Stunden ab; exportieren Sie Dateien zur späteren Verwendung in einen Speicher. Ergebnisse von /transloadit/store in privatem Speicher geben sowohl für url als auch für ssl_url den Wert null zurück. Bewahren Sie den zurückgegebenen Workspace, asset_id und version_id als dauerhafte Referenz auf, vorbehaltlich der Zugriffs- und Aufbewahrungsbedingungen. /transloadit/import akzeptiert asset_id mit einer optionalen version_id oder einen veränderlichen path. Weder eine temporäre URL noch die Datei-id aus der Verarbeitung ist eine dauerhafte Speicherreferenz.

[1].user_meta
object | null

Eines der folgenden Schemas kann gelten:

object
object
Schema für zusätzliche Eigenschaften
beliebiger Wert
null
[1].version_id
string

Unveränderliche Versions-ID, die zurückgegeben wird, nachdem Storage das Ergebnis finalisiert hat. Importieren Sie mit asset_id und dieser version_id, um nach einem Verschieben oder Überschreiben dieselben Bytes beizubehalten, vorbehaltlich der Aufbewahrungs- und Zugriffsbedingungen.

Validierungsmuster (regulärer Ausdruck)^[A-Za-z0-9_-]{21}[AQgw]$
[1].vimeo
object

[1].vimeo: Auch Felder, die nicht für dieses Objekt aufgeführt sind, werden akzeptiert.

[1].vimeo.title

erforderlich

string
[1].vimeo.uri

erforderlich

string
[1].width
number | null
[1].workspace
string (minimale Länge: 1)

Slug des Workspaces, dem dieses gespeicherte Ergebnis gehört. Authentifizieren Sie sich für diesen Workspace, wenn Sie das Ergebnis importieren oder verwalten.

assembly_upload_finished

Benanntes Ereignis mit einer JSON-Nutzlast im Feld data.

Event-Payload
Vollständiges JSON Schema

JSON in einem neuen Tab öffnen

Auch Felder, die nicht für dieses Objekt aufgeführt sind, werden akzeptiert.

FeldTyp und Beschreibung
as
string | Array<string> | null

Eines der folgenden Schemas kann gelten:

string
Array<string>
Array<string>
Schema eines Array-Elements
string
null
asset_id
string

Stabile Identität einer durch /transloadit/store gespeicherten Datei. Bewahren Sie diese zusammen mit dem zugehörigen Workspace und version_id auf; die gewöhnliche Datei-id ist keine Storage-Asset-ID.

asset_version
number

Numerische Revision des gespeicherten Assets. Verwenden Sie version_id, nicht diese Zahl, um die exakten aufbewahrten Bytes auszuwählen.

basename

erforderlich

null | string

Der Name der Datei ohne die Dateierweiterung.

cost
number | null
exec_time
number
ext

erforderlich

null | string

Die Dateiendung. Kann null sein, wenn keine Dateiendung ermittelt wurde, oder eine leere Zeichenfolge bei einem Namen ohne Dateiendung.

field

erforderlich

null | string

Der Name des Formularfelds, über das diese Datei übermittelt wurde.

from_batch_import
boolean
has_alpha
boolean

Gibt an, ob diese gespeicherte Bildversion einen Alphakanal hat, sofern bekannt.

id

erforderlich

string

Eine zufällige, eindeutige ID, die Transloadit intern zur Nachverfolgung der Datei verwendet.

import_url
string
is_temp_url
boolean
is_tus_file
boolean
md5hash
null | string
meta

erforderlich

object

Ein Objekt mit zusätzlichen Metadaten, die aus der Datei extrahiert wurden, wie unten gezeigt. Mehrfach vorkommende Datums-Tags können als Listen ihrer ursprünglichen Werte zurückgegeben werden. Prüfen Sie den Typ des Werts, bevor Sie ihn als einzelnen Zeitstempel verwenden.

meta: Auch Felder, die nicht für dieses Objekt aufgeführt sind, werden akzeptiert.

meta.album
string | number | null

Eines der folgenden Schemas kann gelten:

string | number
string | number
null
meta.aperture
number | null

Die Blendeneinstellung für dieses Bild, z. B. 5.7.

meta.archive_directory
null | string
meta.artist
string | number | null

Viele Anwendungen, die Audio erzeugen, schreiben zusätzliche Informationen in die Audiodatei, etwa artist, year, album, genre.

Eines der folgenden Schemas kann gelten:

string | number
string | number
null
meta.aspect_ratio
number | string | null

Das Seitenverhältnis des Bildes, also seine Breite geteilt durch seine Höhe. Ist 0, falls die Bildhöhe aus irgendeinem Grund 0 ist.

meta.audio_bitrate
number | null

Die Audio-Bitrate in Bits pro Sekunde über alle Kanäle hinweg, zum Beispiel 128000.

meta.audio_channel_layout
null | string
meta.audio_channels
number | null

Die Anzahl der Audiokanäle, typischerweise 2 für Stereo.

meta.audio_codec
null | string

Der Audio-Codec, zum Beispiel "faad". Siehe die unterstützten Audio-Codecs.

meta.audio_profile
null | string
meta.audio_sample_format
null | string
meta.audio_samplerate
number | null

Die Audio-Abtastrate in Hertz, zum Beispiel 44100.

meta.author
string | number | null

Der Autor, der das Bild aufgenommen hat. Manche Kameras füllen dieses Feld anstelle von creator aus.

Eines der folgenden Schemas kann gelten:

string | number
string | number
null
meta.average_color
null | string

Nicht zu verwechseln mit der dominanten Farbe, die die einzelne am häufigsten vorkommende Pixelfarbe zählt und nur begrenzte Anwendungsfälle hat. Die durchschnittliche Farbe wird berechnet, indem das Eingabebild zunächst auf 1 Pixel skaliert wird.

meta.band
null | string
meta.bandwidth
number | null
meta.beats_per_minute
number | null
meta.bit_depth
number | null
meta.character_count
number | null
meta.character_count_with_spaces
number | null
meta.city
null | string

Die Stadt, in der dieses Bild aufgenommen wurde, z. B. "Berlin".

meta.closed_captions
boolean | null
meta.cmd
string | Array<string | number>

Weitere Schemadetails finden Sie im vollständigen JSON Schema.

meta.codecs
null | string
meta.colorprimaries
null | string
meta.colorspace
null | string

Der erkannte Farbraum des Mediums, zum Beispiel "sRGB" oder "Gray". Der Farbraum eines Videos ist verfügbar, wenn er bei aktivierter Metadatenextraktion erkannt wird; dafür ist output_meta.colorspace: true nicht erforderlich. Wenn Sie output_meta: false setzen, wird die Metadatenextraktion deaktiviert.

meta.colortransfer
null | string
meta.comment
null | string
meta.copyright
string | number | object | null

Das Metadatenfeld für das Copyright.

Weitere Schemadetails finden Sie im vollständigen JSON Schema.

meta.copyright_notice
string | number | null

Das Metadatenfeld für den Urheberrechtshinweis.

Eines der folgenden Schemas kann gelten:

string | number
string | number
null
meta.country
null | string

Das Land, in dem dieses Bild aufgenommen wurde, zum Beispiel "Germany".

meta.country_code
null | string

Der Ländercode des Landes, in dem dieses Bild aufgenommen wurde, zum Beispiel "de".

meta.create_date
string | number | Array<string | number> | null

Weitere Schemadetails finden Sie im vollständigen JSON Schema.

meta.creator
string | number | Array<string> | null

Der Urheber, der das Bild aufgenommen hat.

Weitere Schemadetails finden Sie im vollständigen JSON Schema.

meta.date_file_created
string | number | Array<string | number> | null

Der in den Medienmetadaten angegebene Erstellungszeitstempel, sofern verfügbar.

Weitere Schemadetails finden Sie im vollständigen JSON Schema.

meta.date_file_modified
string | number | Array<string | number> | null

Der vom Dateisystem oder von eingebetteten Medienmetadaten gemeldete Änderungszeitstempel.

Weitere Schemadetails finden Sie im vollständigen JSON Schema.

meta.date_recorded
string | number | Array<string | number> | null

Das Datum und die Uhrzeit, zu denen das Medium aufgezeichnet wurde. Ein einzelner gültiger Zeitstempel in Form einer Zeichenfolge wird auf YYYY/MM/DD HH:MM:SS normalisiert. Wenn eine Zeitzone vorhanden ist, wird der Zeitstempel in UTC/GMT umgerechnet und endet auf GMT. Nicht interpretierbare Zeitstempel-Zeichenfolgen werden zu null. Numerische Zeitstempel und Listen mit wiederholten Datums-Tags behalten ihre ursprünglichen Werte.

Weitere Schemadetails finden Sie im vollständigen JSON Schema.

meta.description
string | number | null

Eine Beschreibung dieses Bildes, zum Beispiel "This tree is very old.".

Eines der folgenden Schemas kann gelten:

string | number
string | number
null
meta.descriptions
Array<string | object>

Weitere Schemadetails finden Sie im vollständigen JSON Schema.

meta.device_name
string | number | null

Der Name des Geräts, mit dem die Medien aufgenommen wurden, zum Beispiel "iPhone 3GS".

Eines der folgenden Schemas kann gelten:

string | number
string | number
null
meta.device_software
string | number | null

Die Softwareversion des Geräts, mit dem die Medien aufgenommen wurden, zum Beispiel "3.1.2".

Eines der folgenden Schemas kann gelten:

string | number
string | number
null
meta.device_vendor
null | string

Der Hersteller des Geräts, mit dem die Medien aufgenommen wurden, z. B. "Apple".

meta.disc
string | number | null

Eines der folgenden Schemas kann gelten:

string | number
string | number
null
meta.dominant_colors
Array<string> | null

Gibt ein Array mit bis zu 10 dominanten Bildfarben als Hexadezimalwerte zurück. Lassen Sie output_meta.dominant_colors weg, um diese Extraktion zu überspringen. Wenn die Eigenschaft angegeben wird, auch mit false, wird die Extraktion angefordert, und es können zusätzliche Nutzungsgebühren anfallen, wenn Farben zurückgegeben werden. Wenn output_meta selbst auf false gesetzt wird, ist die Extraktion zusätzlicher Metadaten deaktiviert. Grundlegende Prüfungen von Dateityp und Dateigröße können dennoch ausgeführt werden.

Weitere Schemadetails finden Sie im vollständigen JSON Schema.

meta.duration
number | null

Die Länge der Audiodatei in Sekunden.

meta.encoder
null | string
meta.encoding_level
null | string
meta.encoding_profile
null | string
meta.ends_at
null | string
meta.exitCode
number | null
meta.exitSignal
null | string
meta.exposure_compensation
number | string | null

Die Belichtungskorrektur für dieses Bild, zum Beispiel "+4/3".

Eines der folgenden Schemas kann gelten:

number | string
number | string
null
meta.exposure_mode
null | string

Der Belichtungsmodus dieses Bildes, zum Beispiel "Auto".

meta.exposure_time
number | string | null

Die Belichtungszeit dieses Bildes, zum Beispiel "1/30".

Eines der folgenden Schemas kann gelten:

number | string
number | string
null
meta.f_number
number | null

Die Blendenzahl dieses Bildes, z. B. 5.6.

meta.faces
Array<object> | null

Weitere Schemadetails finden Sie im vollständigen JSON Schema.

meta.field_order
null | string

Die von FFprobe gemeldete Halbbildreihenfolge, zum Beispiel "tt", "bb", "tb", "bt" oder "progressive". Setzen Sie output_meta.interlaced auf true, um die Erkennung anzufordern, die dieses Diagnosefeld befüllt. Dieser Schlüssel kann mit dem Wert null vorhanden sein, wenn die Erkennung nicht angefordert wurde oder die Halbbildreihenfolge nicht verfügbar war. Verwenden Sie interlaced für eine einfache Fallunterscheidung zwischen Interlaced und Progressive.

meta.flash
null | string

Die Blitzeinstellungen für dieses Bild, zum Beispiel "Off, Did not fire".

meta.focal_length
null | string

Die Brennweite für dieses Bild, zum Beispiel "55.0 mm".

meta.frame_count
number | null

Die Anzahl der Frames in einer animierten GIF-Datei. Für alle anderen Bildtypen ist dieser Wert standardmäßig 1.

meta.framerate
number | null

Die Bildrate des Videos, zum Beispiel 29.5.

meta.genre
string | number | null

Eines der folgenden Schemas kann gelten:

string | number
string | number
null
meta.has_alpha
boolean

Gibt an, ob das Originalbild einen Alphakanal hat, einschließlich vollständig deckender Bilder mit Alphakanal. Wird zusammen mit thumbhash zurückgegeben; fehlt der Wert, bedeutet das „unbekannt“.

meta.has_alpha_channel
boolean | null
meta.has_artwork
boolean | null
meta.has_clipping_path
boolean

Ist true, wenn das Bild einen Beschneidungspfad enthält, andernfalls false.

meta.has_transparency
boolean | null

Gibt an, ob das Bild transparente Bereiche hat. Setzen Sie output_meta.has_transparency auf true, um eine Transparenzprüfung anzufordern. Bereits bekannte false-Werte, etwa false für JPEG-Bilder, können auch dann zurückgegeben werden, wenn diese Option weggelassen wird oder false ist. Wenn Sie output_meta selbst auf false setzen, wird die zusätzliche Extraktion von Metadaten übersprungen. Grundlegende Prüfungen von Dateityp und Dateigröße können dennoch ausgeführt werden.

meta.height
number | null

Die Höhe des Mediums in Pixeln.

meta.interlace_detection
object | null

Diagnosedetails aus dem Interlace-Detektor von Transloadit. Dieses Objekt kann sampled_frames, tff, bff, progressive, undetermined, confidence, method und ffprobe_field_order enthalten. Setzen Sie output_meta.interlaced auf true, um die Erkennung anzufordern. Dieser Schlüssel kann mit dem Wert null vorhanden sein, wenn keine Erkennung angefordert wurde. Prüfen Sie daher, ob ein Objekt ungleich null vorliegt, bevor Sie dessen Eigenschaften lesen.

Weitere Schemadetails finden Sie im vollständigen JSON Schema.

meta.interlaced
boolean | null

Gibt an, ob das Video Zeilensprungverfahren (Interlacing) zu verwenden scheint: true für Videos im Zeilensprungverfahren oder false für Videos mit progressiver Abtastung. Setzen Sie output_meta.interlaced auf true, um die Erkennung anzufordern. Dieser Schlüssel kann mit dem Wert null vorhanden sein, wenn die Erkennung nicht angefordert wurde oder wenn die angeforderte Erkennung kein eindeutiges Ergebnis lieferte. Das bloße Vorhandensein des Felds zeigt nicht, dass die Erkennung durchgeführt wurde.

meta.iso
number | null

Der ISO-Wert für dieses Bild, zum Beispiel 800.

meta.keywords
string | number | Array<string | number | boolean> | null

Aus den Metadaten der Datei extrahierte Schlüsselwörter: ein String, eine endliche Zahl oder ein Array, dessen Einträge Strings, endliche Zahlen oder boolesche Werte sein können. Zum Beispiel ["tree", "nature"]. Das Feld kann fehlen oder null sein. Prüfen Sie den Typ, bevor Sie darüber iterieren; Array-Einträge sind nicht unbedingt Strings.

Weitere Schemadetails finden Sie im vollständigen JSON Schema.

meta.latitude
number | null

Der Breitengrad, an dem das Medium aufgenommen wurde, zum Beispiel 52.5374.

meta.light_value
number | null

Der Lichtwert dieses Bildes, z. B. 6.9.

meta.line_count
number | null
meta.location
null | string

Der Ort, an dem dieses Bild aufgenommen wurde, in der Regel die Straße, zum Beispiel "Zingster Str. 32".

meta.longitude
number | null

Der Längengrad, an dem das Medium aufgenommen wurde, zum Beispiel 13.4034.

meta.lyrics
null | string
meta.mean_volume
number | null

Die mittlere Lautstärke der Audiodatei. Setzen Sie output_meta.mean_volume auf true, um die Messung anzufordern. Dieser Schlüssel kann mit dem Wert null vorhanden sein, wenn keine Messung angefordert wurde oder der Wert nicht verfügbar war. Allein das Vorhandensein des Felds zeigt nicht, dass die Messung durchgeführt wurde.

meta.metering_mode
null | string

Der Belichtungsmessmodus für dieses Bild, zum Beispiel "Multi-segment".

meta.modify_date
string | number | Array<string | number> | null

Weitere Schemadetails finden Sie im vollständigen JSON Schema.

meta.num_audio_streams
number | null
meta.num_subtitles
number | null
meta.num_video_streams
number | null
meta.orientation
string | number | null

Eines der folgenden Schemas kann gelten:

string | number
string | number
null
meta.overall_bitrate
number | null
meta.page_count
number | null
meta.page_size
null | string
meta.paragraph_count
number | null
meta.performer
null | string
meta.pixel_format
null | string
meta.previousStep
string
meta.producer
null | string
meta.reason
string
meta.recognized_text
Array<string> | Array<object>

Weitere Schemadetails finden Sie im vollständigen JSON Schema.

meta.reference_count
number | null
meta.relative_path
null | string
meta.resolution
null | string
meta.rights
string | number | null

Eines der folgenden Schemas kann gelten:

string | number
string | number
null
meta.rotation
number | null
meta.seekable
boolean | null

Gibt an, ob das Format des Videos das Springen zu einer bestimmten Position (Seeking) unterstützt, zum Beispiel true.

meta.segment_index
number | null
meta.shutter_speed
number | string | null

Die Verschlusszeit dieses Bildes, zum Beispiel "1/32".

Eines der folgenden Schemas kann gelten:

number | string
number | string
null
meta.starts_at
null | string
meta.state
string | number | null

Das Bundesland oder der Staat, in dem dieses Bild aufgenommen wurde, z. B. "Berlin".

Eines der folgenden Schemas kann gelten:

string | number
string | number
null
meta.stderr
string
meta.stdout
string
meta.step
string
meta.storage_url
string
meta.streams
object | null

Weitere Schemadetails finden Sie im vollständigen JSON Schema.

meta.svgViewBoxHeight
number | null
meta.svgViewBoxWidth
number | null
meta.thumb_index
number | null

Der Index des aktuellen Thumbnails, beginnend bei 0. Dieser Schlüssel ist nur bei Ergebnissen von 🤖/video/thumbs vorhanden.

meta.thumb_offset
number | string | null

Der Offset für das aktuelle Thumbnail in Sekunden. Dieser Schlüssel ist nur bei Ergebnissen von 🤖/video/thumbs vorhanden.

  • number
  • string
    Validierungsmuster (regulärer Ausdruck)^[\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]*[+-]?[0-9]+
  • null
meta.thumbhash
string

Base64-kodierter ThumbHash des gemäß EXIF ausgerichteten Bildes. Fordern Sie output_meta.thumbhash im erzeugenden Step an. Wird weggelassen, wenn er nicht angefordert wurde, nicht unterstützt wird, das Bild mehr als 40 Megapixel hat oder die Extraktion fehlschlägt. Behandeln Sie den Hash als private Bilddaten, wenn das Original privat ist.

Validierungsmuster (regulärer Ausdruck)^(?:[A-Za-z0-9+/]{4}){1,15}(?:[A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)$
meta.time_base
null | string
meta.title
string | number | null

Der Titel dieses Bildes, z. B. "Tree".

Eines der folgenden Schemas kann gelten:

string | number
string | number
null
meta.track
string | number | null

Eines der folgenden Schemas kann gelten:

string | number
string | number
null
meta.turbo
boolean | null
meta.version_id
string
meta.video_bitrate
number | null

Die Videobitrate des Videos, zum Beispiel 500000.

meta.video_codec
null | string

Der Video-Codec des Videos, zum Beispiel "ffh264".

meta.white_balance
null | string

Die Weißabgleich-Einstellung für dieses Bild, zum Beispiel "Manual".

meta.width
number | null

Die Breite des Mediums in Pixeln. Bei Videos, deren Anzeigeseitenverhältnis von ihrem Pixelseitenverhältnis abweicht, ist dies die vorgesehene Anzeigebreite.

meta.word_count
number | null
meta.xp_comment
null | string
meta.xp_keywords
string | number | null

Eines der folgenden Schemas kann gelten:

string | number
string | number
null
meta.xp_subject
string | number | null

Eines der folgenden Schemas kann gelten:

string | number
string | number
null
meta.xp_title
string | number | null

Eines der folgenden Schemas kann gelten:

string | number
string | number
null
meta.year
string | number | null

Eines der folgenden Schemas kann gelten:

string | number
string | number
null
mime

erforderlich

null | string

Der ermittelte MIME-Typ dieser Datei.

name

erforderlich

null | string

Der Name der Datei. Transloadit ändert die Erweiterung in diesem Feld, wenn die Datei durch Verarbeitung in ein anderes Format umgewandelt wird.

original_basename
null | string
original_id

erforderlich

string | Array<null | string>

Die eindeutige ID der ursprünglich hochgeladenen Datei, aus der diese Datei erzeugt wurde. Damit können Sie auch nach mehreren Steps der Verarbeitung bestimmen, welche Datei eines Uploads mit mehreren Dateien zur Erzeugung einer bestimmten Datei verwendet wurde.

Eines der folgenden Schemas kann gelten:

string
Array<null | string>
Array<null | string>
Schema eines Array-Elements
null | string
original_md5hash
null | string
original_name
null | string
original_path
string
queue
null | string
queue_time
number
sha256
string

SHA-256-Prüfsumme der gespeicherten Bytes in Kleinbuchstaben, sofern verfügbar.

Validierungsmuster (regulärer Ausdruck)^[a-f0-9]{64}$
size

erforderlich

number

Die Größe der Datei in Bytes.

ssl_url
null | string
thumbhash
string

Base64-codierter ThumbHash, der mit dieser gespeicherten Bildversion aufbewahrt wird, sofern verfügbar. Schützen Sie diese Bilddaten mit denselben Zugriffskontrollen wie das Original.

Validierungsmuster (regulärer Ausdruck)^(?:[A-Za-z0-9+/]{4}){1,15}(?:[A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)$
tus_upload_url
null | string
type

erforderlich

null | string

Eine abstrakte Kategorie zur Beschreibung der Datei. Bekannte Werte sind "audio", "document", "image", "office", "pdf", "swf", "video", "xls" oder null, wenn keine Kategorie erkannt wurde. Clients sollten weitere Zeichenfolgen akzeptieren, damit zukünftige Kategorien kompatibel bleiben.

url

erforderlich

null | string

Eine URL, über die die Datei heruntergeladen werden kann, oder null, wenn keine Auslieferungs-URL verfügbar ist. Temporäre URLs auf unseren Servern laufen nach einigen Stunden ab; exportieren Sie Dateien zur späteren Verwendung in einen Speicher. Ergebnisse von /transloadit/store in privatem Speicher geben sowohl für url als auch für ssl_url den Wert null zurück. Bewahren Sie den zurückgegebenen Workspace, asset_id und version_id als dauerhafte Referenz auf, vorbehaltlich der Zugriffs- und Aufbewahrungsbedingungen. /transloadit/import akzeptiert asset_id mit einer optionalen version_id oder einen veränderlichen path. Weder eine temporäre URL noch die Datei-id aus der Verarbeitung ist eine dauerhafte Speicherreferenz.

user_meta
object
Schema für zusätzliche Eigenschaften
beliebiger Wert
version_id
string

Unveränderliche Versions-ID, die zurückgegeben wird, nachdem Storage das Ergebnis finalisiert hat. Importieren Sie mit asset_id und dieser version_id, um nach einem Verschieben oder Überschreiben dieselben Bytes beizubehalten, vorbehaltlich der Aufbewahrungs- und Zugriffsbedingungen.

Validierungsmuster (regulärer Ausdruck)^[A-Za-z0-9_-]{21}[AQgw]$
workspace
string (minimale Länge: 1)

Slug des Workspaces, dem dieses gespeicherte Ergebnis gehört. Authentifizieren Sie sich für diesen Workspace, wenn Sie das Ergebnis importieren oder verwalten.

assembly_upload_meta_data_extracted

Nachricht, deren data-Feld diesen Namen als reinen Text enthält, ohne event-Feld.

assembly_uploading_finished

Nachricht, deren data-Feld diesen Namen als reinen Text enthält, ohne event-Feld.

HTTP 404, 503

Kein Response-Body.

Fehlerantwort

JSON-Response-Body. application/json text/plain; charset=utf-8

Schema des Response-Bodys
Vollständiges JSON Schema

JSON in einem neuen Tab öffnen

Mindestens eine dieser Eigenschaften ist erforderlich: error, message, reason

Die Antwort kann zusätzliche Felder enthalten.

FeldTyp und Beschreibung
assembly_id
string
error
string (minimale Länge: 1)
http_code
number | string
  • number
  • string
    Validierungsmuster (regulärer Ausdruck)^[\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]*[+-]?0*(?:0(?:[^0-9]|$)|(?:[1-9][0-9]{0,307}|1(?:(?:[0-6][0-9]{7}|7[0-8][0-9]{6}|79[0-6][0-9]{5}|797[0-5][0-9]{4}|7976[0-8][0-9]{3}|79769[0-2][0-9]{2}|7976930[0-9]{1}|7976931[0-2])[0-9]{300}|79769313(?:(?:[0-3][0-9]{7}|4[0-7][0-9]{6}|48[0-5][0-9]{5}|486[0-1][0-9]{4}|4862[0-2][0-9]{3}|486230[0-9]{2}|486231[0-4][0-9]{1}|4862315[0-7])[0-9]{292}|48623158(?:(?:0[0-6][0-9]{6}|07[0-8][0-9]{5}|079[0-2][0-9]{4}|0793[0-6][0-9]{3}|07937[0-1][0-9]{2}|079372[0-7][0-9]{1}|0793728[0-8])[0-9]{284}|07937289(?:(?:[0-6][0-9]{7}|70[0-9]{6}|71[0-3][0-9]{5}|7140[0-4][0-9]{3}|71405[0-2][0-9]{2}|7140530[0-2])[0-9]{276}|71405303(?:(?:[0-3][0-9]{7}|40[0-9]{6}|41[0-4][0-9]{5}|4150[0-6][0-9]{3}|41507[0-8][0-9]{2}|415079[0-8][0-9]{1}|4150799[0-2])[0-9]{268}|41507993(?:(?:[0-3][0-9]{7}|40[0-9]{6}|41[0-2][0-9]{5}|413[0-1][0-9]{4}|4132[0-6][0-9]{3}|413270[0-9]{2})[0-9]{260}|41327100(?:(?:[0-2][0-9]{7}|3[0-6][0-9]{6}|37[0-7][0-9]{5}|378[0-1][0-9]{4}|3782[0-5][0-9]{3}|37826[0-8][0-9]{2}|378269[0-2][0-9]{1}|3782693[0-5])[0-9]{252}|37826936(?:(?:0[0-9]{7}|1[0-6][0-9]{6}|17[0-2][0-9]{5}|173[0-6][0-9]{4}|1737[0-6][0-9]{3}|17377[0-7][0-9]{2}|173778[0-8][0-9]{1}|1737789[0-7])[0-9]{244}|17377898(?:(?:0[0-3][0-9]{6}|04[0-3][0-9]{5}|044[0-3][0-9]{4}|0444[0-8][0-9]{3}|04449[0-5][0-9]{2}|044496[0-7][0-9]{1}|0444968[0-1])[0-9]{236}|04449682(?:(?:[0-8][0-9]{7}|9[0-1][0-9]{6}|92[0-6][0-9]{5}|927[0-5][0-9]{4}|9276[0-3][0-9]{3}|92764[0-6][0-9]{2}|927647[0-4][0-9]{1})[0-9]{228}|92764750(?:(?:[0-8][0-9]{7}|9[0-3][0-9]{6}|94[0-5][0-9]{5}|946[0-5][0-9]{4}|9466[0-3][0-9]{3}|94664[0-8][0-9]{2}|94664900)[0-9]{220}|94664901(?:(?:[0-6][0-9]{7}|7[0-8][0-9]{6}|79[0-6][0-9]{5}|797[0-6][0-9]{4}|7977[0-4][0-9]{3}|79775[0-7][0-9]{2}|797758[0-6][0-9]{1}|7977587[0-1])[0-9]{212}|79775872(?:(?:0[0-6][0-9]{6}|070[0-8][0-9]{4}|0709[0-5][0-9]{3}|07096[0-2][0-9]{2}|070963[0-2][0-9]{1})[0-9]{204}|07096330(?:(?:[0-1][0-9]{7}|2[0-7][0-9]{6}|28[0-5][0-9]{5}|286[0-3][0-9]{4}|28640[0-9]{3}|28641[0-5][0-9]{2}|286416[0-5][0-9]{1}|2864166[0-8])[0-9]{196}|28641669(?:(?:[0-1][0-9]{7}|2[0-7][0-9]{6}|28[0-7][0-9]{5}|288[0-6][0-9]{4}|2887[0-8][0-9]{3}|288790[0-9]{2}|2887910[0-8])[0-9]{188}|28879109(?:(?:[0-3][0-9]{7}|4[0-5][0-9]{6}|46[0-4][0-9]{5}|465[0-4][0-9]{4}|4655[0-4][0-9]{3}|46555[0-4][0-9]{2}|465555[0-3][0-9]{1}|4655554[0-6])[0-9]{180}|46555547(?:(?:[0-7][0-9]{7}|8[0-4][0-9]{6}|850[0-9]{5}|851[0-8][0-9]{4}|8519[0-3][0-9]{3}|851940[0-3][0-9]{1})[0-9]{172}|85194040(?:(?:[0-1][0-9]{7}|2[0-5][0-9]{6}|26[0-2][0-9]{5}|2630[0-5][0-9]{3}|26306[0-4][0-9]{2}|263065[0-6][0-9]{1}|2630657[0-3])[0-9]{164}|26306574(?:(?:[0-7][0-9]{7}|8[0-7][0-9]{6}|88[0-5][0-9]{5}|886[0-6][0-9]{4}|88670[0-9]{3}|88671[0-4][0-9]{2}|8867150[0-4])[0-9]{156}|88671505(?:(?:[0-7][0-9]{7}|8[0-1][0-9]{6}|820[0-5][0-9]{4}|8206[0-7][0-9]{3}|820680[0-9]{2}|820681[0-8][0-9]{1})[0-9]{148}|82068190(?:(?:[0-7][0-9]{7}|8[0-8][0-9]{6}|890[0-1][0-9]{4}|8902000[0-6])[0-9]{140}|89020007(?:(?:0[0-7][0-9]{6}|08[0-2][0-9]{5}|083[0-7][0-9]{4}|0838[0-2][0-9]{3}|08383[0-5][0-9]{2}|083836[0-6][0-9]{1}|0838367[0-5])[0-9]{132}|08383676(?:(?:[0-1][0-9]{7}|2[0-6][0-9]{6}|27[0-2][0-9]{5}|273[0-7][0-9]{4}|2738[0-4][0-9]{3}|27385[0-3][0-9]{2}|273854[0-7][0-9]{1}|2738548[0-3])[0-9]{124}|27385484(?:(?:[0-4][0-9]{7}|5[0-7][0-9]{6}|580[0-9]{5}|581[0-6][0-9]{4}|5817[0-6][0-9]{3}|581770[0-9]{2}|5817710[0-9]{1}|5817711[0-4])[0-9]{116}|58177115(?:(?:[0-2][0-9]{7}|30[0-9]{6}|31[0-6][0-9]{5}|317[0-5][0-9]{4}|3176[0-3][0-9]{3}|31764[0-3][0-9]{2}|317644[0-6][0-9]{1}|3176447[0-4])[0-9]{108}|31764475(?:(?:[0-6][0-9]{7}|7[0-2][0-9]{6}|730[0-1][0-9]{4}|7302[0-6][0-9]{3}|7302700[0-5])[0-9]{100}|73027006(?:(?:[0-8][0-9]{7}|9[0-7][0-9]{6}|98[0-4][0-9]{5}|985[0-4][0-9]{4}|9855[0-4][0-9]{3}|98555[0-6][0-9]{2}|9855570[0-9]{1}|9855571[0-2])[0-9]{92}|98555713(?:(?:[0-5][0-9]{7}|6[0-5][0-9]{6}|66[0-8][0-9]{5}|669[0-4][0-9]{4}|6695[0-8][0-9]{3}|66959[0-5][0-9]{2}|669596[0-1][0-9]{1}|6695962[0-1])[0-9]{84}|66959622(?:(?:[0-7][0-9]{7}|8[0-3][0-9]{6}|84[0-1][0-9]{5}|842[0-8][0-9]{4}|84290[0-9]{3}|84291[0-3][0-9]{2}|842914[0-7][0-9]{1}|84291480)[0-9]{76}|84291481(?:(?:[0-8][0-9]{7}|9[0-7][0-9]{6}|98[0-5][0-9]{5}|9860[0-7][0-9]{3}|98608[0-2][0-9]{2}|986083[0-3][0-9]{1}|9860834[0-8])[0-9]{68}|98608349(?:(?:[0-2][0-9]{7}|3[0-5][0-9]{6}|36[0-3][0-9]{5}|364[0-6][0-9]{4}|3647[0-4][0-9]{3}|36475[0-1][0-9]{2}|364752[0-8][0-9]{1}|3647529[0-1])[0-9]{60}|36475292(?:(?:[0-6][0-9]{7}|70[0-9]{6}|71[0-8][0-9]{5}|7190[0-6][0-9]{3}|71907[0-3][0-9]{2}|7190740[0-9]{1}|7190741[0-5])[0-9]{52}|71907416(?:(?:[0-7][0-9]{7}|8[0-3][0-9]{6}|84[0-3][0-9]{5}|844[0-3][0-9]{4}|8444[0-2][0-9]{3}|84443[0-5][0-9]{2}|844436[0-4][0-9]{1}|8444365[0-4])[0-9]{44}|84443655(?:(?:0[0-9]{7}|10[0-6][0-9]{5}|1070[0-3][0-9]{3}|10704[0-2][0-9]{2}|107043[0-3][0-9]{1}|1070434[0-1])[0-9]{36}|10704342(?:(?:[0-6][0-9]{7}|70[0-9]{6}|710[0-9]{5}|711[0-4][0-9]{4}|7115[0-4][0-9]{3}|71155[0-8][0-9]{2}|711559[0-5][0-9]{1}|7115596[0-8])[0-9]{28}|71155969(?:(?:[0-8][0-9]{7}|9[0-4][0-9]{6}|950[0-7][0-9]{4}|95080[0-8][0-9]{2}|950809[0-2][0-9]{1})[0-9]{20}|95080930(?:(?:[0-3][0-9]{7}|4[0-1][0-9]{6}|42[0-7][0-9]{5}|428[0-7][0-9]{4}|428800[0-9]{2}|428801[0-6][0-9]{1}|4288017[0-6])[0-9]{12}|42880177(?:(?:[0-8][0-9]{7}|90[0-3][0-9]{5}|9040[0-9]{4}|9041[0-6][0-9]{3}|90417[0-3][0-9]{2}|904174[0-3][0-9]{1}|9041744[0-8])[0-9]{4}|90417449(?:(?:[0-6][0-9]{3}|7[0-6][0-9]{2}|77[0-8][0-9]{1}|7790)|7791))))))))))))))))))))))))))))))))))))))))(?:[^0-9]|$))
message
string

Menschenlesbare Erklärung des Fehlers. Die Formulierung kann variieren; verwenden Sie den Code error, wenn Sie einen bestimmten Fehlerfall behandeln.

reason
null | string | number | boolean | Array<beliebiger Wert> | object

Eines der folgenden Schemas kann gelten:

null
string
number
boolean
Array<beliebiger Wert>
Array<beliebiger Wert>
Schema eines Array-Elements
beliebiger Wert
object
object
Schema für zusätzliche Eigenschaften
beliebiger Wert

Weitere Informationen zum Antwortformat finden Sie in der Mozilla-Dokumentation zu Server-Sent Events.