Screenshots von Webseiten oder HTML-Dateien erstellen

🤖/html/convert erstellt Screenshots von Webseiten oder hochgeladenen HTML-Seiten.

Anwendungsbeispiel

{
  "steps": {
    "captured": {
      "robot": "/html/convert",
      "url": "https://transloadit.com"
    }
  }
}

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.

• url

  string | null(Standard: null)

  Die URL der zu konvertierenden Webseite. Sie ist optional, da Sie auch HTML-Dateien hochladen oder importieren und an den Robot übergeben können.

• format

  jpeg | jpg | pdf | png(Standard: "png")

  Das Format des resultierenden Bildes.

• fullpage

  boolean(Standard: true)

  Legt fest, ob ein Screenshot der gesamten Seite erstellt werden soll.

  Bei der Einstellung true hat der Parameter height keine Auswirkung, da die Höhe von Websites variiert. Sie können die Größe des resultierenden Bildes jedoch bis zu einem gewissen Grad über den Parameter width steuern.

  Bei der Einstellung false wird entsprechend Ihren Parametern width und height ein Bild vom oberen Rand der Webseite aus zugeschnitten.

• omit_background

  boolean(Standard: false)

  Legt fest, ob ein transparenter Hintergrund in HTML-Seiten beibehalten wird. Dies ist nützlich, wenn Sie in HTML eine Grafik erstellen, die Sie beispielsweise über ein Video legen möchten.

  Der Standardwert false füllt transparente Bereiche mit einem weißen Hintergrund, damit sie leichter lesbar und druckbar sind.

  Dieser Parameter wird nur verwendet, wenn format nicht pdf ist.

• width

  string | number(Standard: 1024)

  Die verwendete Bildschirmbreite in Pixeln. Ändern Sie diesen Wert, um die Abmessungen des resultierenden Bildes anzupassen.

• height

  string | number

  Die verwendete Bildschirmhöhe in Pixeln. Standardmäßig entspricht sie der Länge der Webseite in Pixeln, wenn fullpage auf true gesetzt ist. Wenn fullpage auf false gesetzt ist, wird der Höhenparameter wirksam und verwendet standardmäßig den Wert 768.

• delay

  string | number(Standard: 0)

  Die Verzögerung in Millisekunden, damit die Seite einschließlich ihres gesamten JavaScripts gerendert werden kann, bevor der Screenshot erstellt wird.

• headers

  Record<string, string>

  Ein Objekt mit optionalen Headern, die zusammen mit der ursprünglichen Anfrage an die Website übermittelt werden. Mit diesem Parameter können Sie beispielsweise ein Autorisierungs-Token zusammen mit der Anfrage übermitteln.

• wait_until

  domcontentloaded | load | networkidle | commit(Standard: "networkidle")

  Das Ereignis, auf das vor dem Erstellen des Screenshots gewartet werden soll. Wird zum Laden von JavaScript und Bildern verwendet.

  Weitere Informationen finden Sie in der Dokumentation von Playwright⁠.

Demos

Verwandte Blogbeiträge