Dokumente in verschiedene Formate konvertieren

🤖/document/convert konvertiert Dokumente in verschiedene Formate.

Anwendungsbeispiel

{
  "steps": {
    "converted": {
      "robot": "/document/convert",
      "use": ":original",
      "format": "pdf"
    }
  }
}

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.

• format — erforderlich

  ai | csv | doc | docx | eps | gif | html | 28 weitere ↓

  Das gewünschte Format für die Dokumentkonvertierung.

• markdown_format

  commonmark | gfm(Standard: "gfm")

  Markdown kann in mehreren Varianten⁠ dargestellt werden. Geben Sie daher bei der Verwendung dieses Robots zur Umwandlung von Markdown in HTML an, welche Revision verwendet wird.

• markdown_theme

  bare | github(Standard: "github")

  Dieser Parameter gestaltet Ihre Markdown-Dateien anhand mehrerer vorgefertigter Voreinstellungen vollständig neu.

• pdf_margin

  string(Standard: "6.25mm,6.25mm,14.11mm,6.25mm")

  PDF-Seitenränder, getrennt durch , und mit Einheiten.

  Wir unterstützen die folgenden Einheitenwerte: px, in, cm, mm.

  Derzeit wird dieser Parameter nur bei der Konvertierung aus html unterstützt.

• pdf_print_background

  boolean(Standard: true)

  PDF-Hintergrundgrafiken drucken.

  Derzeit wird dieser Parameter nur bei der Konvertierung aus html unterstützt.

• pdf_format

  A0 | A1 | A2 | A3 | A4 | A5 | A6 | 4 weitere ↓(Standard: "Letter")

  PDF-Papierformat.

  Derzeit wird dieser Parameter nur bei der Konvertierung aus html unterstützt.

• pdf_display_header_footer

  boolean(Standard: false)

  PDF-Kopf- und -Fußzeile anzeigen.

  Derzeit wird dieser Parameter nur bei der Konvertierung aus html unterstützt.

• pdf_header_template

  string

  HTML-Template für die Kopfzeile des PDF-Ausdrucks.

  Es muss sich um gültiges HTML-Markup handeln, das die folgenden Klassen verwendet, um Druckwerte einzufügen:

  • date formatiertes Druckdatum
  • title Dokumenttitel
  • url Speicherort des Dokuments
  • pageNumber aktuelle Seitennummer
  • totalPages Gesamtzahl der Seiten im Dokument

  Derzeit wird dieser Parameter nur bei der Konvertierung aus html unterstützt. Außerdem muss pdf_display_header_footer aktiviert sein.

  Um die Formatierung des HTML-Elements zu ändern, muss font-size in einem Wrapper angegeben werden. Um beispielsweise die Seitennummer oben auf einer Seite zu zentrieren, verwenden Sie für das Kopfzeilen-Template den folgenden HTML-Code:

  <div style="font-size: 15px; width: 100%; text-align: center;"><span class="pageNumber"></span></div>
  

• pdf_footer_template

  string

  HTML-Template für die Fußzeile des PDF-Ausdrucks.

  Es sollte dasselbe Format wie pdf_header_template verwenden.

  Derzeit wird dieser Parameter nur bei der Konvertierung aus html unterstützt. Außerdem muss pdf_display_header_footer aktiviert sein.

  Um die Formatierung des HTML-Elements zu ändern, muss font-size in einem Wrapper angegeben werden. Um beispielsweise die Seitennummer in der Fußzeile zu zentrieren, verwenden Sie für das Fußzeilen-Template den folgenden HTML-Code:

  <div style="font-size: 15px; width: 100%; text-align: center;"><span class="pageNumber"></span></div>
  

Demos

Verwandte Blogbeiträge