beta

Ajouter un filigrane aux documents PDF

🤖/document/watermark ajoute des filigranes textuels personnalisés sur chaque page d’un PDF.

Ajoute du texte à chaque page d’un PDF existant tout en conservant le contenu d’origine des pages sous forme de contenu PDF. Le texte qui était sélectionnable le reste. Les dimensions des pages, les cadres de recadrage et la rotation des pages sont conservés.

Le texte est intégré au contenu des pages. Il constitue un filigrane visible, mais n’assure ni protection contre la copie ni caviardage.

Positionnement par coordonnées

Utilisez x_offset et y_offset pour déplacer le filigrane par rapport à position, comme les décalages du filigrane dans /image/resize et /video/encode. Les décalages utilisent des points PDF plutôt que des pixels et acceptent des valeurs fractionnaires. Ils sont appliqués après l’ajustement du texte ; les décalages qui déplacent le texte hors de la partie visible de la page peuvent le tronquer.

Pour des coordonnées mesurées à partir du coin supérieur gauche de la partie visible de la page, définissez position: "top-left", margin: 0 et rotation: 0. Par exemple, ces réglages placent le cadre englobant du filigrane à 72 points du bord gauche et à 144 points du bord supérieur sur chaque page, y compris les pages pivotées et recadrées :

{
  "robot": "/document/watermark",
  "use": ":original",
  "text": "Licensed to ${fields.name}",
  "position": "top-left",
  "margin": 0,
  "rotation": 0,
  "x_offset": 72,
  "y_offset": 144
}

Seuls les PDF non chiffrés sont pris en charge. La modification d’un PDF signé numériquement invalide ses signatures existantes. Ce Robot ne préserve ni la conformité PDF/A ni la certification du document.

Exemple d’utilisation

Placer un texte propre à la requête sur chaque page d’un PDF :

{
  "steps": {
    "watermarked": {
      "robot": "/document/watermark",
      "text": "${fields.watermark}",
      "use": ":original"
    }
  }
}

Paramètres

interpolate
boolean | Record<string, boolean>
Détermine si les Assembly Variables sont interpolées pour chaque champ d’instruction.

Par défaut, la plupart des champs d’instruction des Robots interpolent les Assembly Variables. Définissez ce paramètre sur false pour traiter tous les champs d’instruction comme du texte littéral, ou définissez le chemin d’un champ individuel sur false pour traiter uniquement ce champ comme du texte littéral. Pour les champs propres à un Robot qui sont littéraux par défaut, définissez ce paramètre sur true ou définissez le chemin de ce champ sur true pour réactiver l’interpolation.

Utilisez des noms de champs tels que path, ou des chemins avec points tels que ffmpeg.vf pour les objets imbriqués.
output_meta
Record<string, boolean> | boolean | Array<string>
Permet de spécifier un ensemble de métadonnées dont le calcul est plus coûteux en puissance CPU et qui sont donc désactivées par défaut afin que le traitement de vos Assemblies reste rapide.

Pour les images, vous pouvez ajouter "has_transparency": true dans cet objet pour déterminer si l’image contient des parties transparentes, et "dominant_colors": true pour extraire de l’image un tableau de codes couleur hexadécimaux.

Pour les images, vous pouvez également ajouter "blurhash": true pour extraire une chaîne BlurHash — une représentation compacte d’un espace réservé pour l’image, utile pour afficher un aperçu flou pendant le chargement de l’image complète.

Pour les images, "thumbhash": true extrait plutôt un ThumbHash encodé en base64 dans meta.thumbhash, accompagné de meta.has_alpha (qui indique si un canal alpha existe, même lorsque l’image est entièrement opaque). Il décrit les pixels orientés selon les données EXIF et utilise la première image des images animées. L’extraction est effectuée au mieux : les images de plus de 40 mégapixels, les formats non pris en charge ou un décodage échoué ou limité ne produisent aucun espace réservé. Une extraction réussie ajoute des frais de métadonnées équivalents à 20 % des octets de ce fichier. Aucun supplément ThumbHash ne s’applique lorsque l’option est désactivée ou lorsqu’aucun hash n’est produit.

