Transloadit ストレージにファイルを保存
🤖/transloadit/store は、ファイルを非公開で Transloadit ストレージに保存します。

各入力を Transloadit Storage に非公開で保存します。
ASSEMBLY_COMPLETED の後、results[producingStep][i] から取得した保存結果を、アプリケーションの所有者またはプロジェクトのレコードとともに保存してください。その結果の workspace、asset_id、version_id と、返された path を保持してください。:original を保存する Step の結果は、results[':original'] に記録されます。
デフォルトでは、名前が衝突すると失敗します。明示的な名前変更により、最終的なパスが変わる場合があります。ネイティブカタログで名前変更や上書きを行った後も、保持されている正確なバイト列を再利用するには、🤖/transloadit/import でアセット ID とバージョン ID を使用してください。パスは現在の場所を選択し、バージョンを指定しないアセット ID は現在のバイト列を選択します。アセットの削除や保持されているバージョンの削除を行うと、その参照は利用できなくなります。
使用例
アップロードしたファイルを Transloadit ストレージに保存します:
{
"steps": {
"stored": {
"robot": "/transloadit/store",
"use": ":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(デフォルト:true)この Storage Step では、
resultを未設定のままにするか、trueに設定してください。ここでresult: falseを設定すると、ファイルが保存されていても、アセット ID やバージョン ID を含む保存済みエントリーが Assembly Status JSON から除外される場合があります。保存結果は、Assembly Status JSON 内のこの Storage Step ではなく、結果を生成した Step の下に表示されます。アップロードされたファイルの場合は、
:originalの下に表示されます。結果を生成する処理 Step にresult: falseを設定した場合も、ファイルが保存されていても、アセット ID やバージョン ID を含む保存済みエントリーが Assembly Status JSON から除外されます。これらの識別情報を受け取るには、その Step のresultを未設定のままにするか、trueに設定してください。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 には任意の名前を付けられます。ただし、
conflict_strategyerror | overwrite | rename(デフォルト:"error")保存先がすでに存在する場合の処理方法を選択します。デフォルトでは、パスが使用済みの場合は失敗します。別のファイル名を割り当てるには
renameを、既存のアセットの新しいバージョンを作成するにはoverwriteを選択してください。返されたアセット識別情報、バージョン、最終的なパスは必ず保存してください。pathstring(デフォルト:"${file.url_name}")Transloadit Storage ワークスペース内の保存先パスを、ルートからの相対パスで設定します。ファイル名、または
website/hero.jpgのようにフォルダーとファイル名を指定します。まだ存在しないフォルダーは作成されます。変数の展開後、パス内部で連続するスラッシュは一つにまとめられます。たとえば、
a/${file.meta.relative_path}/${file.name}は、relative_pathが空の場合、ルート直下の HLS プレイリストをa/playlist.m3u8として保存します。先頭や末尾のスラッシュ、および.または..のセグメントは引き続き無効です。