シグナリング通知¶

sora.conf での指定¶

sora.conf でシグナリング通知の有無を指定する方法です。

sora.conf で signaling_notify = false を指定することで、シグナリング通知が無効になります。

ただし、この値は認証ウェブフックの戻り値で上書きすることが可能です。

認証ウェブフックの戻り値での指定¶

認証ウェブフックの戻り値を利用して、クライアントごとに signaling_notify の true / false を指定する方法です。

認証ウェブフックの戻り値に {"signaling_notify": false} を指定することで、そのクライアントに対して signaling_notify を無効にすることができます。

{
    "allowed": true,
    "signaling_notify": false
}

認証ウェブフックの戻り値に signaling_notify の指定が無い場合は、sora.conf の signaling_notify の値が採用されます。

signaling_notify_client_id¶

sora.conf で signaling_notify_client_id = false を指定することで、シグナリング通知時にクライアント ID を含まなくなります。

signaling_notify_bundle_id¶

sora.conf で signaling_notify_bundle_id = false を指定することで、シグナリング通知時にバンドル ID を含まなくなります。

signaling_notify_connection_id¶

sora.conf で signaling_notify_connection_id = false を指定することで、シグナリング通知時にコネクション ID を含まなくなります。

signaling_notify_media¶

sora.conf で signaling_notify_media = false を指定することで、シグナリング通知時に音声や映像の情報を含まなくなります。

signaling_notify_metadata¶

signaling_notify_metadata は、ユーザーが参加や離脱したときに送られるシグナリング通知に含まれるメタデータです。

シグナリング通知メタデータの詳細は シグナリング通知メタデータ をご確認ください。

signaling_notify_metadata_ext¶

signaling_notify_metadata_ext は、ユーザーが参加や離脱したときに送られるシグナリング通知に含まれるメタデータを、API 経由で自由に変更できるようにします。

シグナリング通知メタデータ拡張の詳細は シグナリング通知メタデータ拡張機能 をご確認ください。

"event_type": "connection.created"¶

この event_type は、参加しているチャネルに接続があった場合に、 signaling_notify を有効にしている自分を含む全員に通知されます。

この通知を利用することで、他のクライアントが接続してきたことをクライアント側で把握することができます。

新規接続クライアントと bundle_id が等しいクライアントに対しては、このイベントは通知されません。 また通知 JSON の data の中身からも bundle_id が等しいクライアントは除外されます。

"event_type": "connection.updated"¶

この event_type は、クライアントごとに異なり、 1 分間隔で通知されます。

この通知を利用することで、現在クライアントの累計接続時間をクライアント側で把握することができます。

"event_type": "connection.destroyed"¶

この event_type は、参加しているチャネルに切断があった場合に、 signaling_notify を有効にしている自分以外の全員に通知されます。

この通知を利用することで、他のクライアントが切断したことをクライアント側で把握することができます。

切断クライアントと bundle_id が等しいクライアントに対しては、このイベントは通知されません。

"event_type": "spotlight.focused"¶

この event_type は、参加しているチャネルの配信がフォーカスされた場合に、 signaling_notify を有効にしている全員に通知されます。

この通知を利用することで、配信が切り替わったことをクライアントが気付くことができるようになります。

フォーカスされたクライアントと bundle_id が等しいクライアントに対しては、このイベントは通知されません。

"event_type": "spotlight.unfocused"¶

この event_type は、参加しているチャネルの配信からフォーカスが外れた場合に、 signaling_notify を有効にしている全員に通知されます。

この通知を利用することで、配信が切り替わったことをクライアントが気付くことができるようになります。

フォーカスが外れたクライアントと bundle_id が等しいクライアントに対しては、このイベントは通知されません。

クライアントに送信される JSON の仕様¶

• event_type
  • string
  • spotlight.focused または spotlight.unfocused が入ります
• channel_id
  • string
  • 現在利用しているチャネル ID が入ります
• client_id
  • string
  • どのクライアントに配信が切り替わったかが入ります
• bundle_id
  • string
  • 切り替わった配信のバンドル ID が入ります
• connection_id
  • string
  • どの接続に配信が切り替わったかが入ります
