音声から波形画像を生成
🤖/audio/waveform は音声ファイルから波形画像を生成します。色やサイズも変更できます。

波形生成の Step の前に、🤖/audio/encode を使う Step で音声ファイルを MP3 に変換することをお勧めします。これにより、🤖/audio/waveform が確実に音声ファイルを受け付けるようになります。また、大きな音声ファイルをダウンサンプリングして、コストを抑えることもできます。
同様に、出力画像を別の形式にする必要がある場合は、この Robot の結果を 🤖/image/resize に渡してください。
使用例
アップロードした音声ファイルから、色が #0099cc、サイズが 400×200 の波形画像を生成します:
{
"steps": {
"waveformed": {
"center_color": "0099ccff",
"height": 200,
"outer_color": "0099ccff",
"robot": "/audio/waveform",
"use": ":original",
"width": 400
}
}
}パラメーター
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 には任意の名前を付けられます。ただし、
ffmpegobjectFFmpeg に渡すパラメーターオブジェクトです。プリセットを使用する場合、ここで指定したオプションがプリセットのオプションに上書きマージされます。利用可能なオプションは、FFmpeg ドキュメントを参照してください。ここで指定したオプションは、プリセットのオプションよりも優先されます。
ffmpeg_stackv6 | v7 | v8 | string(デフォルト:"v6.0.0")エンコードに使用する FFmpeg スタックのバージョンを選択します。現在は「v7」の使用を推奨しています。「v6.0.0」、「v7.0.0」、「v8.0.0」という正確なバージョン指定は、後方互換性のために引き続き受け付けられるレガシー値です。非推奨の「v5.x」の値も受け付けられます。
formatimage | json(デフォルト:"image")出力ファイルの形式です。
"image"または"json"を指定できます。"image"を指定すると PNG 画像を、それ以外の場合は JSON ファイルを作成します。styleが"spectrogram"の場合は、"image"のみ対応しています。widthstring | number(デフォルト:256)形式として
"image"を選択した場合の出力画像の幅です。heightstring | number(デフォルト:64)形式として
"image"を選択した場合の、出力画像の高さです。antialiasing0 | 1 | boolean(デフォルト:0)波形グラフのエッジを滑らかにするアンチエイリアシングを有効にするかどうかに応じて、
0または1、あるいはtrue/falseを指定します。background_colorstring(デフォルト:"#00000000")形式として
"image"を選択した場合の、出力画像の背景色です。「rrggbbaa」形式(赤、緑、青、アルファ)で指定します。center_colorstring(デフォルト:"000000ff")グラデーションの中央に使用する色です。形式は「rrggbbaa」(赤、緑、青、アルファ)です。
outer_colorstring(デフォルト:"000000ff")グラデーションの外側に使用する色です。形式は「rrggbbaa」(赤、緑、青、アルファ)です。
stylev0 | v1 | spectrogram波形スタイルのバージョンです。
"v0":レガシーの波形生成(デフォルト)。"v1":追加パラメーターを備えた高度な波形生成。"spectrogram":周波数成分の時間変化を表示するスペクトログラム。
後方互換性のため、数値
0と1も受け付け、それぞれ"v0"と"v1"に対応付けます。split_channelsbooleanstyle が
"v1"の場合に使用できます。trueに設定すると、マルチチャンネルの波形データまたは画像ファイルをチャンネルごとに出力します。zoomstring | numberstyle が
"v1"の場合に使用できます。ピクセルあたりのサンプル数で指定するズームレベルです。このパラメーターはpixels_per_secondと併用できません。pixels_per_secondstring | numberstyle が
"v1"の場合に使用できます。ズームレベルを秒あたりのピクセル数で指定します。このパラメーターはzoomと併用できません。bits8 | 16style が
"v1"の場合に使用できます。波形データのビット深度です。8 または 16 を指定できます。startstring | numberstyle が
"v1"の場合に使用できます。開始時間を秒単位で指定します。endstring | numberstyle が
"v1"の場合に使用できます。終了時間を秒単位で指定します(0 は音声の末尾を意味します)。colorsaudition | audacitystyle が
"v1"の場合に使用できます。使用する配色です。"audition" または "audacity" を指定できます。border_colorstringstyle が
"v1"の場合に使用できます。枠線の色を「rrggbbaa」形式で指定します。waveform_stylenormal | barsstyle が
"v1"の場合に使用できます。波形のスタイルです。"normal" または "bars" を指定できます。bar_widthstring | numberstyle が
"v1"の場合に使用できます。waveform_style が "bars" の場合の、棒の幅をピクセル単位で指定します。bar_gapstring | numberstyle が
"v1"の場合に使用できます。waveform_style が "bars" の場合の、棒の間隔をピクセル単位で指定します。bar_stylesquare | roundedstyle が
"v1"の場合に使用できます。waveform_style が "bars" の場合の、棒のスタイルです。axis_label_colorstringstyle が
"v1"の場合に使用できます。軸ラベルの色を「rrggbbaa」形式で指定します。no_axis_labelsbooleanstyle が
"v1"の場合に使用できます。trueに設定すると、軸ラベルなしで波形画像を描画します。with_axis_labelsbooleanstyle が
"v1"の場合に使用できます。trueに設定すると、軸ラベル付きの波形画像を描画します。amplitude_scalestring | numberstyle が
"v1"の場合に使用できます。振幅のスケール係数です。compressionstring | numberstyle が
"v1"の場合に使用できます。PNG の圧縮レベルです。0(圧縮なし)から 9(最高圧縮)、または -1(デフォルト)を指定します。format が "image" の場合にのみ適用されます。color_mapviridis | plasma | magma | cividis | cool | rainbow | moreland |style が
"spectrogram"の場合に使用できます。スペクトログラムの可視化に使用する配色です。デフォルトは"viridis"です。frequency_scalelinear | logarithmicstyle が
"spectrogram"の場合に使用できます。スペクトログラムの周波数スケールです。"linear"は周波数を等間隔で表示し、"logarithmic"は低い周波数を強調します。デフォルトは"logarithmic"です。frequency_minstring | numberstyle が
"spectrogram"の場合に使用できます。表示する最小周波数を Hz 単位で指定します。デフォルトは0です。frequency_maxstring | numberstyle が
"spectrogram"の場合に使用できます。表示する最大周波数を Hz 単位で指定します。デフォルトはサンプルレートの半分(ナイキスト周波数)です。legendbooleanstyle が
"spectrogram"の場合に使用できます。周波数と時間のスケールを示す凡例を含めるかどうかを指定します。デフォルトはfalseです。gainstring | numberstyle が
"spectrogram"の場合に使用できます。スペクトログラムの強度に適用する線形ゲイン係数です。デフォルトは1です。orientationvertical | horizontalstyle が
"spectrogram"の場合に使用できます。スペクトログラムの向きです。"horizontal"は時間を x 軸に表示し(デフォルト)、"vertical"は時間を y 軸に表示します。