Filtrar archivos

🤖/file/filter dirige archivos a diferentes Steps de encoding según tus condiciones.

Ejemplo de uso

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

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.

• accepts

  null | string | Array<[string | string | number | null | Array<string | string | number | null>, "=" | "==" | "===" | "<" | ">" | "<=" | ">=" | 8 más ↓, string | string | number | null | Array<string | string | number | null>]>

  Se aceptarán los archivos que cumplan al menos un requisito; de lo contrario, se rechazarán. Si el valor es null, se aceptarán todos los archivos. Si el array está vacío, no se aceptará ningún archivo. Omite este parámetro o establécelo en null cuando quieras que el Step deje pasar todos los archivos. Ejemplos:

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

  Para las comparaciones numéricas (<, >, <=, >=), se admiten valores de bytes legibles para humanos, como "20mb", "1gb" o "512kb".

  Si el parámetro condition_type se establece en "and", deben cumplirse todos los requisitos para que se acepte el archivo.

  Si se proporcionan tanto accepts como declines, los requisitos de accepts se evaluarán primero, antes que las condiciones de declines.

• declines

  null | string | Array<[string | string | number | null | Array<string | string | number | null>, "=" | "==" | "===" | "<" | ">" | "<=" | ">=" | 8 más ↓, string | string | number | null | Array<string | string | number | null>]>

  Los archivos que cumplan al menos un requisito se rechazarán; de lo contrario, se aceptarán. Si el valor es null o un array vacío, no se rechazará ningún archivo. Ejemplos:

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

  Para las comparaciones numéricas (<, >, <=, >=), se admiten valores de bytes legibles para humanos, como "20mb", "1gb" o "512kb".

  Si el parámetro condition_type se establece en "and", deben cumplirse todos los requisitos para que se rechace el archivo.

  Si se proporcionan tanto accepts como declines, los requisitos de accepts se evaluarán primero, antes que las condiciones de declines.

• condition_type

  and | or(valor predeterminado: "or")

  Especifica el tipo de condición según el cual deben evaluarse los miembros de los arrays accepts o declines. Puede ser "or" o "and".

• error_on_decline

  boolean(valor predeterminado: false)

  Si se establece en true y se rechazan uno o más archivos, la Assembly se detendrá y se marcará con un error.

• error_msg

  string(valor predeterminado: "One of your files was declined")

  El mensaje de error que se muestra a tus usuarios (por ejemplo, mediante Uppy) cuando se rechaza un archivo y error_on_decline se establece en true.

Demos

Publicaciones relacionadas del blog