リファレンス

CLI

npx openfilm で実行するか、npm i -g openfilm でインストールします。引数なしで実行するとエージェント向けマニュアルを表示します。openfilm <command> --help で各コマンドのオプションを表示します。

look、render、get は、カレントフォルダーを含むプロジェクトに対して動きます。open はプロジェクトを作ります。終了ステータス:0 は完了、1 は映像かコマンドの失敗(理由は出力に表示)、2 はプロジェクトではないか、コマンドの誤り。

openfilm open

openfilm open [folder | url]

プロジェクトを始めるか、開きます。まだプロジェクトでないフォルダーには空の film.html ができます。ほかには何も作りません。GitHub や GitLab のアドレス(リポジトリ、またはその中のフォルダー)は、git の履歴なしでプロジェクトにコピーしてから開きます。引数がなければ、カレントフォルダーを含むプロジェクト、なければ最後に開いたプロジェクト、それもなければ Studio のプロジェクト一覧を開きます。

Studio が動いていなければ起動し、そのアドレスを表示します。Studio のページがすでに開いていればそのプロジェクトに切り替わり、そうでなければブラウザーで Studio が開きます。初回は、OpenFilm が映像の描画に使うブラウザー(約 100 MB)をダウンロードします。

openfilm look

openfilm look [what] [t | a-b]

映像をチェックし、描画します。時刻を指定しない場合:映像全体のコンタクトシート、音とラウドネス、そして同じ t が同じ画を描くかのチェック。t を指定した場合:フルサイズの 1 フレーム。a-b を指定した場合:その区間を細かく並べたシート。what には映像のページやメディアファイルも指定できます。PNG は .film/cache/look/ に書き出されます。

openfilm render

openfilm render [a-b]

プロジェクトを MP4 にレンダリングして film.html の隣に保存します。範囲を指定すると .film/cache/render/ に保存します。

オプション
--out <file>別の保存先。--alpha と一緒なら .webm か .mov
--fps <n>フレームレート(30)
--4k幅 3840 px
--scale <n>任意のデバイスピクセル比
--blurモーションブラー(8 サンプル。--samples、--shutter)
--alpha透明な背景
--workers <n>並列で動かすブラウザーの数

openfilm get

openfilm get <what> [--option value …]

接続したサービスからプロジェクト用のメディアを取得し、assets/ に保存します。ナレーション、音楽、効果音、文字起こし、画像、画像検索、動画、字幕翻訳。各種類は、それを作れるサービスを接続すると使えるようになります。単独で実行すると、使えるものが表示されます。料金は各サービスがあなたに直接請求します。