Dateien filtern

🤖/file/filter leitet Dateien anhand Ihrer Bedingungen an verschiedene Encoding-Steps weiter.

Anwendungsbeispiel

{
  "steps": {
    "filtered": {
      "robot": "/file/filter",
      "use": ":original",
      "declines": [
        [
          "${file.size}",
          ">",
          "20mb"
        ]
      ],
      "error_on_decline": true,
      "error_msg": "File size must not exceed 20 MB"
    }
  }
}

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"
        }
      ]
    }
    

  Tipp

  Das ist wahrscheinlich alles, was Sie über use wissen müssen. Sie können sich jedoch auch die erweiterten Anwendungsfälle ansehen.

• accepts

  null | string | Array<[string | string | number | null | Array<string | string | number | null>, "=" | "==" | "===" | "<" | ">" | "<=" | ">=" | 8 weitere ↓, string | string | number | null | Array<string | string | number | null>]>

  Dateien, die mindestens eine Anforderung erfüllen, werden akzeptiert, alle anderen werden abgelehnt. Ist der Wert null, werden alle Dateien akzeptiert. Ist das Array leer, werden keine Dateien akzeptiert. Lassen Sie diesen Parameter weg oder setzen Sie ihn auf null, wenn der Step jede Datei durchreichen soll. Beispiele:

  [["${file.mime}", "==", "image/gif"]] [["${file.size}", "<", "5kb"]]

  Für numerische Vergleiche (<, >, <=, >=) werden menschenlesbare Byte-Werte wie "20mb", "1gb" oder "512kb" unterstützt.

  Wenn der Parameter condition_type auf "and" gesetzt ist, müssen alle Anforderungen erfüllt sein, damit die Datei akzeptiert wird.

  Wenn sowohl accepts als auch declines angegeben sind, werden zuerst die Anforderungen in accepts und anschließend die Bedingungen in declines ausgewertet.

• declines

  null | string | Array<[string | string | number | null | Array<string | string | number | null>, "=" | "==" | "===" | "<" | ">" | "<=" | ">=" | 8 weitere ↓, string | string | number | null | Array<string | string | number | null>]>

  Dateien, die mindestens eine Anforderung erfüllen, werden abgelehnt, andernfalls werden sie akzeptiert. Wenn der Wert null oder ein leeres Array ist, werden keine Dateien abgelehnt. Beispiele:

  [["${file.size}", ">", "1024"]] [["${file.size}", ">", "20mb"]]

  Für numerische Vergleiche (<, >, <=, >=) werden menschenlesbare Byte-Werte wie "20mb", "1gb" oder "512kb" unterstützt.

  Wenn der Parameter condition_type auf "and" gesetzt ist, müssen alle Anforderungen erfüllt sein, damit die Datei abgelehnt wird.

  Wenn sowohl accepts als auch declines angegeben sind, werden zuerst die Anforderungen in accepts und anschließend die Bedingungen in declines ausgewertet.

• condition_type

  and | or(Standard: "or")

  Legt den Bedingungstyp fest, nach dem die Einträge der Arrays accepts oder declines ausgewertet werden sollen. Mögliche Werte sind "or" und "and".

• error_on_decline

  boolean(Standard: false)

  Wenn dies auf true gesetzt ist und eine oder mehrere Dateien abgelehnt werden, wird die Assembly angehalten und als fehlerhaft markiert.

• error_msg

  string(Standard: "One of your files was declined")

  Die Fehlermeldung, die Ihren Benutzern angezeigt wird, beispielsweise durch Uppy, wenn eine Datei abgelehnt wird und error_on_decline auf true gesetzt ist.

Demos

Verwandte Blogbeiträge