• spotlight_number
  • integer
  • 現在のスポットライト数が入ります
• audio
  • boolean
  • 切り替わった配信の audio が有効かどうかが入ります
• video
  • boolean
  • 切り替わった配信の video が有効かどうかが入ります
• fixed
  • boolean
  • 切り替わった配信が固定されているかどうかが入ります

{
    "type": "notify",
    "event_type": "spotlight.focused",
    "client_id": "4D40YWH56N5S99QHJV6GAPNHB0",
    "bundle_id": "4D40YWH56N5S99QHJV6GAPNHB0",
    "connection_id": "4D40YWH56N5S99QHJV6GAPNHB0",
    "spotlight_number": 3,
    "audio": true,
    "video": true,
    "fixed": false
}

{
    "type": "notify",
    "event_type": "spotlight.unfocused",
    "client_id": "4D40YWH56N5S99QHJV6GAPNHB0",
    "bundle_id": "4D40YWH56N5S99QHJV6GAPNHB0",
    "connection_id": "4D40YWH56N5S99QHJV6GAPNHB0",
    "spotlight_number": 3,
    "audio": true,
    "video": true,
    "fixed": false
}

sora.conf の設定¶

sora.conf の signaling_notify_recording で通知するかどうかを指定可能です。デフォルトは true で通知します。

signaling_notify_recording = false

"event_type": "recording.started"¶

録画開始時に通知されます。接続前にすでに StartRecording API が実行されていた場合は、 connection.created の後に通知されます。

{
    "type": "notify",
    "event_type": "recording.started",
    "client_id": "4D40YWH56N5S99QHJV6GAPNHB0",
    "bundle_id": "4D40YWH56N5S99QHJV6GAPNHB0",
    "connection_id": "4D40YWH56N5S99QHJV6GAPNHB0"
}

"event_type": "recording.stopped"¶

録画終了時に通知されます。StopRecording API が実行されたタイミング、または期限が切れたタイミングで通知されます。

{
    "type": "notify",
    "event_type": "recording.stopped",
    "client_id": "4D40YWH56N5S99QHJV6GAPNHB0",
    "bundle_id": "4D40YWH56N5S99QHJV6GAPNHB0",
    "connection_id": "4D40YWH56N5S99QHJV6GAPNHB0"
}

"event_type": "network.status"¶

この event_type は、 signaling_notify を有効にしている全員に通知されます。

この通知を利用することで、ネットワークの状態をクライアントが把握することが可能になります。

送られる条件¶

現時点では映像を Sora に対して配信していることが通知の条件になります。

以下は通知されません

• 受信のみ
• 音声だけの配信

現在の判定材料¶

• クライアント、またはサーバーからの再送要求の頻度

クライアントに送信される JSON の仕様¶

• event_type
  • string
  • network.status が入ります
• unstable_level
  • integer
  • ネットワークの不安定レベルが入ります
    • 0
      • とても安定したネットワークです
    • 1
      • 安定したネットワークです
    • 2
      • 不安定なネットワークです
    • 3
      • とても不安定なネットワークです

{
    "type": "notify",
    "event_type": "network.status",
    "unstable_level": 0,
}

sora.conf の設定¶

sora.conf の signaling_notify_rtp_stream で通知するかどうかを指定可能です。デフォルトは true で通知します。

signaling_notify_rtp_stream = false

"event_type": "rtp_stream.pause"¶

RTP ストリーム停止時に通知されます。RTP ストリームが停止される送信側および受信側の接続に通知されます。

{
    "type": "notify",
    "event_type": "rtp_stream.pause",
    "recv_connection_id": "4D40YWH56N5S99QHJV6GAPNHB0",
    "send_connection_id": "4SW2CB0E1D01S23W3G6JFCEN98"
}

"event_type": "rtp_stream.resume"¶

RTP ストリーム再開時に通知されます。RTP ストリームが再開される送信側および受信側の接続に通知されます。

{
    "type": "notify",
    "event_type": "rtp_stream.resume",
    "stream_id": "4D40YWH56N5S99QHJV6GAPNHB0"
}