複数の画像を一枚の画像に結合
🤖/image/merge は、複数の画像を一枚のスプライトシートに結合します。

最終結果は、画像を横方向、縦方向、またはグリッド状に配置したスプライトシートになります。
結合前に画像のサイズをそろえるため、この Robot と 🤖/image/resize の併用を推奨します。
使用例
アップロードした画像を、スプライトシート上で画像間に 5px の間隔を空けて一つに結合します:
{
"steps": {
"merged": {
"border": 5,
"robot": "/image/merge",
"use": {
"bundle_steps": true,
"steps": [
":original"
]
}
}
}
}パラメーター
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 には任意の名前を付けられます。ただし、
formatjpg | png | webp(デフォルト:"png")加工後の画像の出力形式です。
directionhorizontal | vertical | grid(デフォルト:"horizontal")画像を並べる方向を指定します。
入力画像を左から右、上から下の順に並べるには、
gridを使用します。デフォルトのスプライトシートレイアウトにのみ適用されます。
effectがpolaroid-stackまたはmosaicに設定されている場合は、それぞれのエフェクトが独自のレイアウトアルゴリズムを使用するため、無視されます。effectmosaic | polaroid-stack単純な横方向または縦方向のスプライトシートの代わりに、装飾付きのコラージュレイアウトを適用します。
現在は、入力画像をインスタント写真風にしてキャンバス上に重ねて配置する
polaroid-stackと、端をそろえたタイル状のコラージュを作成するmosaicをサポートしています。columnsstring | numberグリッドレイアウトの列数です。
directionがgridの場合のみ適用されます。省略すると、入力数と指定された行数から列数を自動計算します。
rowsstring | numberグリッドレイアウトの行数です。
directionがgridの場合にのみ適用されます。省略すると、入力数と指定された列数から行数を自動的に計算します。
cell_widthstring | number各グリッドセルに共通の幅(ピクセル単位)です。
directionがgridの場合のみ適用されます。画像はアスペクト比を維持しながら、セル内に収まるようにサイズ変更されます。
cell_heightstring | number各グリッドセルに共通の高さ(ピクセル単位)です。
directionがgridの場合のみ適用されます。画像はアスペクト比を維持しながら、セル内に収まるようにサイズ変更されます。
borderstring | number(デフォルト:0)スプライトシート上の画像間の間隔を定義する整数値です。
10を指定すると画像間の間隔が最大になり、1を指定すると画像が隙間なく並びます。effectがpolaroid-stackの場合、この値は代わりにキャンバスの余白として使用され、最も外側の写真とキャンバスの端との間に、この値のピクセル数の間隔が確保されます。effectがmosaicの場合、この値はキャンバス外周の余白と、隣接するタイル間の間隔の両方に使用されます。backgroundstring | transparent | none | black | white | red | green | blue |(デフォルト:"#fff")背景の塗りつぶしに使用する色の 16 進数コードまたは名前です(border > 1 の場合のみ表示されます)。
デフォルトでは、透明な画像の背景は白に変更されます。キャンバスを透明にするには、
noneまたはtransparentに設定してください。アルファチャンネルを保持するには、formatをpngまたはwebpに設定してください。すべての画像形式で透明度を保持する方法については、こちらのデモ (English)を参照してください。
widthstring | number出力キャンバスの幅(ピクセル単位)です。
主に
polaroid-stackやmosaicなどの装飾エフェクトで使用します。heightstring | number出力キャンバスの高さ(ピクセル単位)です。
主に
polaroid-stackやmosaicなどの装飾エフェクトで使用します。seedstring | numberpolaroid-stackやmosaicなどの装飾エフェクトで使用する、決定論的なシード値です。指定は任意です。shuffleboolean(デフォルト:false)polaroid-stackやmosaicなどの装飾エフェクトで、キャンバスへの配置前に入力順序のシャッフルを許可するかどうかを指定します。sort_byauto | basename | import_order(デフォルト:"basename")入力タイプに対して番号付きエイリアスを明示的に使用しない場合に、まとめられた入力の並び順を制御します。番号付きエイリアスは、
_1のように数値の接尾辞で終わります。デフォルトの
"basename"は、ベース名を自然順でソートする従来の動作を維持します。すべての入力ファイルに完全なインポート順序のメタデータが含まれる場合、
"import_order"に設定すると、配列ベースのインポートステップの順序を維持できます。"auto"も同様にインポート順序を優先し、フォールバックとしてベース名の自然順ソートを使用します。coveragestring | numberpolaroid-stackエフェクトの面積被覆倍率です。キャンバスに対する各ポラロイド写真の大きさを制御し、それによって写真がキャンバスを覆う割合を調整します。デフォルト値の
1.5では、一部の端にベージュの余白がわずかに残ります。端まで覆うには、2.0–2.5を使用してください(写真の重なりが増えます)。1.0未満の値では、ポラロイド写真が小さくなり、写真間の間隔が広がります。mosaicスタイルや通常のスプライトシートには影響しません。adaptive_filteringboolean(デフォルト:false)PNG 画像の圧縮を制御します。
trueに設定すると、ファイルサイズは小さくなりますが、処理時間は長くなります。このオプションは無効のままにしておくことをお勧めします。qualitystring | number(デフォルト:100)JPG、PNG、WebP 画像の圧縮を制御します。🤖/image/optimizeもご覧ください。