Tomar capturas de pantalla de páginas web o archivos HTML

🤖/html/convert toma capturas de pantalla de páginas web o páginas HTML subidas.

Ejemplo de uso

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

Parámetros

• interpolate

  boolean | Record<string, boolean>

  Controla si las Assembly Variables se interpolan en campos de instrucciones individuales.

  De forma predeterminada, la mayoría de los campos de instrucciones de los Robots interpolan Assembly Variables. Establece esta opción en false para tratar todos los campos de instrucciones como texto literal, o establece la ruta de un campo individual en false para tratar únicamente ese campo como texto literal. En el caso de los campos específicos de un Robot que son literales de forma predeterminada, establece esta opción en true o la ruta de ese campo en true para volver a habilitar la interpolación.

  Usa nombres de campos como path o rutas con puntos como ffmpeg.vf para los objetos anidados.

• output_meta

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

  Te permite especificar un conjunto de metadatos cuyo cálculo requiere más recursos de CPU y que, por lo tanto, está desactivado de forma predeterminada para que tus Assemblies se procesen rápidamente.

  Para imágenes, puedes añadir "has_transparency": true a este objeto para determinar si la imagen contiene partes transparentes y "dominant_colors": true para extraer un array de códigos de color hexadecimales de la imagen.

  Para imágenes, también puedes añadir "blurhash": true para extraer una cadena BlurHash⁠, una representación compacta de un marcador de posición para la imagen que resulta útil para mostrar una vista previa desenfocada mientras se carga la imagen completa.

  Para videos, puedes añadir el parámetro "colorspace": true para extraer el espacio de color del video de salida.

  Para videos, también puedes añadir "interlaced": true para detectar si el video está entrelazado. Esto combina el indicador field_order de ffprobe, cuyo costo en recursos de procesamiento es bajo, con una pasada de muestreo limitada mediante idet sobre los primeros fotogramas de la fuente, y expone interlaced, field_order y un objeto de diagnóstico interlace_detection en file.meta. Esto requiere muchos recursos computacionales y se factura en consecuencia.

  Para audio, puedes añadir "mean_volume": true para obtener un único valor que represente el volumen promedio del archivo de audio.

  También puedes establecerlo en false para omitir la extracción de metadatos y acelerar la transcodificación.

• user_meta

  Record<string, any>(valor predeterminado: {})

  Añade metadatos personalizados a cada archivo emitido por este Robot sin modificar el contenido del archivo.

  Los valores se combinan con los user_meta existentes en el archivo de entrada. Si ambos objetos contienen la misma clave, el valor de este Robot tiene prioridad. Se admiten Assembly Variables, por ejemplo { "internal_file_id": "${file.id}" }.

• result

  boolean(valor predeterminado: false)

  Indica si los resultados de este Step deben aparecer en el Assembly Status JSON

• queue

  batch

  Establecer la cola en «batch» reduce manualmente la prioridad de los Jobs de este Step para evitar consumir cupos prioritarios con Jobs que no necesitan un tiempo de espera cero en la cola

• force_accept

  boolean(valor predeterminado: false)

  Forzar a un Robot a aceptar un tipo de archivo que habría ignorado.

  De forma predeterminada, los Robots ignoran los archivos que no reconocen. 🤖/video/encode, por ejemplo, ignorará sin problemas las imágenes de entrada.

  Si configuras el parámetro force_accept como true, puedes forzar a los Robots a aceptar todos los archivos que reciban. Esto normalmente provocará errores y solo debe usarse para depuración o para abordar casos extremos.

• ignore_errors

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

  Ignorar errores durante fases específicas del procesamiento.

  Establecer este parámetro en ["meta"] hará que el Robot ignore los errores durante la extracción de metadatos.

  Establecer este parámetro en ["execute"] hará que el Robot ignore los errores durante la fase principal de ejecución.

  Configurar este parámetro como true equivale a ["meta", "execute"] y hará que se ignoren los errores en ambas fases.

• use

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

  Especifica qué Step o Steps se usarán como entrada.

  • Puedes elegir cualquier nombre para los Steps, excepto ":original" (reservado para las subidas de usuarios gestionadas por Transloadit)
  • Puedes proporcionar varios Steps como entrada mediante arrays:

    {
      "use": [
        ":original",
        "encoded",
        "resized"
      ]
    }
    

  • También puedes etiquetar los Steps de entrada con as para comunicar la intención semántica a los Robots:

    {
      "use": [
        {
          "name": ":original",
          "as": "image"
        },
        {
          "name": ":original",
          "as": "mask"
        }
      ]
    }
    

  Consejo

  Probablemente eso sea todo lo que necesitas saber sobre use, pero puedes consultar los casos de uso avanzados.

• url

  string | null(valor predeterminado: null)

  La URL de la página web que se convertirá. Es opcional, ya que también puedes subir o importar archivos HTML y pasarlos a este Robot.

• format

  jpeg | jpg | pdf | png(valor predeterminado: "png")

  El formato de la imagen resultante.

• fullpage

  boolean(valor predeterminado: true)

  Determina si se debe tomar una captura de pantalla de la página completa.

  Si se establece en true, el parámetro height no tendrá efecto, ya que la altura varía entre sitios web. Sin embargo, puedes controlar en cierta medida el tamaño de la imagen resultante mediante el parámetro width.

  Si se establece en false, se recortará una imagen desde la parte superior de la página web según tus parámetros width y height.

• omit_background

  boolean(valor predeterminado: false)

  Determina si se conserva el fondo transparente de las páginas HTML. Resulta útil si generas en HTML una composición gráfica que deseas superponer, por ejemplo, sobre un video.

  El valor predeterminado false rellena las áreas transparentes con un fondo blanco para facilitar la lectura y la impresión.

  Este parámetro solo se usa cuando format no es pdf.

• width

  string | number(valor predeterminado: 1024)

  El ancho de pantalla que se usará, en píxeles. Modifícalo para cambiar las dimensiones de la imagen resultante.

• height

  string | number

  La altura de pantalla que se usará, en píxeles. De forma predeterminada, equivale a la longitud de la página web en píxeles si fullpage se establece en true. Si fullpage se establece en false, el parámetro de altura surte efecto y su valor predeterminado es 768.

• delay

  string | number(valor predeterminado: 0)

  El retraso (en milisegundos) aplicado para permitir que la página y todo su JavaScript se rendericen antes de tomar la captura de pantalla.

• headers

  Record<string, string>

  Un objeto que contiene encabezados opcionales que se enviarán junto con la solicitud original al sitio web. Por ejemplo, este parámetro puede usarse para enviar un token de autorización con la solicitud.

• wait_until

  domcontentloaded | load | networkidle | commit(valor predeterminado: "networkidle")

  El evento que se debe esperar antes de tomar la captura de pantalla. Se usa para cargar JavaScript e imágenes.

  Para obtener más información, consulta la documentación de Playwright⁠.

Demos

Publicaciones relacionadas del blog