Transloadit

Diffuser les modifications de l’Assembly en temps réel

Diffuse les changements d’Assembly Status sous forme de Server-Sent Events.

GET{UPDATE_STREAM_URL}

Dans la réponse renvoyée après la création d’une Assembly, vous trouverez deux champs permettant de récupérer l’Assembly Status : assembly_ssl_url et update_stream_url. Vous pouvez récupérer l’Assembly Status actuel à partir de l’URL fournie dans assembly_ssl_url. Pour obtenir des informations sur la progression de l’Assembly, vous pouvez soit interroger régulièrement cette URL, soit vous abonner au flux de mises à jour, décrit dans ce document.

Événements envoyés par le serveur (Server-Sent Events)

La propriété update_stream_url de l’Assembly Status définit une URL à laquelle le flux de mises à jour de l’Assembly correspondante est disponible au moyen d’événements envoyés par le serveur.

Les événements envoyés par le serveur (server-sent events) sont une technologie web permettant d’envoyer des notifications en direct du serveur vers un client via HTTP. Elle est similaire aux Web Sockets, mais n’autorise que des messages unidirectionnels du serveur vers le client et repose sur un format simple, basé sur du texte.

Tant que l’Assembly est à l’état de téléversement ou d’exécution, un client peut se connecter à ce point de terminaison en envoyant une requête GET avec le champ d’en-tête Accept: text/event-stream à l’URL indiquée dans update_stream_url, puis analyser le flux de réponse. Le serveur peut envoyer au client une combinaison de messages et d’événements. La différence entre les deux est que les événements comportent une charge utile supplémentaire contenant des informations, contrairement aux messages.

Plusieurs clients peuvent s’abonner à la même Assembly. La fermeture d’une connexion laisse les autres connectées. Lors de l’arrêt de l’instance de téléversement côté serveur de Transloadit, les flux existants se ferment et les nouvelles connexions reçoivent une réponse HTTP 503 vide. Récupérez l’Assembly Status actuel pour vérifier si le traitement est terminé.

Messages

Un message se compose du nom du message, sans charge utile supplémentaire. Sur le réseau, un message nommé assembly_finished se présente ainsi ([NL] indique un saut de ligne) :

data: assembly_finished[NL]
[NL]

Transloadit envoie les messages suivants :

  • assembly_upload_meta_data_extracted est émis lorsque tous les téléversements sont terminés et que les métadonnées ont été extraites pour chacun d’eux.
  • assembly_uploading_finished est émis lorsque tous les téléversements de cette Assembly sont terminés et que l’Assembly passe de l’état de téléversement à l’état d’exécution.
  • assembly_finished est émis lorsque l’Assembly est terminée, ce qui ne signifie pas nécessairement que le traitement a réussi. Il est également envoyé après une annulation ou lors de la connexion à une Assembly déjà terminée, y compris une Assembly qui a échoué. Le serveur met fin au flux après ce message. Récupérez assembly_ssl_url et examinez le statut final : ok: "ASSEMBLY_COMPLETED" indique une réussite, ok: "ASSEMBLY_CANCELED" indique une annulation et error indique un échec.
  • ping est émis périodiquement pour maintenir la connexion active pendant le traitement de l’Assembly. Il est actuellement envoyé toutes les minutes, mais cet intervalle pourrait changer à l’avenir.

Événements

Un événement se compose du nom de l’événement et d’une charge utile supplémentaire. Sur le réseau, un événement nommé assembly_result_finished se présente ainsi ([NL] indique un saut de ligne) :

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 envoie les événements suivants :

  • assembly_error est émis lorsqu’une erreur survient pendant l’exécution de l’Assembly. Le serveur mettra fin au flux après cet événement. Des informations supplémentaires sur l’erreur sont incluses, par exemple :

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

  • assembly_upload_finished est émis pour chaque téléversement terminé. Des informations supplémentaires sur le fichier téléversé sont incluses. La structure est identique à celle d’un objet du tableau uploads de l’Assembly Status, par exemple :

    {
  "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 est émis chaque fois qu’un nouveau résultat d’un Step est disponible. La charge utile est un tuple [stepName, file]. L’objet fichier a la même structure qu’une entrée de results[stepName] dans l’Assembly Status, par exemple :

    [
  "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 est émis à intervalles réguliers avec des informations sur l’Execution Progress global de l’Assembly et de ses fichiers. La structure et les mécanismes sont détaillés dans Assembly Execution Progress  (English), par exemple :

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

    Remarque : progress_per_original_file est indexé par original_id. Les fichiers importés sans original_id n’apparaîtront pas dans cette liste.

Le flux ne rejoue pas les événements antérieurs. En particulier, un écouteur assembly_error ne peut pas signaler une erreur survenue avant votre connexion. Une fois que l’Assembly ne se trouve plus dans la mémoire de l’instance de téléversement côté serveur de Transloadit, l’URL du flux renvoie HTTP 404. En cas de déconnexion ou de flux indisponible, récupérez assembly_ssl_url. Si l’Assembly est toujours en cours de téléversement ou d’exécution, continuez à interroger cette URL. La seule fermeture d’un flux ne permet pas d’établir une réussite.

Exemple en JavaScript

Les navigateurs modernes prennent en charge nativement les événements envoyés par le serveur via le constructeur EventSource. En supposant que l’Assembly Status est stocké dans la variable assembly_status, le client peut écouter le message assembly_finished, le message assembly_uploading_finished et l’événement assembly_result_finished comme suit : Si le flux se déconnecte, cet exemple passe à une interrogation toutes les deux secondes jusqu’à ce que l’Assembly atteigne un statut final. Les échecs HTTP ou réseau sont signalés au lieu d’être considérés comme une réussite.

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)
})

