Transloadit

Dateien komprimieren

🤖/file/compress erstellt Archive aus Dateien oder Ergebnissen von Dateikonvertierungen.

/file/compress Robot

Anwendungsbeispiel

Hochgeladene Dateien zu einem ZIP-Archiv komprimieren:

{
  "steps": {
    "compressed": {
      "format": "zip",
      "robot": "/file/compress",
      "use": {
        "bundle_steps": true,
        "steps": [
          ":original"
        ]
      }
    }
  }
}

Parameter

  • interpolate

    boolean | Record<string, boolean>

    Steuert, ob einzelne Robot-Anweisungsfelder Assembly Variables interpolieren.

    Standardmäßig interpolieren die meisten Robot-Anweisungsfelder Assembly Variables. Mit dem Wert false behandeln Sie alle Anweisungsfelder als Literaltext. Wenn Sie stattdessen einen einzelnen Feldpfad auf false setzen, wird nur dieses Feld als Literaltext behandelt. Bei Feldern eines bestimmten Robots, die standardmäßig als Literaltext behandelt werden, aktivieren Sie die Interpolation wieder, indem Sie hierfür true festlegen oder für den jeweiligen Feldpfad den Wert true verwenden.

    Verwenden Sie Feldnamen wie path oder für verschachtelte Objekte Punktpfade wie ffmpeg.vf als Pfadangabe.

  • output_meta

    Record<string, boolean> | boolean | Array<string>

    Damit können Sie eine Reihe von Metadaten festlegen, deren Berechnung mehr CPU-Ressourcen beansprucht. Sie sind daher standardmäßig deaktiviert, damit Ihre Assemblies schnell verarbeitet werden.

    Für Bilder können Sie diesem Objekt den Eintrag "has_transparency": true hinzufügen, um zu ermitteln, ob das Bild transparente Bereiche enthält. Mit dem Eintrag "dominant_colors": true können Sie außerdem ein Array mit hexadezimalen Farbcodes aus dem Bild extrahieren.

    Für Bilder können Sie auch den Eintrag "blurhash": true hinzufügen, um einen BlurHash als String zu extrahieren – eine kompakte Darstellung eines Platzhalters für das Bild, mit der Sie eine unscharfe Vorschau anzeigen können, während das vollständige Bild geladen wird.

    Für Bilder extrahiert der Eintrag "thumbhash": true stattdessen einen base64-codierten ThumbHash nach meta.thumbhash, zusammen mit meta.has_alpha (gibt an, ob ein Alphakanal vorhanden ist, auch wenn das Bild vollständig deckend ist). Der Hash beschreibt die Pixel gemäß EXIF-Ausrichtung und verwendet bei animierten Bildern das erste Frame. Die Extraktion erfolgt nach dem Best-Effort-Prinzip: Bilder über 40 Megapixeln, nicht unterstützte Formate oder ein fehlgeschlagener bzw. durch Grenzwerte beschränkter Decodiervorgang erzeugen keinen Platzhalter. Eine erfolgreiche Extraktion verursacht eine zusätzliche Metadatengebühr in Höhe von 20 % der Bytes dieser Datei. Ist die Option deaktiviert oder wird kein Hash erzeugt, fällt kein ThumbHash-Aufschlag an.

    Setzen Sie diese Option für den Step, der das Bild erzeugt, etwa /upload/handle für hochgeladene Originale oder /image/resize für verarbeitete Ausgaben. Wird sie nur für /transloadit/store gesetzt, wird keine Extraktion angefordert: Die Speicherung behält die Metadaten des erzeugenden Steps bei. Transloadit Storage speichert einen erzeugten Hash dauerhaft zusammen mit seiner unveränderlichen Version und gibt ihn in gespeicherten Ergebnissen sowie beim nativen Lesen von Assets zurück. Direkte S3-Uploads erzeugen keine Platzhalter. Ein Platzhalter enthält Bildinformationen; schützen Sie ihn daher mit denselben Zugriffskontrollen wie das vollständige Bild.

    Für Videos können Sie den Parameter "colorspace": true hinzufügen, um den Farbraum des Ausgabevideos zu extrahieren.

    Für Videos können Sie außerdem den Eintrag "interlaced": true hinzufügen, um zu erkennen, ob das Video im Zeilensprungverfahren vorliegt. Dazu wird die ressourcenschonende ffprobe-Option field_order mit einem begrenzten Stichprobendurchlauf mithilfe von idet über die ersten Frames der Quelle kombiniert. Die Ergebnisse interlaced und field_order sowie das Diagnoseobjekt interlace_detection werden dabei unter file.meta ausgegeben. Dies ist rechenintensiv und wird entsprechend abgerechnet.

    Für Audio können Sie den Eintrag "mean_volume": true hinzufügen, um einen einzelnen Wert für die durchschnittliche Lautstärke der Audiodatei zu erhalten.

    Sie können diesen Parameter auch auf false setzen, um die Metadatenextraktion zu überspringen und das Transkodieren zu beschleunigen.

  • user_meta

    Record<string, any>(Standard: {})

    Fügt jeder ausgegebenen Datei benutzerdefinierte JSON-Metadaten hinzu, ohne den Dateiinhalt zu verändern. Verschachtelte Objekte und Arrays werden unterstützt.

    Die Vererbung hängt vom Robot ab. Die Werte werden mit vorhandenen user_meta der Ausgabedatei zusammengeführt; der aktuelle Step ersetzt übereinstimmende Schlüssel auf oberster Ebene. Weisen Sie erforderliche Schlüssel explizit zu, wenn ein Robot neue Ausgabedateien erstellt.

    In Steps zur Verarbeitung bezieht sich ${file.*} auf die erste Eingabe und ${result.*} auf die ausgegebene Datei. Die Werte werden nach der Ausführung des Robots für jede Ausgabedatei ausgewertet, bevor die anschließende Metadatenextraktion und temporäre Speicherung erfolgen. Bei :original werden die Werte für jeden Upload vor der Metadatenextraktion ausgewertet.

    Nachfolgende Steps lesen ${file.user_meta.key}. Ein vollständiges Beispiel und die Vererbungsregeln finden Sie unter Benutzerdefinierte Metadaten.

  • result

    boolean(Standard: false)

    Ob die Ergebnisse dieses Steps im Assembly Status JSON enthalten sein sollen

  • queue

    batch

    Wenn Sie die Queue auf „batch“ setzen, wird die Priorität der Jobs für diesen Step manuell herabgestuft. So vermeiden Sie, Priority Job Slots für Jobs zu belegen, die keine Wartezeit von null in der Queue benötigen.

  • force_accept

    boolean(Standard: false)

    Erzwingt, dass ein Robot einen Dateityp akzeptiert, den er sonst ignorieren würde.

    Standardmäßig ignorieren Robots Dateien, deren Typ sie nicht kennen. 🤖/video/encode ignoriert beispielsweise problemlos Eingabebilder.

    Wenn Sie den Parameter force_accept auf true setzen, können Sie erzwingen, dass Robots alle übergebenen Dateien akzeptieren. Dies führt in der Regel zu Fehlern und sollte nur zur Fehlersuche oder zur Behandlung von Grenzfällen verwendet werden.

  • ignore_errors

    boolean | Array<meta | execute>(Standard: [])

    Fehler in bestimmten Verarbeitungsphasen ignorieren.

    Wenn Sie hierfür ["meta"] festlegen, ignoriert der Robot Fehler bei der Metadatenextraktion.

    Wenn Sie hierfür ["execute"] festlegen, ignoriert der Robot Fehler während der Hauptausführungsphase.

    Wenn Sie hierfür true festlegen, entspricht dies ["meta", "execute"] und Fehler in beiden Phasen werden ignoriert.

  • use

    string | Array<string> | Array<object> | object

    Gibt an, welche Steps als Eingabe verwendet werden sollen.

    • Sie können beliebige Namen für Steps wählen, außer ":original" (reserviert für von Transloadit verarbeitete Benutzer-Uploads)
    • Sie können mehrere Steps mithilfe von Arrays als Eingabe angeben: 
      {
  "use": [
    ":original",
    "encoded",
    "resized"
  ]
}
    • Sie können Eingabe-Steps außerdem mit as kennzeichnen, um Robots die semantische Funktion zu übermitteln: 
      {
  "use": [
    {
      "name": ":original",
      "as": "image"
    },
    {
      "name": ":original",
      "as": "mask"
    }
  ]
}

  • format

    tar | zip(Standard: "tar")

    Das Format des zu erstellenden Archivs. Unterstützte Werte sind "tar" und "zip".

    Beachten Sie, dass "tar" ohne Festlegung von gzip auf true zu einem Archiv führt, das in keiner Weise komprimiert ist.

  • gzip

    boolean(Standard: false)

    Legt fest, ob das resultierende Archiv zusätzlich mit Gzip komprimiert werden soll. Die Gzip-Komprimierung wird nur angewendet, wenn Sie das Format "tar" verwenden.

  • password

    string | null(Standard: null)

    Damit können Sie den gesamten Inhalt des Archivs mit einem Passwort verschlüsseln und so vor unbefugter Nutzung schützen. Zum Entpacken des Archivs muss die nutzende Person das Passwort in ein eingeblendetes Texteingabefeld eingeben.

    Dieser Parameter hat keine Auswirkung, wenn der Formatparameter einen anderen Wert als "zip" hat.

  • compression_level

    string | number(Standard: -6)

    Legt fest, wie intensiv versucht wird, das Archiv zu komprimieren. -0 verwendet keine Komprimierung und eignet sich für bereits komprimierte Medien. -1 ist am schnellsten und bietet die geringste Komprimierung. -9 ist am langsamsten und bietet die höchste Komprimierung.

    Wenn Sie -0 zusammen mit dem Format tar und aktiviertem gzip verwenden, sollten Sie stattdessen gzip: false festlegen. Dadurch entsteht ein einfaches Tar-Archiv, das bereits keine Komprimierung verwendet.

  • file_layout

    advanced | simple | relative-path(Standard: "advanced")

    Legt fest, ob das Ergebnisarchiv alle Dateien in einem einzigen Verzeichnis enthalten soll (der Wert hierfür ist "simple") oder gemäß der nachstehenden Erläuterung in Unterordnern (der Wert hierfür ist "advanced"). Die Option "relative-path" bewahrt die relative Verzeichnisstruktur der Eingabedateien.

    Dateien mit identischen Namen werden beim Dateilayout "simple" nummeriert, um Namenskonflikte zu vermeiden.

  • archive_name

    string

    Der Name der zu erstellenden Archivdatei (ohne Dateierweiterung).

  • path

    string

    Der Pfad, unter dem die jeweilige Datei innerhalb des Archivs abgelegt werden soll. Er kann alle verfügbaren Assembly-Variablen enthalten. Variablen werden für jede Datei ausgewertet. So können Vorlagen wie "${file.meta.archive_directory}/${file.name}" die ursprüngliche Verzeichnisstruktur eines zuvor extrahierten Archivs bewahren.

    Wenn dieser Parameter festgelegt ist, wird der Parameter file_layout ignoriert.

Demos

Verwandte Blogbeiträge