ウェブフックの audio と video 項目の JSON 構造のフラット化¶

概要¶

WebRTC API の仕様に参考にしてきた audio と video の入れ子である JSON 構造を廃止し、フラット化した構造を採用します。

重要

この設定はウェブフックのみでシグナリング接続時の audio/video の構造は変更しません。今後は変更するかもしれませんが、クライアント側を破壊的変更することになるため、もし変更する場合でもかなり時間をかけて変更していきます。

一つの項目に複数の型が存在する仕様は取り扱いが複雑になると判断したためです。

この設定は 2023 年 6 月リリースの Sora 2023.1.0 にてデフォルトを false に変更しました。そのため audio と video の JSON 構造はフラット化されます。

sora.conf にて legacy_webhook_audio_video_json_structure を true にすることで、ウェブフックの audio と video レガシーな入れ子構造が利用可能です。

2023 年 12 月リリース予定の Sora にて廃止し、フラットな構造のみが利用できるようになります。

{"audio": false} は変わりません
{"audio": {"codec_type": "OPUS"}} は {"audio": true, "audio_codec_type": "OPUS"} へフラット化します
{"audio": {"bit_rate": 32}} は {"audio": true, "audio_bit_rate": 32} へフラット化します

{"video": false} は変わりません
{"video": {"codec_type": "VP8"}} は {"video": true, "video_codec_type": "VP8"} へフラット化します
{"video": {"bit_rate": 500}} は {"video": true, "video_bit_rate": 500} へフラット化します

認証ウェブフック成功時の戻り値に指定する audio と video の指定もフラット化する必要があります。

{"audio": false} は変わりません
{"audio": {"codec_type": "OPUS"}} は {"audio": true, "audio_codec_type": "OPUS"} へフラット化して指定する必要があります
{"audio": {"bit_rate": 32}} は {"audio": true, "audio_bit_rate": 32} へフラット化して指定する必要があります
{"audio": true, "audio_codec_type": "OPUS", "audio_opus_params": {"useinbandfec": true}} のように audio_opus_params が指定できるようになりました
{"audio": true, "audio_codec_type": "LYRA", "audio_lyra_params": {"version": "1.3.0"}} のように audio_lyra_params が指定できるようになりました

{"video": false} は変わりません
{"video": {"codec_type": "VP8"}} は {"video": true, "video_codec_type": "VP8"} へフラット化して指定する必要があります
{"video": {"bit_rate": 500}} は {"video": true, "video_bit_rate": 500} へフラット化して指定する必要があります

録画メタデータファイルのフラット化の内容はウェブフック audio / video と同様です。

{"audio": {"codec_type": "OPUS"}} は {"audio": true, "audio_codec_type": "OPUS"} へフラット化します
{"video": {"bit_rate": 1000, "codec_type": "VP9", "height": 480, "width": 640} は {"video": true, "video_bit_rate": 1000, "video_codec_type": "VP9", "video_height": 480, "video_width": 640} へフラット化します