Vimeo へのファイルエクスポート
🤖/vimeo/store は、エンコード結果を Vimeo にエクスポートします。

はじめに
アップロード用の Vimeo OAuth を使用して Template 認証情報を作成するか、自分のパーソナルアクセストークンを貼り付けてください。この Robot には、パーソナルトークンの upload、edit、interact が必要です。インポート用に Console から保存する場合は、さらに public、private、video_files が必要です。Vimeo アプリにはアップロード権限が必要です。トークンの作成や再接続については、Vimeo トークンの設定手順に従ってください。
動画ごとに title または description を変更するには、Template に変数を挿入することをお勧めします。
Vimeo API では、Vimeo アカウントのプランに応じて、1分間の同時アップロード数が制限されます。プランで同時にアップロードできる動画の数は、こちらのリンクから確認してください。
この Robot が受け付けるのは動画のみです。
使用例
アップロードした動画を Vimeo にエクスポートし、タイトルと説明を設定します:
{
"steps": {
"exported": {
"credentials": "YOUR_VIMEO_CREDENTIALS",
"description": "Some nice description",
"robot": "/vimeo/store",
"title": "Transloadit: Video Example",
"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(デフォルト: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 には任意の名前を付けられます。ただし、
credentialsstringTransloadit アカウントで対応する Template 認証情報 を作成し、その Template 認証情報 の名前をこのパラメーターの値に指定してください。ここには Vimeo アクセストークンの値が保存されます。
/vimeo/import の場合は、developer.vimeo.com/appsで自分のアプリを作成し、
Generate Access Tokenを開いてAuthenticated (you)を選び、Public、Private、Video Files(public private video_files)を選択してください。パーソナルアクセストークンを生成し、Console で Vimeo と Paste a personal access token を選択してください。トークンはaccess_tokenとして保存され、Console に再表示されることはありません。保存時に Vimeo アカウントとトークンのスコープが確認されます。動画ファイルのリンクには、対象となる Vimeo アカウントと動画の権限も必要です。Console の Vimeo OAuth は /vimeo/store に対応しています。Transloadit は Vimeo パートナーではないため、他のメンバーのアカウントに
video_filesを付与できません。インポートには自分のパーソナルアクセストークンが必要です。そのトークンを /vimeo/store にも使用するには、Upload、Edit、Interact(upload edit interact)も付与し、Vimeo アプリにアップロード権限があることを確認してください。認証情報を更新しても、OAuth の再実行や権限の追加は行われません。再接続するには、認証情報を Remove で削除してから、同じ名前で新しい認証情報を作成してください。削除すると、そのトークンは Vimeo 側で失効します。パーソナルトークンの場合は、新しいトークンを生成してから再度保存してください。失効すると、そのトークンの他の用途での使用にも影響します。Vimeo 認証情報の設定手順を参照してください。
title— 必須stringVimeo に表示する動画のタイトルです。
description— 必須stringVimeo に表示する動画の説明です。
aclanybody | contacts | disable | nobody | password | unlisted | users(デフォルト:"anybody")動画へのアクセス権限を制御します。有効な値は次のとおりです。
"anybody"— 誰でも動画にアクセスできます。"contacts"— Vimeo で所有者をフォローしているユーザーのみが動画にアクセスできます。"disable"— 動画は埋め込めますが、Vimeo 上では非表示になり、再生できません。"nobody"— 所有者以外は動画にアクセスできません。"password"— パスワードを知っているユーザーのみが動画にアクセスできます。"unlisted"— 非公開リンクを持つユーザーのみが動画にアクセスできます。"users"— Vimeo メンバーのみが動画にアクセスできます。
passwordstringaclが"password"の場合に、動画へのアクセスに使用するパスワードです。showcasesArray<string>(デフォルト:[])動画を追加するショーケースの ID を文字列で指定した配列です。ID は Vimeo の閲覧時に確認できます。例:
https://vimeo.com/manage/showcases/[SHOWCASE_ID]/info。downloadableboolean(デフォルト:false)Vimeo のウェブサイトから動画をダウンロードできるかどうかを指定します。
Vimeo アカウントを「Pro」プランにアップグレードしてこの機能を有効にしている場合にのみ、
trueを設定してください。Freemium プランで使用すると、Vimeo API は"Invalid parameter supplied"エラーを返します。folder_idstring | null(デフォルト:null)動画のアップロード先フォルダーの ID です。
自分のフォルダーを開くと、URL は
https://vimeo.com/manage/folders/xxxxxxxxのようになります。この場合、folder_id は"xxxxxxxx"です。folder_uristring非推奨です。代わりに
folder_idを使用してください。動画のアップロード先フォルダーの URI です。