Transloadify の紹介:コマンドラインから Transloadit を利用
2017年2月14日、Transloadit のエンコードプラットフォームを利用するためのコマンドラインツール、Transloadify のベータ版を発表しました。SDK との連携コードを先に書かなくても、メディア処理を自動化できるツールでした。Adrian によるこのチュートリアルは、当初 transloadify.io に掲載されました。
Transloadify はその後、非推奨になりました。CLI は Node.js SDK に移り、現在は @transloadit/node として公開されています。以下の例では、このパッケージのバージョン 4.12.0 を使用します。当初の開発動機と動画に透かしを入れるワークフローは今も有効ですが、以前のベータ登録コマンドやパッケージのインストール手順は現在のものではありません。
はじめに
IoT プロジェクトで動画を録画する Raspberry Pi を想像してください。YouTube に公開する前に各動画に透かしを入れつつ、デバイスの CPU はほかの処理に使えるようにしておきたいとします。録画済みのファイルを Transloadit にアップロードすれば、エンコードをリモートで実行できます。
より高性能なマシンで大規模なメディアライブラリを扱う場合にも、同じ方法が役立ちます。Transloadit のプリセットと処理用 Robot で必要な出力を定義し、ローカルファイルは CLI スクリプトで扱えます。アップロードと処理にかかる時間は、ファイル、接続環境、処理設定によって変わります。
まず動画を1本処理し、次にディレクトリを監視し、最後に結果を YouTube に直接エクスポートします。Assembly を作成するコマンドはアカウントを使用し、処理料金が発生する場合があります。
インストール
このチュートリアルでは、Node.js 24 以降をインストールしてください。グローバルインストールせずに、バージョンを固定した CLI を実行します。
npx -y @transloadit/node@4.12.0 --help
npx -y @transloadit/node@4.12.0 assemblies create --help
その他の配布元
当初の発表では、Arch Linux の AUR パッケージと、提供予定の Docker イメージに言及していました。これらは当時の配布に関する情報であり、この更新版チュートリアルの前提条件ではありません。ここで示す CLI の仕様については、公式 Node.js SDKを使用してください。
登録と認証
Transloadit のウェブサイトでアカウントを作成し、アカウントから Auth Key と Auth Secret を取得してください。シークレットマネージャーから CLI プロセスに TRANSLOADIT_KEY と
TRANSLOADIT_SECRET を渡してください。これらの値をシェル履歴、ソース管理、クライアントアプリに保存しないでください。
CLI は、現在のディレクトリにある .env ファイルと、dotenv 形式の ~/.transloadit/credentials も読み込みます。シェルの環境変数が優先されます。認証情報ファイルは非公開にしてください。当初の transloadify register、transloadify authenticate、.transloadify ファイル、TRANSLOADIT_AUTH_* という変数名は、これらのコマンドで使う設定ではありません。
CLI は、Auth Secret を預けてもよい信頼できるマシンでのみ実行してください。Template を使うとストレージの認証情報を Transloadit に保持できますが、信頼できないデバイスに Auth Secret を配布しても安全になるわけではありません。ブラウザーやモバイルの連携では、認証済みサーバーから有効期間の短い署名付き処理設定を取得する必要があります。
Assembly Instructions の指定
この steps オブジェクトを steps.json として保存してください。動画を処理する前に、透かしの URL を、公開アクセス可能で管理下にある HTTPS 画像の
URL に置き換えてください。
{
"video_encode": {
"robot": "/video/encode",
"use": ":original",
"preset": "webm",
"watermark_url": "https://example.org/watermark.png",
"result": true
}
}
--steps はこのオブジェクトを受け取ります。明示した WebM プリセットは、以下の出力ファイル名に対応しています。透かしの配置やその他の出力設定については
/video/encode のドキュメントを、Step の構成については Assembly Instructionsを参照してください。
動画の処理
出力ディレクトリを作成し、録画済みのファイルを処理します。
mkdir -p watermarked
npx -y @transloadit/node@4.12.0 assemblies create \
--steps steps.json -i originals/recording.webm -o watermarked/recording.webm
このコマンドは入力をアップロードし、Assembly の完了を待って、選択した結果をダウンロードします。終了ステータスと診断出力を確認してください。何も出力されないことが成功を意味するわけではありません。この Template は入力ごとに結果を1つ生成するため、単一の出力ファイル名を指定するのが適切です。結果ファイルが複数ある場合は出力ディレクトリを使用し、CLI の出力オプションを確認してください。
自動化
最も予測しやすい連携方法は、録画プログラムが出力ファイルを閉じた後にコマンドを呼び出すことです。代わりに、既存のディレクトリを監視することもできます。
mkdir -p originals watermarked
npx -y @transloadit/node@4.12.0 assemblies create \
--watch --steps steps.json -i originals/ -o watermarked/
監視対象には、既存の入力とその後の変更が含まれます。監視対象ディレクトリの外で録画し、録画が完了したら、同じファイルシステム上でそのディレクトリに移動してください。ファイルシステムのイベントだけでは、録画の完了を確認できません。処理結果を再び処理しないよう、出力先は入力ディレクトリの外にしてください。終了時は Ctrl+C で監視を停止します。
Dropbox などの共有フォルダーを使うワークフローにも適用できます。ある人が録画済みのファイルを追加し、信頼できるマシンが処理して別の出力フォルダーに保存する構成です。監視を有効にする前に、同期クライアントが未完了のファイルをどう扱うか考慮してください。監視機能は永続的なジョブキューではありません。再起動やファイルの変更で、別の Assembly が作成される場合があります。確実な再試行と監査のために、アプリケーションでジョブと Assembly ID を追跡してください。より緊密な連携が必要な場合は、Ruby や Go の SDK も選択肢になります。
Template
単一のマシンでは、ローカルの steps ファイルが便利です。Template を使うと、信頼できる複数のワーカーで、中央管理された処理設定を共有できます。ウェブインターフェースまたは次のコマンドで作成してください。
npx -y @transloadit/node@4.12.0 templates create watermarker steps.json
このコマンドは新しい Template ID を表示します。シェルで TEMPLATE_ID にその ID を設定してください。Template の名前は人が読みやすいラベルであり、識別子ではありません。次に、--steps を --template に置き換えます。
npx -y @transloadit/node@4.12.0 assemblies create \
--watch --template "$TEMPLATE_ID" -i originals/ -o watermarked/
Template から Template 認証情報を参照すると、ストレージのシークレットを Transloadit アカウント内に保持できます。CLI 自体のアカウント認証情報も非公開にしてください。
Transloadit の活用
最終的な公開先が YouTube であれば、Transloadit から透かし入り動画を直接エクスポートできます。Raspberry Pi にダウンロードしてから再度アップロードする必要がなくなります。ただし、最初のアップロードが不要になるわけではなく、特定の転送速度が保証されるわけでもありません。
Template 認証情報の画面で YouTube を承認し、その認証情報の名前を Template で参照してください。アカウントの要件とエクスポートのオプションは、/youtube/storeを参照してください。steps.json を次の内容に置き換えます。
{
"video_encode": {
"robot": "/video/encode",
"use": ":original",
"preset": "webm",
"watermark_url": "https://example.org/watermark.png"
},
"youtube": {
"robot": "/youtube/store",
"use": "video_encode",
"credentials": "my_youtube_credentials",
"title": "Watermarked Raspberry Pi recording",
"description": "A recording processed with Transloadit.",
"category": "science & technology",
"keywords": "raspberry pi, transloadit",
"visibility": "private"
}
}
この例では、公開前に結果を確認できるよう、非公開でエクスポートします。title、description、category、keywords、visibility をワークフローに合わせて調整してください。名前を明示的に保持しながら、ID を指定して Template を更新します。
npx -y @transloadit/node@4.12.0 templates modify "$TEMPLATE_ID" steps.json --name watermarker
次に、結果をローカルにダウンロードしないよう、-o を省略します。
npx -y @transloadit/node@4.12.0 assemblies create \
--watch --template "$TEMPLATE_ID" -i originals/
これで、当初の Transloadify の発表で示そうとしたワークフローが整いました。ローカルでの録画、リモートでの透かし処理、直接公開を、コマンドラインから連携できます。自動処理を無人で稼働させる前に、実行結果の Assembly のステータスと YouTube の出力を確認してください。
元のチュートリアルは transloadify.io に初めて掲載されました。上記のコマンドは、Node.js SDK CLI 向けに更新されています.
