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": {
      "robot": "/file/compress",
      "use": {
        "steps": [
          ":original"
        ],
        "bundle_steps": true
      },
      "format": "zip"
    }
  }
}

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 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 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 Transcoding zu beschleunigen.

  • user_meta

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

    Fügt jeder von diesem Robot ausgegebenen Datei benutzerdefinierte Metadaten hinzu, ohne den Dateiinhalt zu verändern.

    Die Werte werden mit allen bereits in der Eingabedatei enthaltenen user_meta zusammengeführt. Wenn beide Objekte denselben Schlüssel enthalten, hat der Wert dieses Robots Vorrang. Assembly Variables werden unterstützt, zum Beispiel { "internal_file_id": "${file.id}" }.

  • 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