Exemple de requête

Définissez UPDATE_STREAM_URL sur l’URL update_stream_url complète issue de la réponse de création de l’Assembly. Ne remplacez pas son nom d’hôte.

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

En-têtes de requête obligatoires

  • accept (valeur fixe), obligatoire. Valeur acceptée : "text/event-stream". Les valeurs des occurrences répétées d’un en-tête sont concaténées avant la mise en correspondance.

Paramètres de requête facultatifs pour la réponse

  • callback (Nom de la fonction de rappel JavaScript). Encapsule les réponses JSON dans une fonction de rappel JSONP. Le nom de la fonction de rappel doit correspondre à ^(?:_jqjsp[0-9]*|jQuery[0-9]+_[0-9]+)$. Seule la dernière occurrence est utilisée ; une valeur vide est ignorée. Les noms de fonction de rappel invalides renvoient le statut HTTP 403. La réponse transformée utilise le statut HTTP 200. La fonction de rappel est appliquée après la sérialisation de la réponse.

Requête

Aucun corps de requête supplémentaire ni aucun champ supplémentaire n’est requis.

Réponse

Voici un exemple de corps de réponse :

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

Succès 2xx

Flux de réponse Server-Sent Events. text/event-stream

assembly_error

Événement nommé avec une charge utile JSON dans son champ data. Le serveur ferme le flux après cette notification. Récupérez l’état final de la ressource pour déterminer le résultat.

Charge utile de l’événement
Schéma JSON complet

Ouvrir le JSON dans un nouvel onglet

Les champs autres que ceux répertoriés pour cet objet sont acceptés.

ChampType et description
error
string

Code d’erreur, lorsqu’il est disponible. Récupérez l’Assembly Status final même lorsque ce champ est absent.

Valeurs autorisées (362)
  • "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"
  • "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

Statut HTTP associé à l’erreur. Ce champ ne modifie pas le statut HTTP du flux déjà ouvert.

message
string

Un message lisible par un humain expliquant l’état de cette Assembly. Ce message n’est pas toujours présent.

previousStep
string

Nom du Step précédent associé à l’erreur, lorsqu’il est disponible.

reason
null | string | number | boolean | Array<n’importe quelle valeur> | object

Détails de diagnostic facultatifs. Ne supposez pas que cette valeur est une chaîne de caractères et ne l’affichez pas directement ; utilisez message pour le texte lisible par un humain. Les détails de diagnostic peuvent varier ; utilisez le code error pour la gestion programmatique des erreurs.

N’importe lequel des schémas suivants peut s’appliquer :

null
string
number
boolean
Array<n’importe quelle valeur>
Array<n’importe quelle valeur>
Schéma d’un élément de tableau
n’importe quelle valeur
object
object
Schéma de la propriété supplémentaire
n’importe quelle valeur
step
string

Nom du Step associé à l’erreur, lorsqu’il est disponible.

assembly_execution_progress

Événement nommé avec une charge utile JSON dans son champ data.

Charge utile de l’événement
Schéma JSON complet

Ouvrir le JSON dans un nouvel onglet

Les champs autres que ceux répertoriés pour cet objet sont acceptés.

ChampType et description
progress_combined

obligatoire

number | null

Progression globale estimée en pourcentage. Null signifie que la progression globale ne peut pas être estimée.

progress_per_original_file

obligatoire

Array<object>

Estimations de la progression pour les fichiers d’entrée d’origine. Les fichiers importés sans ID d’origine ne sont pas inclus.

Schéma d’un élément de tableau
object

progress_per_original_file[]: Les champs autres que ceux répertoriés pour cet objet sont acceptés.

ChampType et description
progress_per_original_file[].original_id

obligatoire

string

ID du fichier d’entrée d’origine auquel se rapporte cette estimation de progression.

progress_per_original_file[].progress

obligatoire

number

Progression estimée du traitement de ce fichier original, en pourcentage.

assembly_finished

Message dont le champ data contient ce nom en texte brut, sans champ event. Le serveur ferme le flux après cette notification. Récupérez l’état final de la ressource pour déterminer le résultat.

ping

Message dont le champ data contient ce nom en texte brut, sans champ event.

assembly_result_finished

Événement nommé avec une charge utile JSON dans son champ data.

Charge utile de l’événement
Schéma JSON complet

Ouvrir le JSON dans un nouvel onglet

[string, object] (nombre minimal d’éléments : 2, nombre maximal d’éléments : 2)
Élément 1 du tuple
string
Élément 2 du tuple

[1]: Les champs autres que ceux répertoriés pour cet objet sont acceptés.

ChampType et description
[1].as
string | Array<string> | null

N’importe lequel des schémas suivants peut s’appliquer :

string
Array<string>
Array<string>
Schéma d’un élément de tableau
string
null
[1].asset_id
string

Identité stable d’un fichier stocké par /transloadit/store. Conservez-la avec son Workspace et son version_id ; l’id ordinaire du fichier n’est pas un identifiant de ressource de stockage.

[1].asset_version
number

Numéro de révision de la ressource stockée. Utilisez version_id, et non ce nombre, pour sélectionner les octets exacts conservés.

[1].basename
null | string

Le nom du fichier sans son extension.

