ウェブページや HTML ファイルのスクリーンショット撮影
🤖/html/convert はウェブページやアップロードした HTML ページのスクリーンショットを撮影します。

入力 HTML ファイルの代わりに URL を指定すると、その URL が参照するウェブサイトのスクリーンショットを撮影できます。
必要に応じて、🤖/image/resize でスクリーンショットのサイズ変更や切り抜きを行います。
HTML から PDF への出力では、サンプリング対象の表示中のブラウザーフレームと、それらのドキュメントおよびフォントの準備が整った状態が 500 ms 続くと、印刷が始まります。ページ遷移後、PDF の準備が整うまでの上限は 30 秒です。準備が整わないページは変換に失敗します。非表示のフレームによって、準備完了と判定するまでの継続時間が延びることはありません。最後のサンプリング期間中に初めて表示されるコンテンツは、取り込まれない場合があります。動的コンテンツはキャプチャー前に準備してください。
使用例
Transloadit のホームページ全体のスクリーンショットを撮影します:
{
"steps": {
"captured": {
"robot": "/html/convert",
"url": "https://transloadit.com"
}
}
}パラメーター
interpolateboolean | Record<string, boolean>処理設定の各フィールドで Assembly Variables を展開するかどうかを制御します。
デフォルトでは、Robot の処理設定のほとんどのフィールドで Assembly Variables が展開されます。すべての設定フィールドをリテラルテキストとして扱うには、このパラメーターを
falseに設定してください。特定のフィールドだけをリテラルテキストとして扱うには、そのフィールドのパスをfalseに設定してください。デフォルトでリテラルとして扱われる Robot 固有のフィールドで展開を有効にするには、このパラメーターをtrueに設定するか、そのフィールドのパスをtrueに設定してください。pathのようなフィールド名を使用してください。ネストされたオブジェクトには、ffmpeg.vfのようなドット区切りのパスを使用してください。output_metaRecord<string, boolean> | boolean | Array<string>算出に多くの CPU リソースを要するメタデータを指定できます。Assembly の処理速度を維持するため、これらはデフォルトで無効になっています。
画像の場合、このオブジェクトに
"has_transparency": trueを追加すると、画像に透明な部分が含まれるかどうかを抽出できます。"dominant_colors": trueを追加すると、画像から 16 進数のカラーコードの配列を抽出できます。画像の場合、
"blurhash": trueを追加すると、画像のプレースホルダーをコンパクトに表す BlurHash 文字列も抽出できます。画像全体の読み込み中に、ぼかしたプレビューを表示するのに役立ちます。画像の場合、代わりに
"thumbhash": trueを使用すると、base64 エンコードされた ThumbHash をmeta.thumbhashに抽出し、meta.has_alpha(完全に不透明な場合も含め、アルファチャンネルが存在するかどうか)も抽出します。ThumbHash は EXIF の向きを反映したピクセルを表し、アニメーション画像では最初のフレームを使用します。抽出はベストエフォートです。40 メガピクセルを超える画像、非対応の形式、デコードの失敗やデコード処理の上限への到達があった場合、プレースホルダーは生成されません。抽出に成功すると、そのファイルのバイト数の 20% に相当するメタデータ料金が加算されます。無効な場合やハッシュが生成されない場合、ThumbHash の追加料金は発生しません。このオプションは画像を生成する Step に設定してください。たとえば、アップロードされた元画像では
/upload/handle、処理済みの出力では/image/resizeに設定します。/transloadit/storeにのみ設定しても、抽出は要求されません。ストレージは生成元のメタデータを保持します。Transloadit Storage は生成されたハッシュをその不変のバージョンとともに永続化し、保存済みの結果やネイティブのアセット読み取り時に返します。S3 への直接アップロードではプレースホルダーは生成されません。プレースホルダーには画像情報が含まれるため、画像全体と同じアクセス制御で保護してください。動画の場合、
"colorspace": trueパラメーターを追加すると、出力動画の色空間を抽出できます。動画の場合、
"interlaced": trueを追加すると、インターレース動画かどうかも検出できます。これは、低コストの ffprobe のfield_orderフラグと、ソースの先頭フレームに対する処理範囲を制限したidetサンプリング処理を組み合わせ、file.metaの下にinterlaced、field_order、診断用のinterlace_detectionオブジェクトを出力します。この処理は計算コストが高く、それに応じて課金されます。音声の場合、
"mean_volume": trueを追加すると、音声ファイルの平均音量を表す単一の値を取得できます。また、
falseに設定すると、メタデータの抽出をスキップしてトランスコードを高速化できます。user_metaRecord<string, any>(デフォルト:{})出力される各ファイルに、ファイルの内容を変更せずにカスタム JSON メタデータを追加します。ネストしたオブジェクトと配列に対応しています。
継承の動作は Robot によって異なります。値は出力ファイルの既存の
user_metaとマージされ、一致するトップレベルのキーは現在の Step によって置き換えられます。Robot が新しい出力を作成する場合は、必要なキーを明示的に割り当ててください。処理 Step では、
${file.*}は最初の入力を、${result.*}は出力されるファイルを参照します。値は Robot の実行後、後続のメタデータ抽出と一時保存の前に、出力ごとに評価されます。:originalでは、メタデータ抽出の前にアップロードごとに値が評価されます。後続の Step は
${file.user_meta.key}を読み取ります。完全な例と継承ルールについては、カスタムメタデータ を参照してください。resultboolean(デフォルト:false)この Step の結果を Assembly Status JSON に含めるかどうか
queuebatchqueue を 'batch' に設定すると、このステップのジョブの優先度を手動で下げ、キューの待ち時間がゼロである必要のないジョブが優先ジョブスロットを消費しないようにします。
force_acceptboolean(デフォルト:false)通常は無視するファイルタイプを Robot に強制的に受け入れさせます。
デフォルトでは、Robot は認識できないファイルを無視します。たとえば、🤖/video/encodeは入力画像を無視します。
force_acceptパラメーターをtrueに設定すると、Robot に渡されたすべてのファイルを強制的に受け入れさせることができます。通常、この設定はエラーにつながるため、デバッグやエッジケースへの対処にのみ使用してください。ignore_errorsboolean | Array<meta | execute>(デフォルト:[])処理の特定のフェーズでエラーを無視します。
このパラメーターを
["meta"]に設定すると、Robot はメタデータ抽出中のエラーを無視します。このパラメーターを
["execute"]に設定すると、Robot はメイン実行フェーズ中のエラーを無視します。このパラメーターを
trueに設定すると、["meta", "execute"]と同じ動作になり、両方のフェーズでエラーを無視します。usestring | Array<string> | Array<object> | object入力として使用する Step を指定します。
- Step には任意の名前を付けられます。ただし、
":original"は Transloadit が処理するユーザーアップロード用に予約されています。 - 配列を使用して、複数の Step を入力として指定できます。
{ "use": [ ":original", "encoded", "resized" ] } - 入力 Step に
asでタグを付けて、意味上の用途を Robot に伝えることもできます。{ "use": [ { "name": ":original", "as": "image" }, { "name": ":original", "as": "mask" } ] }
ヒントuseについては、通常ここまでの内容で十分ですが、高度な使用例 も参照できます。- Step には任意の名前を付けられます。ただし、
urlstring | null(デフォルト:null)変換するウェブページの URL です。HTML ファイルをアップロードまたはインポートしてこの Robot に渡すこともできるため、省略可能です。アップロードした HTML を変換する場合は、このパラメーターを省略するか、
nullまたは空文字列を指定します。formatjpeg | jpg | pdf | png(デフォルト:"png")出力画像の形式です。
fullpageboolean(デフォルト:true)ページ全体のスクリーンショットを撮影するかどうかを指定します。
trueに設定すると、ウェブサイトの高さはそれぞれ異なるため、heightパラメーターは無効になります。ただし、widthパラメーターを設定すると、出力画像のサイズをある程度調整できます。falseに設定すると、widthとheightのパラメーターに従って、ウェブページの上端から画像を切り抜きます。omit_backgroundboolean(デフォルト:false)HTML ページの透明な背景を維持するかどうかを指定します。動画などに重ねる画像を HTML で生成する場合に便利です。
デフォルトの
falseでは、読みやすさや印刷のしやすさのために、透明な領域を白い背景で塗りつぶします。このパラメーターは、
formatがpdfでない場合にのみ使用されます。widthstring | number(デフォルト:1024)使用する画面の幅(ピクセル)です。この値を変更すると、出力画像のサイズが変わります。
heightstring | number使用する画面の高さ(ピクセル)です。
fullpageがtrueに設定されている場合、デフォルトではウェブページの長さ(ピクセル)と同じになります。fullpageがfalseに設定されている場合、height パラメーターが有効になり、デフォルト値は768になります。delaystring | number(デフォルト:0)スクリーンショットの撮影前に、ページとそのすべての JavaScript のレンダリングを待つための遅延時間(ミリ秒)です。
headersRecord<string, string>ウェブサイトへの元のリクエストとともに送信する、任意のヘッダーを含むオブジェクトです。たとえば、このパラメーターを使って、リクエストとともに認証トークンを送信できます。
wait_untildomcontentloaded | load | networkidle | commit(デフォルト:"networkidle")スクリーンショットを撮影する前に待機するイベントです。JavaScript や画像の読み込みを待つために使用します。
詳細は Playwright のドキュメントを参照してください。