Définissez cette option sur le Step qui produit l’image, par exemple /upload/handle pour les originaux téléversés ou /image/resize pour les sorties traitées. La définir uniquement sur /transloadit/store ne déclenche pas l’extraction : le stockage conserve les métadonnées du Step producteur. Transloadit Storage conserve un hash généré avec sa version immuable et le renvoie dans les résultats stockés et lors des lectures natives de ressources. Les téléversements directs vers S3 ne génèrent pas d’espaces réservés. Un espace réservé contient des informations sur l’image : protégez-le donc avec les mêmes contrôles d’accès que l’image complète.

Pour les vidéos, vous pouvez ajouter le paramètre "colorspace": true pour extraire l’espace colorimétrique de la vidéo de sortie.

Pour les vidéos, vous pouvez également ajouter "interlaced": true pour détecter si la vidéo est entrelacée. Cette option combine l’indicateur ffprobe peu coûteux field_order avec une passe d’échantillonnage idet limitée sur les premières images de la source, et expose interlaced, field_order ainsi qu’un objet de diagnostic interlace_detection sous file.meta. Cette opération est coûteuse en calcul et facturée en conséquence.

Pour l’audio, vous pouvez ajouter "mean_volume": true pour obtenir une valeur unique représentant le volume moyen du fichier audio.

Vous pouvez également définir cette option sur false pour ignorer l’extraction des métadonnées et accélérer le transcodage.
user_meta
Record<string, any>(par défaut : {})
Ajoute des métadonnées JSON personnalisées à chaque fichier émis sans modifier son contenu. Les objets et tableaux imbriqués sont pris en charge.

L’héritage dépend du Robot. Les valeurs sont fusionnées avec la valeur user_meta existante du fichier de sortie ; le Step actuel remplace les clés de premier niveau correspondantes. Attribuez explicitement les clés requises lorsqu’un Robot crée de nouvelles sorties.

Dans les Steps de traitement, ${file.*} désigne la première entrée et ${result.*} le fichier émis. Les valeurs sont évaluées pour chaque sortie après l’exécution du Robot, avant l’extraction ultérieure des métadonnées et le stockage temporaire. Sur :original, les valeurs sont évaluées pour chaque téléversement avant l’extraction des métadonnées.

Les Steps en aval lisent ${file.user_meta.key}. Consultez Métadonnées personnalisées pour un exemple complet et les règles d’héritage.
result
boolean(par défaut : false)
Indique si les résultats de ce Step doivent figurer dans l’Assembly Status JSON
queue
batch
Définir la file d’attente sur « batch » abaisse manuellement la priorité des Jobs de ce Step afin d’éviter de consommer des emplacements prioritaires de Jobs pour des Jobs qui n’ont pas besoin d’un temps d’attente nul dans la file
force_accept
boolean(par défaut : false)
Forcer un Robot à accepter un type de fichier qu’il aurait ignoré.

Par défaut, les Robots ignorent les fichiers qu’ils ne connaissent pas. Le Robot 🤖/video/encode, par exemple, ignorera volontiers les images en entrée.

Avec le paramètre force_accept défini sur true, vous pouvez forcer les Robots à accepter tous les fichiers qui leur sont envoyés. Cela entraîne généralement des erreurs et ne doit être utilisé que pour le débogage ou pour traiter des cas limites.
ignore_errors
boolean | Array<meta | execute>(par défaut : [])
Ignore les erreurs pendant certaines phases du traitement.

Si vous définissez cette valeur sur ["meta"], le Robot ignorera les erreurs lors de l’extraction des métadonnées.

Si vous définissez cette valeur sur ["execute"], le Robot ignorera les erreurs lors de la phase d’exécution principale.