[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

L’extension du fichier.

[1].field
null | string

Le nom du champ de formulaire utilisé pour envoyer ce fichier.

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

Indique si cette version stockée de l’image possède un canal alpha, lorsque cette information est connue.

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

Un identifiant aléatoire et unique utilisé en interne par Transloadit pour suivre le fichier.

[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

Un objet contenant des métadonnées supplémentaires extraites du fichier, comme indiqué ci-dessous.

N’importe lequel des schémas suivants peut s’appliquer :

object
object

[1].meta: Les champs autres que ceux répertoriés pour cet objet sont acceptés.

ChampType et description
[1].meta.album
string | number | null

N’importe lequel des schémas suivants peut s’appliquer :

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

Le réglage d’ouverture pour cette image, par exemple 5.7.

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

De nombreuses applications qui produisent de l’audio ajoutent au fichier audio des informations supplémentaires telles que artist, year, album, genre.

N’importe lequel des schémas suivants peut s’appliquer :

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

Le rapport largeur/hauteur de l’image, qui correspond à sa largeur divisée par sa hauteur. Il sera égal à 0 si, pour une raison quelconque, la hauteur de l’image est égale à 0.

[1].meta.audio_bitrate
number | null

Le débit binaire audio en bits par seconde, tous canaux confondus, par exemple 128000.

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

Le nombre de canaux audio, généralement 2 pour la stéréo.

[1].meta.audio_codec
null | string

Le codec audio, par exemple "faad". Consultez les codecs audio pris en charge  (English).

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

La fréquence d’échantillonnage audio en hertz, par exemple 44100.

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

L’auteur de la prise de vue. Certains appareils photo renseignent ce champ plutôt que creator.

N’importe lequel des schémas suivants peut s’appliquer :

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

À ne pas confondre avec la couleur dominante, qui ne prend en compte que la couleur de pixel la plus fréquente et dont les cas d’utilisation sont limités. La couleur moyenne est calculée en réduisant d’abord l’image d’entrée à 1 pixel.

[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

La ville où cette image a été prise, par exemple "Berlin".

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

Des détails supplémentaires sur le schéma sont disponibles dans le schéma JSON complet.

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

L’espace colorimétrique détecté du média, par exemple "sRGB" ou "Gray". L’espace colorimétrique de la vidéo est disponible lorsqu’il est détecté et que l’extraction des métadonnées est activée ; output_meta.colorspace: true n’est pas requis. Définir output_meta: false désactive l’extraction des métadonnées.

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

Le champ copyright des métadonnées.

Des détails supplémentaires sur le schéma sont disponibles dans le schéma JSON complet.

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

Le champ de métadonnées relatif à la mention de droits d’auteur.

N’importe lequel des schémas suivants peut s’appliquer :

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

Le pays dans lequel cette image a été prise, par exemple "Germany".

[1].meta.country_code
null | string

Le code du pays où cette image a été prise, par exemple "de".

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

N’importe lequel des schémas suivants peut s’appliquer :

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

Le créateur qui a pris l’image.

Des détails supplémentaires sur le schéma sont disponibles dans le schéma JSON complet.

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

L’horodatage de création indiqué par les métadonnées du média, lorsqu’il est disponible.

N’importe lequel des schémas suivants peut s’appliquer :

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

L’horodatage de modification du fichier multimédia dans le système de fichiers.

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

La date et l’heure auxquelles le média a été enregistré, au format YYYY/MM/DD HH:MM:SS TZ, par exemple "2010/06/30 22:16:06 GMT".

N’importe lequel des schémas suivants peut s’appliquer :

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

Une description de cette image, par exemple "This tree is very old.".

N’importe lequel des schémas suivants peut s’appliquer :

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

Des détails supplémentaires sur le schéma sont disponibles dans le schéma JSON complet.

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

Le nom de l’appareil qui a enregistré le média, par exemple "iPhone 3GS".

N’importe lequel des schémas suivants peut s’appliquer :

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

La version logicielle de l’appareil qui a enregistré le média, par exemple "3.1.2".

N’importe lequel des schémas suivants peut s’appliquer :

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

Le fabricant de l’appareil qui a enregistré le média, par exemple "Apple".

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

N’importe lequel des schémas suivants peut s’appliquer :

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

Renvoie un tableau contenant jusqu’à 10 couleurs dominantes de l’image sous forme de valeurs hexadécimales. Omettez output_meta.dominant_colors pour ne pas effectuer cette extraction. Fournir cette propriété, y compris avec la valeur false, revient à demander l’extraction et peut entraîner des frais d’utilisation supplémentaires lorsque des couleurs sont renvoyées. Définir output_meta lui-même sur false désactive l’extraction de métadonnées supplémentaires ; des vérifications de base du type et de la taille du fichier peuvent toujours être effectuées.

Des détails supplémentaires sur le schéma sont disponibles dans le schéma JSON complet.

[1].meta.duration
number | null

La durée du fichier audio en secondes.

[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

La correction d’exposition de cette image, par exemple "+4/3".

N’importe lequel des schémas suivants peut s’appliquer :

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

Le mode d’exposition de cette image, par exemple "Auto".

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

Le temps d’exposition de cette image, par exemple "1/30".

N’importe lequel des schémas suivants peut s’appliquer :

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

Le nombre d’ouverture de cette image, par exemple 5.6.

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

Des détails supplémentaires sur le schéma sont disponibles dans le schéma JSON complet.

[1].meta.field_order
null | string

L’ordre des trames indiqué par FFprobe, par exemple "tt", "bb", "tb", "bt" ou "progressive". Définissez output_meta.interlaced sur true pour demander la détection qui renseigne ce champ de diagnostic. Cette clé peut être présente avec la valeur null lorsque la détection n’a pas été demandée ou que l’ordre des trames n’était pas disponible. Utilisez interlaced pour une simple logique conditionnelle entre entrelacé et progressif.

[1].meta.flash
null | string

Les réglages du flash pour cette image, par exemple "Off, Did not fire".

[1].meta.focal_length
null | string

La distance focale de cette image, par exemple "55.0 mm".

[1].meta.frame_count
number | null

Le nombre d’images dans un fichier GIF animé. Cette valeur est 1 par défaut pour tous les autres types d’images.

[1].meta.framerate
number | null

La fréquence d’images de la vidéo, par exemple 29.5.

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

N’importe lequel des schémas suivants peut s’appliquer :

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

Indique si l’image d’origine possède un canal alpha, y compris les images entièrement opaques dotées d’un canal alpha. Ce champ est renvoyé avec thumbhash ; son absence signifie que cette information est inconnue.

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

Vaut true si l’image contient un tracé de détourage, false sinon.

[1].meta.has_transparency
boolean | null

Indique si l’image comporte des zones transparentes. Définissez output_meta.has_transparency sur true pour demander une vérification de la transparence. Les valeurs booléennes dont on sait qu’elles sont fausses, telles que false pour les images JPEG, peuvent être renvoyées même lorsque cette option est omise ou vaut false. Si output_meta lui-même est défini sur false, l’extraction de métadonnées supplémentaires n’est pas effectuée ; les vérifications de base du type et de la taille du fichier peuvent néanmoins être exécutées.

[1].meta.height
number | null

La hauteur du média en pixels.

[1].meta.interlace_detection
object | null

Détails de diagnostic du détecteur d’entrelacement de Transloadit. Cet objet peut inclure sampled_frames, tff, bff, progressive, undetermined, confidence, method et ffprobe_field_order. Définissez output_meta.interlaced sur true pour demander la détection. Cette clé peut être présente avec la valeur null lorsque la détection n’a pas été demandée ; vérifiez que sa valeur est un objet non nul avant d’en lire les propriétés.

Des détails supplémentaires sur le schéma sont disponibles dans le schéma JSON complet.

[1].meta.interlaced
boolean | null

Indique si la vidéo semble utiliser un balayage entrelacé : true pour les vidéos entrelacées ou false pour les vidéos à balayage progressif. Définissez output_meta.interlaced sur true pour demander la détection. Cette clé peut être présente avec la valeur null lorsque la détection n’a pas été demandée ou lorsque la détection demandée n’a pas permis de conclure. La présence du champ ne suffit pas à indiquer que la détection a été exécutée.

[1].meta.iso
number | null

La valeur ISO de cette image, par exemple 800.

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

Mots-clés extraits des métadonnées du fichier : une chaîne de caractères, un nombre fini ou un tableau dont les éléments peuvent être des chaînes de caractères, des nombres finis ou des booléens. Par exemple, ["tree", "nature"]. Le champ peut être absent ou avoir la valeur null. Vérifiez son type avant de le parcourir ; les éléments du tableau ne sont pas nécessairement des chaînes de caractères.

Des détails supplémentaires sur le schéma sont disponibles dans le schéma JSON complet.

[1].meta.latitude
number | null

La latitude à laquelle le média a été enregistré, par exemple 52.5374.

[1].meta.light_value
number | null

La valeur de luminosité de cette image, par exemple 6.9.

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

Le lieu où cette image a été prise, généralement la rue, par exemple "Zingster Str. 32".

[1].meta.longitude
number | null

La longitude à laquelle le média a été enregistré, par exemple 13.4034.

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

Le volume moyen du fichier audio. Définissez output_meta.mean_volume sur true pour demander la mesure. Cette clé peut être présente avec la valeur null lorsque la mesure n’a pas été demandée ou que la valeur n’était pas disponible. La seule présence du champ ne permet pas de conclure que la mesure a été effectuée.

[1].meta.metering_mode
null | string

Le mode de mesure pour cette image, par exemple "Multi-segment".

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

N’importe lequel des schémas suivants peut s’appliquer :

string | number
string | number
null
[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

N’importe lequel des schémas suivants peut s’appliquer :

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>

Des détails supplémentaires sur le schéma sont disponibles dans le schéma JSON complet.

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

N’importe lequel des schémas suivants peut s’appliquer :

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

Indique si le format de la vidéo prend en charge la recherche de position, par exemple true.

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

La vitesse d’obturation de cette image, par exemple "1/32".

N’importe lequel des schémas suivants peut s’appliquer :

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

L’État dans lequel cette image a été prise, par exemple "Berlin".

N’importe lequel des schémas suivants peut s’appliquer :

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

Des détails supplémentaires sur le schéma sont disponibles dans le schéma JSON complet.

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

L’index de la vignette actuelle, avec une numérotation commençant à 0. Cette clé n’est présente que pour les résultats de 🤖/video/thumbs  (English).

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

Le décalage de la vignette actuelle, en secondes. Cette clé n’est présente que pour les résultats de 🤖/video/thumbs  (English).

  • number
  • string
    Motif de validation (expression régulière)^[\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

ThumbHash encodé en Base64 de l’image orientée selon les métadonnées EXIF. Demandez output_meta.thumbhash sur le Step qui produit l’image. Omis s’il n’est pas demandé, s’il n’est pas pris en charge, si l’image dépasse 40 mégapixels ou si l’extraction échoue. Traitez l’empreinte comme des données d’image privées lorsque l’image d’origine est privée.

Motif de validation (expression régulière)^(?:[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

Le titre de cette image, par exemple "Tree".

N’importe lequel des schémas suivants peut s’appliquer :

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

N’importe lequel des schémas suivants peut s’appliquer :

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

Le débit binaire de la vidéo, par exemple 500000.

[1].meta.video_codec
null | string

Le codec vidéo de la vidéo, par exemple "ffh264".

[1].meta.white_balance
null | string

Le réglage de la balance des blancs de cette image, par exemple "Manual".

[1].meta.width
number | null

La largeur du média en pixels. Pour une vidéo dont le ratio d’affichage diffère du ratio de pixels, il s’agit de la largeur d’affichage prévue.

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

N’importe lequel des schémas suivants peut s’appliquer :

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

N’importe lequel des schémas suivants peut s’appliquer :

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

N’importe lequel des schémas suivants peut s’appliquer :

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

Le type MIME déterminé pour ce fichier.

[1].name
null | string

Le nom du fichier. Transloadit modifiera l’extension utilisée pour ce champ si le fichier est converti dans un autre format lors du traitement.

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

L’ID unique du fichier téléversé d’origine à partir duquel ce fichier a été généré. Cet ID est utile pour déterminer quel fichier d’un téléversement de plusieurs fichiers a été utilisé pour générer un fichier donné, après plusieurs Steps de traitement.

N’importe lequel des schémas suivants peut s’appliquer :

string
Array<null | string>
Array<null | string>
Schéma d’un élément de tableau
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>
Schéma d’un élément de tableau
object

[1].playlists[]: Les champs autres que ceux répertoriés pour cet objet sont acceptés.

ChampType et description
[1].playlists[].content
string
[1].playlists[].meta
object

Des détails supplémentaires sur le schéma sont disponibles dans le schéma JSON complet.

[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

Somme de contrôle SHA-256 en minuscules des octets stockés, lorsqu’elle est disponible.

Motif de validation (expression régulière)^[a-f0-9]{64}$
[1].signed_ssl_url
string
[1].signed_url
string
[1].size
number | null

La taille du fichier, en octets.

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

ThumbHash encodé en Base64, conservé avec cette version stockée de l’image, lorsqu’il est disponible. Protégez ces données d’image avec les mêmes contrôles d’accès que l’original.

Motif de validation (expression régulière)^(?:[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

Une catégorie abstraite décrivant le fichier. Les valeurs connues sont "audio", "document", "image", "office", "pdf", "swf", "video", "xls" ou null lorsqu’aucune catégorie n’a été détectée. Les consommateurs devraient accepter d’autres chaînes afin de maintenir la compatibilité avec les futures catégories.

[1].url
null | string

Une URL à partir de laquelle le fichier peut être téléchargé, ou null lorsqu’aucune URL de diffusion n’est disponible. Les URL temporaires sur nos serveurs expirent au bout de quelques heures ; exportez les fichiers vers un espace de stockage pour les utiliser ultérieurement. Les résultats de /transloadit/store pour le stockage privé renvoient null à la fois pour url et pour ssl_url. Conservez le Workspace, l’asset_id et le version_id renvoyés pour disposer d’une référence durable, sous réserve des conditions d’accès et de conservation. /transloadit/import accepte un asset_id avec un version_id facultatif, ou un path modifiable. Ni une URL temporaire ni l’id du fichier de traitement ne constituent une référence durable au stockage.

[1].user_meta
object | null

N’importe lequel des schémas suivants peut s’appliquer :

object
object
Schéma de la propriété supplémentaire
n’importe quelle valeur
null
[1].version_id
string

Identifiant de version immuable renvoyé après la finalisation du résultat par le stockage. Importez avec asset_id et ce version_id pour conserver les mêmes octets après un déplacement ou un écrasement, sous réserve des conditions de rétention et d’accès.

Motif de validation (expression régulière)^[A-Za-z0-9_-]{21}[AQgw]$
[1].vimeo
object

[1].vimeo: Les champs autres que ceux répertoriés pour cet objet sont acceptés.

[1].vimeo.title

obligatoire

string
[1].vimeo.uri

obligatoire

string
[1].width
number | null
[1].workspace
string (longueur minimale : 1)

Slug du Workspace auquel appartient ce résultat stocké. Authentifiez-vous pour ce Workspace lorsque vous importez ou gérez ce résultat.

assembly_upload_finished

Événement nommé avec une charge utile JSON dans son champ data.

Charge utile de l’événement
Schéma JSON complet

Ouvrir le JSON dans un nouvel onglet

Les champs autres que ceux répertoriés pour cet objet sont acceptés.

ChampType et description
as
string | Array<string> | null

N’importe lequel des schémas suivants peut s’appliquer :

string
Array<string>
Array<string>
Schéma d’un élément de tableau
string
null
asset_id
string

Identité stable d’un fichier stocké par /transloadit/store. Conservez-la avec son Workspace et son version_id ; l’id ordinaire du fichier n’est pas un identifiant de ressource de stockage.

asset_version
number

Numéro de révision de la ressource stockée. Utilisez version_id, et non ce nombre, pour sélectionner les octets exacts conservés.

basename

obligatoire

null | string

Le nom du fichier sans son extension.

cost
number | null
exec_time
number
ext

obligatoire

string

L’extension du fichier.

field

obligatoire

null | string

Le nom du champ de formulaire utilisé pour envoyer ce fichier.

from_batch_import
boolean
has_alpha
boolean

Indique si cette version stockée de l’image possède un canal alpha, lorsque cette information est connue.

id

obligatoire

string

Un identifiant aléatoire et unique utilisé en interne par Transloadit pour suivre le fichier.

import_url
string
is_temp_url
boolean
is_tus_file
boolean
md5hash
null | string
meta

obligatoire

object

Un objet contenant des métadonnées supplémentaires extraites du fichier, comme indiqué ci-dessous.

meta: Les champs autres que ceux répertoriés pour cet objet sont acceptés.

meta.album
string | number | null

N’importe lequel des schémas suivants peut s’appliquer :

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

Le réglage d’ouverture pour cette image, par exemple 5.7.

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

De nombreuses applications qui produisent de l’audio ajoutent au fichier audio des informations supplémentaires telles que artist, year, album, genre.

N’importe lequel des schémas suivants peut s’appliquer :

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

Le rapport largeur/hauteur de l’image, qui correspond à sa largeur divisée par sa hauteur. Il sera égal à 0 si, pour une raison quelconque, la hauteur de l’image est égale à 0.

meta.audio_bitrate
number | null

Le débit binaire audio en bits par seconde, tous canaux confondus, par exemple 128000.

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

Le nombre de canaux audio, généralement 2 pour la stéréo.

meta.audio_codec
null | string

Le codec audio, par exemple "faad". Consultez les codecs audio pris en charge  (English).

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

La fréquence d’échantillonnage audio en hertz, par exemple 44100.

meta.author
string | number | null

L’auteur de la prise de vue. Certains appareils photo renseignent ce champ plutôt que creator.

N’importe lequel des schémas suivants peut s’appliquer :

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

À ne pas confondre avec la couleur dominante, qui ne prend en compte que la couleur de pixel la plus fréquente et dont les cas d’utilisation sont limités. La couleur moyenne est calculée en réduisant d’abord l’image d’entrée à 1 pixel.

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

La ville où cette image a été prise, par exemple "Berlin".

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

Des détails supplémentaires sur le schéma sont disponibles dans le schéma JSON complet.

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

L’espace colorimétrique détecté du média, par exemple "sRGB" ou "Gray". L’espace colorimétrique de la vidéo est disponible lorsqu’il est détecté et que l’extraction des métadonnées est activée ; output_meta.colorspace: true n’est pas requis. Définir output_meta: false désactive l’extraction des métadonnées.

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

Le champ copyright des métadonnées.

Des détails supplémentaires sur le schéma sont disponibles dans le schéma JSON complet.

meta.copyright_notice
string | number | null

Le champ de métadonnées relatif à la mention de droits d’auteur.

N’importe lequel des schémas suivants peut s’appliquer :

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

Le pays dans lequel cette image a été prise, par exemple "Germany".

meta.country_code
null | string

Le code du pays où cette image a été prise, par exemple "de".

meta.create_date
string | number | null

N’importe lequel des schémas suivants peut s’appliquer :

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

Le créateur qui a pris l’image.

Des détails supplémentaires sur le schéma sont disponibles dans le schéma JSON complet.

meta.date_file_created
string | number | null

L’horodatage de création indiqué par les métadonnées du média, lorsqu’il est disponible.

N’importe lequel des schémas suivants peut s’appliquer :

string | number
string | number
null
meta.date_file_modified
null | string

L’horodatage de modification du fichier multimédia dans le système de fichiers.

meta.date_recorded
string | number | null

La date et l’heure auxquelles le média a été enregistré, au format YYYY/MM/DD HH:MM:SS TZ, par exemple "2010/06/30 22:16:06 GMT".

N’importe lequel des schémas suivants peut s’appliquer :

string | number
string | number
null
meta.description
string | number | null

Une description de cette image, par exemple "This tree is very old.".

N’importe lequel des schémas suivants peut s’appliquer :

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

Des détails supplémentaires sur le schéma sont disponibles dans le schéma JSON complet.

meta.device_name
string | number | null

Le nom de l’appareil qui a enregistré le média, par exemple "iPhone 3GS".

N’importe lequel des schémas suivants peut s’appliquer :

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

La version logicielle de l’appareil qui a enregistré le média, par exemple "3.1.2".

N’importe lequel des schémas suivants peut s’appliquer :

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

Le fabricant de l’appareil qui a enregistré le média, par exemple "Apple".

meta.disc
string | number | null

N’importe lequel des schémas suivants peut s’appliquer :

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

Renvoie un tableau contenant jusqu’à 10 couleurs dominantes de l’image sous forme de valeurs hexadécimales. Omettez output_meta.dominant_colors pour ne pas effectuer cette extraction. Fournir cette propriété, y compris avec la valeur false, revient à demander l’extraction et peut entraîner des frais d’utilisation supplémentaires lorsque des couleurs sont renvoyées. Définir output_meta lui-même sur false désactive l’extraction de métadonnées supplémentaires ; des vérifications de base du type et de la taille du fichier peuvent toujours être effectuées.

Des détails supplémentaires sur le schéma sont disponibles dans le schéma JSON complet.

meta.duration
number | null

La durée du fichier audio en secondes.

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

La correction d’exposition de cette image, par exemple "+4/3".

N’importe lequel des schémas suivants peut s’appliquer :

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

Le mode d’exposition de cette image, par exemple "Auto".

meta.exposure_time
number | string | null

Le temps d’exposition de cette image, par exemple "1/30".

N’importe lequel des schémas suivants peut s’appliquer :

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

Le nombre d’ouverture de cette image, par exemple 5.6.

meta.faces
Array<object> | null

Des détails supplémentaires sur le schéma sont disponibles dans le schéma JSON complet.

meta.field_order
null | string

L’ordre des trames indiqué par FFprobe, par exemple "tt", "bb", "tb", "bt" ou "progressive". Définissez output_meta.interlaced sur true pour demander la détection qui renseigne ce champ de diagnostic. Cette clé peut être présente avec la valeur null lorsque la détection n’a pas été demandée ou que l’ordre des trames n’était pas disponible. Utilisez interlaced pour une simple logique conditionnelle entre entrelacé et progressif.

meta.flash
null | string

Les réglages du flash pour cette image, par exemple "Off, Did not fire".

meta.focal_length
null | string

La distance focale de cette image, par exemple "55.0 mm".

meta.frame_count
number | null

Le nombre d’images dans un fichier GIF animé. Cette valeur est 1 par défaut pour tous les autres types d’images.

meta.framerate
number | null

La fréquence d’images de la vidéo, par exemple 29.5.

meta.genre
string | number | null

N’importe lequel des schémas suivants peut s’appliquer :

string | number
string | number
null
meta.has_alpha
boolean

Indique si l’image d’origine possède un canal alpha, y compris les images entièrement opaques dotées d’un canal alpha. Ce champ est renvoyé avec thumbhash ; son absence signifie que cette information est inconnue.

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

Vaut true si l’image contient un tracé de détourage, false sinon.

meta.has_transparency
boolean | null

Indique si l’image comporte des zones transparentes. Définissez output_meta.has_transparency sur true pour demander une vérification de la transparence. Les valeurs booléennes dont on sait qu’elles sont fausses, telles que false pour les images JPEG, peuvent être renvoyées même lorsque cette option est omise ou vaut false. Si output_meta lui-même est défini sur false, l’extraction de métadonnées supplémentaires n’est pas effectuée ; les vérifications de base du type et de la taille du fichier peuvent néanmoins être exécutées.

meta.height
number | null

La hauteur du média en pixels.

meta.interlace_detection
object | null

Détails de diagnostic du détecteur d’entrelacement de Transloadit. Cet objet peut inclure sampled_frames, tff, bff, progressive, undetermined, confidence, method et ffprobe_field_order. Définissez output_meta.interlaced sur true pour demander la détection. Cette clé peut être présente avec la valeur null lorsque la détection n’a pas été demandée ; vérifiez que sa valeur est un objet non nul avant d’en lire les propriétés.

Des détails supplémentaires sur le schéma sont disponibles dans le schéma JSON complet.

meta.interlaced
boolean | null

Indique si la vidéo semble utiliser un balayage entrelacé : true pour les vidéos entrelacées ou false pour les vidéos à balayage progressif. Définissez output_meta.interlaced sur true pour demander la détection. Cette clé peut être présente avec la valeur null lorsque la détection n’a pas été demandée ou lorsque la détection demandée n’a pas permis de conclure. La présence du champ ne suffit pas à indiquer que la détection a été exécutée.

meta.iso
number | null

La valeur ISO de cette image, par exemple 800.

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

Mots-clés extraits des métadonnées du fichier : une chaîne de caractères, un nombre fini ou un tableau dont les éléments peuvent être des chaînes de caractères, des nombres finis ou des booléens. Par exemple, ["tree", "nature"]. Le champ peut être absent ou avoir la valeur null. Vérifiez son type avant de le parcourir ; les éléments du tableau ne sont pas nécessairement des chaînes de caractères.

Des détails supplémentaires sur le schéma sont disponibles dans le schéma JSON complet.

meta.latitude
number | null

La latitude à laquelle le média a été enregistré, par exemple 52.5374.

meta.light_value
number | null

La valeur de luminosité de cette image, par exemple 6.9.

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

Le lieu où cette image a été prise, généralement la rue, par exemple "Zingster Str. 32".

meta.longitude
number | null

La longitude à laquelle le média a été enregistré, par exemple 13.4034.

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

Le volume moyen du fichier audio. Définissez output_meta.mean_volume sur true pour demander la mesure. Cette clé peut être présente avec la valeur null lorsque la mesure n’a pas été demandée ou que la valeur n’était pas disponible. La seule présence du champ ne permet pas de conclure que la mesure a été effectuée.

meta.metering_mode
null | string

Le mode de mesure pour cette image, par exemple "Multi-segment".

meta.modify_date
string | number | null

N’importe lequel des schémas suivants peut s’appliquer :

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

N’importe lequel des schémas suivants peut s’appliquer :

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>

Des détails supplémentaires sur le schéma sont disponibles dans le schéma JSON complet.

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

N’importe lequel des schémas suivants peut s’appliquer :

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

Indique si le format de la vidéo prend en charge la recherche de position, par exemple true.

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

La vitesse d’obturation de cette image, par exemple "1/32".

N’importe lequel des schémas suivants peut s’appliquer :

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

L’État dans lequel cette image a été prise, par exemple "Berlin".

N’importe lequel des schémas suivants peut s’appliquer :

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

Des détails supplémentaires sur le schéma sont disponibles dans le schéma JSON complet.

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

L’index de la vignette actuelle, avec une numérotation commençant à 0. Cette clé n’est présente que pour les résultats de 🤖/video/thumbs  (English).

meta.thumb_offset
number | string | null

Le décalage de la vignette actuelle, en secondes. Cette clé n’est présente que pour les résultats de 🤖/video/thumbs  (English).

  • number
  • string
    Motif de validation (expression régulière)^[\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

ThumbHash encodé en Base64 de l’image orientée selon les métadonnées EXIF. Demandez output_meta.thumbhash sur le Step qui produit l’image. Omis s’il n’est pas demandé, s’il n’est pas pris en charge, si l’image dépasse 40 mégapixels ou si l’extraction échoue. Traitez l’empreinte comme des données d’image privées lorsque l’image d’origine est privée.

Motif de validation (expression régulière)^(?:[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

Le titre de cette image, par exemple "Tree".

N’importe lequel des schémas suivants peut s’appliquer :

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

N’importe lequel des schémas suivants peut s’appliquer :

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

Le débit binaire de la vidéo, par exemple 500000.

meta.video_codec
null | string

Le codec vidéo de la vidéo, par exemple "ffh264".

meta.white_balance
null | string

Le réglage de la balance des blancs de cette image, par exemple "Manual".

meta.width
number | null

La largeur du média en pixels. Pour une vidéo dont le ratio d’affichage diffère du ratio de pixels, il s’agit de la largeur d’affichage prévue.

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

N’importe lequel des schémas suivants peut s’appliquer :

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

N’importe lequel des schémas suivants peut s’appliquer :

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

N’importe lequel des schémas suivants peut s’appliquer :

string | number
string | number
null
mime

obligatoire

null | string

Le type MIME déterminé pour ce fichier.

name

obligatoire

null | string

Le nom du fichier. Transloadit modifiera l’extension utilisée pour ce champ si le fichier est converti dans un autre format lors du traitement.

original_basename
null | string
original_id

obligatoire

string | Array<null | string>

L’ID unique du fichier téléversé d’origine à partir duquel ce fichier a été généré. Cet ID est utile pour déterminer quel fichier d’un téléversement de plusieurs fichiers a été utilisé pour générer un fichier donné, après plusieurs Steps de traitement.

N’importe lequel des schémas suivants peut s’appliquer :

string
Array<null | string>
Array<null | string>
Schéma d’un élément de tableau
null | string
original_md5hash
null | string
original_name
null | string
original_path
string
queue
null | string
queue_time
number
sha256
string

Somme de contrôle SHA-256 en minuscules des octets stockés, lorsqu’elle est disponible.

Motif de validation (expression régulière)^[a-f0-9]{64}$
size

obligatoire

number

La taille du fichier, en octets.

ssl_url
null | string
thumbhash
string

ThumbHash encodé en Base64, conservé avec cette version stockée de l’image, lorsqu’il est disponible. Protégez ces données d’image avec les mêmes contrôles d’accès que l’original.

Motif de validation (expression régulière)^(?:[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

obligatoire

null | string

Une catégorie abstraite décrivant le fichier. Les valeurs connues sont "audio", "document", "image", "office", "pdf", "swf", "video", "xls" ou null lorsqu’aucune catégorie n’a été détectée. Les consommateurs devraient accepter d’autres chaînes afin de maintenir la compatibilité avec les futures catégories.

url

obligatoire

null | string

Une URL à partir de laquelle le fichier peut être téléchargé, ou null lorsqu’aucune URL de diffusion n’est disponible. Les URL temporaires sur nos serveurs expirent au bout de quelques heures ; exportez les fichiers vers un espace de stockage pour les utiliser ultérieurement. Les résultats de /transloadit/store pour le stockage privé renvoient null à la fois pour url et pour ssl_url. Conservez le Workspace, l’asset_id et le version_id renvoyés pour disposer d’une référence durable, sous réserve des conditions d’accès et de conservation. /transloadit/import accepte un asset_id avec un version_id facultatif, ou un path modifiable. Ni une URL temporaire ni l’id du fichier de traitement ne constituent une référence durable au stockage.

user_meta
object
Schéma de la propriété supplémentaire
n’importe quelle valeur
version_id
string

Identifiant de version immuable renvoyé après la finalisation du résultat par le stockage. Importez avec asset_id et ce version_id pour conserver les mêmes octets après un déplacement ou un écrasement, sous réserve des conditions de rétention et d’accès.

Motif de validation (expression régulière)^[A-Za-z0-9_-]{21}[AQgw]$
workspace
string (longueur minimale : 1)

Slug du Workspace auquel appartient ce résultat stocké. Authentifiez-vous pour ce Workspace lorsque vous importez ou gérez ce résultat.

assembly_upload_meta_data_extracted

Message dont le champ data contient ce nom en texte brut, sans champ event.

assembly_uploading_finished

Message dont le champ data contient ce nom en texte brut, sans champ event.

HTTP 404, 503

Aucun corps de réponse.

Réponse d’erreur

Corps de la réponse JSON. application/json text/plain; charset=utf-8

Schéma du corps de la réponse
Schéma JSON complet

Ouvrir le JSON dans un nouvel onglet

Au moins une de ces propriétés est requise : error, message, reason

La réponse peut contenir des champs supplémentaires.

ChampType et description
assembly_id
string
error
string (longueur minimale : 1)
http_code
number | string
  • number
  • string
    Motif de validation (expression régulière)^[\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

Explication de l’erreur destinée à être lue par un humain. Sa formulation peut varier ; utilisez le code error pour gérer un échec spécifique.

reason
null | string | number | boolean | Array<n’importe quelle valeur> | object

N’importe lequel des schémas suivants peut s’appliquer :

null
string
number
boolean
Array<n’importe quelle valeur>
Array<n’importe quelle valeur>
Schéma d’un élément de tableau
n’importe quelle valeur
object
object
Schéma de la propriété supplémentaire
n’importe quelle valeur

Pour en savoir plus sur le format de réponse, consultez la documentation de Mozilla sur les événements envoyés par le serveur.