Template
Template は、受信したファイルの処理方法を定義する設定です。
Assembly Instructionsは、リクエストごとに直接送信することも、Template に保存して、リクエスト内でその template_id を参照することもできます。
Builtin Template
Transloadit では、当社が保守し、バージョン管理するTemplateも提供しています。この Builtin Template は、一般的な変換処理をすぐに始められる、安定したひな形として役立ちます。
利用可能な組み込みの Template と、API で一覧を取得する方法については、Builtin Templateをご覧ください。
処理設定を直接送信すると、すばやくプロトタイプを作成できますが、Template に保存すると次の利点があります。
- エンコードのリクエストごとに、機密データや実装の詳細を送信せずに済みます。特にブラウザーと連携する場合に役立ちます。
"allow_steps_override": falseと組み合わせると、処理設定の改ざんを防止できます。- Assembly Notificationと組み合わせると、Assembly Replayを有効にできます。
- Transloadit をアプリに組み込んでいる場合は、デプロイしたり、App Store での新バージョンの公開を待ったりせずに、エンコード設定を変更できます。
Template の作成方法
- アカウントで Template を作成します。
- 後から人が識別できるように、Template に名前を付けます。
- Template のAssembly Instructionsを JSON で指定します。一覧からサンプルを選択する、ウィザードで処理設定を生成する、既存の Template を複製する、最初から作成する、といった方法があります。
- 保存します。
Template を保存すると、作成した Template のページが表示されます。ページ上部には、4b62ee4dbb38455d96fe13d972ec3211 などの Template の ID が表示されます。この ID をコピーして連携コードの template_id に貼り付けるか、Template Editorの下部にある、この ID を含むサンプルを参照できます。
Template Editorには、アップロードフォームを備えたテスト領域もあります。連携コードを更新せずに、ブラウザー上で直接 Template をテストできます(保存する必要もありません)。
実行時の Template の上書き
相互に排他的に見えるかもしれませんが、params 内には template_id と
steps の両方を指定でき、実行時に Template の動作を変更できます。実際には、params 内のプロパティは、allow_steps_override を除き、template_id で読み込まれた Template に再帰的にマージされ、上書きされます。
例として、アップロードを受け付け、iPad で適切に再生できるように動画をエンコードし、結果を S3 に保存する次の Template を見てみましょう。
{
"steps": {
":original": {
"robot": "/upload/handle"
},
"encoded": {
"use": ":original",
"robot": "/video/encode",
"preset": "ipad-high"
},
"exported": {
"use": "encoded",
"robot": "/s3/store",
"credentials": "YOUR_S3_CREDENTIALS",
"bucket": "main-bucket"
}
}
}
Assemblyの作成時に、たとえば
steps プロパティを追加すると、実行時に Template の動作を調整できます。
{
"template_id": "4b62ee4dbb38455d96fe13d972ec3211",
"steps": {
"exported": {
"bucket": "another-bucket"
}
}
}
Transloadit はこれをマージして、次の Assembly Instructionsを作成します。
{
"steps": {
":original": {
"robot": "/upload/handle"
},
"encoded": {
"use": ":original",
"robot": "/video/encode",
"preset": "ipad-high"
},
"exported": {
"use": "encoded",
"robot": "/s3/store",
"credentials": "YOUR_S3_CREDENTIALS",
"bucket": "another-bucket"
}
}
}
このように、bucket の値が "main-bucket" から
"another-bucket" に変わりました。信頼できる環境では、便利で強力な機能です。
それ以外の環境では、ブラウザーから動作を変更できないように、Stepの上書きを禁止したい場合があります。その場合は、保存済みの Template 内で、次のように allow_steps_override を
false に設定します。
{
"allow_steps_override": false,
"steps": {
// …
},
}
これで、追加の steps が指定されたかどうかにかかわらず、main-bucket だけが使用されます。
Template のオプション
steps と allow_steps_override のほかにも、Assemblyの動作を制御するオプションがあります。
ほとんどのオプションは Template を使用しない場合にも設定できるため、新しい Assembly を作成するための API ドキュメントで説明しています。ただし、ブラウザーなどの信頼できない環境に Transloadit を組み込むと、悪意のある利用者が簡単にこれらを変更できてしまいます。そのため、信頼できない環境で Template のパラメーターを動的に変更できるようにするには、Signature Authenticationの使用を検討してください。