Définir cette valeur sur true équivaut à ["meta", "execute"] : les erreurs seront alors ignorées dans les deux phases.
use
string | Array<string> | Array<object> | object
Indique quel(s) Step(s) utiliser comme entrée.
- Vous pouvez choisir n’importe quel nom pour les Steps, sauf ":original" (réservé aux téléversements des utilisateurs gérés par Transloadit)
- Vous pouvez fournir plusieurs Steps en entrée à l’aide de tableaux :
```
{
  "use": [
    ":original",
    "encoded",
    "resized"
  ]
}
```
- Vous pouvez également étiqueter les Steps d’entrée avec as pour transmettre une intention sémantique aux Robots :
```
{
  "use": [
    {
      "name": ":original",
      "as": "image"
    },
    {
      "name": ":original",
      "as": "mask"
    }
  ]
}
```
Astuce

C’est probablement tout ce que vous devez savoir sur use, mais vous pouvez consulter les cas d’utilisation avancés.
text — obligatoire
string
Le texte à placer sur chaque page. Utilisez des Assembly Variables comme ${fields.watermark} pour personnaliser chaque requête. Les retours à la ligne créent plusieurs lignes de texte. Les caractères doivent être disponibles dans la police sélectionnée ; les caractères non pris en charge provoquent une erreur.
font
DejaVu Sans | DejaVu Serif | DejaVu Sans Mono(par défaut : "DejaVu Sans")
La police incorporée utilisée pour le filigrane.
font_size
string | number(par défaut : 36)
La taille maximale de la police, en points PDF. Le texte est réduit pour tenir à l’intérieur des marges de la page.
color
string(par défaut : "#808080")
La couleur du filigrane, exprimée par une valeur RVB hexadécimale à six chiffres.
opacity
string | number(par défaut : 0.25)
L’opacité du filigrane, de 0 (entièrement transparent) à 1 (entièrement opaque).
position
bottom | bottom-left | bottom-right | center | left | right | top | (par défaut : "center")
La position sur la page visible, compte tenu de la rotation et du recadrage de la page.
x_offset
string | number(par défaut : 0)
Décalage horizontal par rapport à position, en points PDF (72 points = 1 pouce). Les valeurs positives déplacent le filigrane vers la droite, sauf pour les positions alignées à droite, où elles le déplacent vers la gauche. Les valeurs négatives inversent cette direction. Les décalages suivent les axes de la partie visible de la page, indépendamment de la rotation du texte.
y_offset
string | number(par défaut : 0)
Décalage vertical par rapport à position, en points PDF (72 points = 1 pouce). Les valeurs positives déplacent le filigrane vers le bas, sauf pour les positions alignées en bas, où elles le déplacent vers le haut. Les valeurs négatives inversent cette direction. Les décalages suivent les axes de la partie visible de la page, indépendamment de la rotation du texte.
rotation
string | number(par défaut : 45)
La rotation du texte dans le sens inverse des aiguilles d’une montre, en degrés, par rapport à la page visible.
margin
string | number(par défaut : 24)
La marge intérieure par rapport aux bords visibles de la page, en points PDF, utilisée pour positionner et ajuster le filigrane avant d’appliquer x_offset et y_offset.

Ajouter un filigrane aux documents PDF

Positionnement par coordonnées

Exemple d’utilisation

Paramètres

`interpolate`

`output_meta`

`user_meta`

`result`

`queue`

`force_accept`

`ignore_errors`

`use`

`text` — obligatoire

`font`

`font_size`

`color`

`opacity`

`position`

`x_offset`

`y_offset`

`rotation`

`margin`

Ajouter un filigrane aux documents PDF

Positionnement par coordonnées

Exemple d’utilisation

Paramètres

interpolate

output_meta

user_meta

result

queue

force_accept

ignore_errors

use

text — obligatoire

font

font_size

color

opacity

position

x_offset

y_offset

rotation

margin

`interpolate`

`output_meta`

`user_meta`

`result`

`queue`

`force_accept`

`ignore_errors`

`use`

`text` — obligatoire

`font`

`font_size`

`color`

`opacity`

`position`

`x_offset`

`y_offset`

`rotation`

`margin`