Hisui を利用してみる

October 8, 2025 · View on GitHub

まずは Hisui を使って録画データの合成をしてみましょう。

リリースされたビルド済みのバイナリを使用して合成する

ビルド済みのバイナリを使用する場合は Releases より環境に応じた最新のバイナリをダウンロードしてください。

curl -L https://github.com/shiguredo/hisui/releases/download/{ VERSION }/{ BINARY_NAME } -o hisui
chmod +x hisui

なお、自前でのビルドについては ビルド方法 をご参照ください。

Hisui には録画ファイルの合成を行うための compose コマンドがあります。 Sora が録画ファイルを保存したディレクトリを指定して、このコマンドを実行すると合成が始まります。

# 録画ディレクトリを確認
$ ls 録画ファイルの配置ディレクトリ/
report-{ RECORDING_ID }.json
archive-{ CONNECTION_ID }.json
archive-{ CONNECTION_ID }.mp4
...

# 合成を実行
$ ./hisui compose 録画ファイルの配置ディレクトリ/

# 合成結果ファイルを確認
$ ls 録画ファイルの配置ディレクトリ/output.mp4

Docker イメージを使用して合成する

Docker を使用することで、環境構築なしで Hisui を利用することもできます。 詳細は Docker を利用した Hisui の実行 をご参照ください。

映像・音声の構成やエンコード設定を指定して合成する（レイアウト機能）

Hisui にはレイアウトという機能があり、そちらを利用することでより自由な合成が可能です。

レイアウトは JSON 形式のファイルで定義し、 compose コマンドの --layout 引数で指定します。

# レイアウトファイルを指定して合成を実行
./hisui compose --layout レイアウト.jsonc 録画ファイルの配置ディレクトリ/

--layout 引数が省略された場合は デフォルトのレイアウト が使用されます。 デフォルトでは、録画データの映像がグリッド状に並べられます。 より複雑な構成での合成も可能ですので、レイアウト機能のドキュメント を参考にして、ぜひ試してみてください。

また、レイアウトファイルを使うことで、合成時に使用するエンコードコーデックやエンコードパラメーターを変更することも可能です。 これらを指定することで、用途に応じて、変換時間と画質のどちらを優先するか、などを細かく制御できます。

指定方法の詳細は エンコードコーデックやパラメーターの指定 のドキュメントをご参照ください。

また tune コマンドを利用することで、エンコードパラメーターの自動調整を行うことができます。

利用可能なコマンド一覧

Hisui は compose 以外にもいろいろなコマンドを提供しています。

利用可能なコマンドとドキュメントは以下になります。目的に合った項目を参照してください。

  • compose - Sora が保存した録画ファイルを合成するためのコマンド
  • list-codecs - 利用可能なコーデックの一覧を表示するコマンド
  • tune - 映像エンコードパラメーターの最適化を行うコマンド
  • vmaf - 録画ファイルの品質評価（VMAF スコア計算）を行うコマンド
  • inspect - 録画ファイルの詳細情報を取得するコマンド