ICE コネクションステート機能¶

概要¶

ICE コネクションステート機能は Sora に ICE コネクションによる状態管理を持たせた機能です。

前提¶

この機能はクライアント側が意識する必要はありません。

挙動¶

Sora は WebRTC が確立した後に TURN 上で ICE コネクションステートを更新し続けます。 ステートの更新には STUN Binding-Request と STUN Binding-Success を利用します。

• Sora は 2.5 秒間隔で STUN Binding-Request をクライアントへ送ります
  • STUN Binding-Success が 2.5 秒以内に一度も返ってこない場合、状態を connected から checking へ遷移します
• 状態が checking へ遷移した場合、 Sora は 1 秒間隔で STUN Binding-Request をクライアントへ送ります
  • STUN Binding-Success が 5 秒以内に一度も返ってこない場合、状態を checking から disconnected へ遷移します
  • この 5 秒は sora.conf にて ice_connection_state_disconnected_timeout で変更できます
• 状態が disconnected に遷移した場合、 Sora は 50 ミリ秒間隔で STUN Binding-Request をクライアントへ送ります
  • STUN Binding-Success が 10 秒以内に一度も返ってこない場合、状態を disconnected から failed へ遷移します
  • この 10 秒は sora.conf にて ice_connection_state_failed_timeout で変更できます
  • このタイミングで sora.jsonl に warning として ICE-CONNECTION-STATE-DISCONNECTED が出力されます
• 状態が failed に遷移した場合、Sora はクライアントの接続を切断します
  • このタイミングで sora.jsonl に error として ICE-CONNECTION-STATE-FAILED が出力されます

設定¶

ICE コネクションステート機能は無効にすることはできません。

ただし、切断や失敗までの判定時間を sora.conf にてデフォルト値から変更できます。

ウェブフック¶

コネクションの状態が checking と disconnected だった合計時間をイベントウェブフックで取得できます。

• 取得可能なイベントウェブフック
  • connection.created
  • connection.updated
  • ``connection.destroyed ``
• data.ice_connection_state.total_checking_duration_ms に checking だった合計時間(ミリ秒)の合計が入ります
• data.ice_connection_state.total_disconnected_duration_ms に disconnected だった合計時間(ミリ秒)の合計が入ります

{
  // 色々省略してます
  "type": "connection.destroyed",
  "channel_id": "sora",
  "connection_id": "GS4Q8PQ5PS3EXC30T6PM2R7Y20",
  "timestamp": "2023-08-16T05:42:13.970729Z",
  "bundle_id": "GS4Q8PQ5PS3EXC30T6PM2R7Y20",
  "client_id": "GS4Q8PQ5PS3EXC30T6PM2R7Y20",
  "data": {
    "ice_connection_state": {
      "total_checking_duration_ms": 5002,
      "total_disconnected_duration_ms": 10002
    }
  }
}

シーケンス図¶