コネクション ID の導入

コネクション ID の導入について不明点がある場合はサポートまでお気軽にお問い合わせください

シグナリング接続時や認証サーバの成功時に client_id の指定を有効にする設定はプレビュー版となります

重要

クライアントや認証サーバから client_id の指定を有効にする allow_client_id_assignment 設定を有効にしない限り、 今までと同じ運用が可能です。既存システムを変更する必要はありません。

コネクション ID 導入の経緯

Sora 19.04 から接続ごとのユニークな ID として connection_id を払い出すようになりました。これは今までの client_id と同等のものです。

一方、 client_id はシグナリング開始時、または認証成功時の戻り値にて指定が可能になりました。また client_id は重複が可能になりました。この仕組を利用することで複数の接続を 1 つの client_id で管理することできるようになります。指定可能な client_id は 255 バイトまでの文字列です。

この仕組は 1 クライアントが複数の接続を保持したり、 1 クライアントが複数の端末から利用している場合に、 シグナリング経由でのプッシュ通知や、 API 経由での切断を一つの API で行うことを目的としています。

今までは 1 接続 1 クライアント ID という仕組みをとってきましたが、今回の変更で 1 接続 1 コネクション ID と定義し直しました。複数接続 1 クライアント ID が実現可能になりました。

変更要点

  • 今までの client_id のようにすべての接続でユニークな値である connection_id が払い出されるようになります

  • sys.config にて allow_client_id_assignmenttrue にすることでシグナリング開始時と認証成功時の戻り値で client_id が指定可能になります

  • client_id が重複可能になります

変更点一覧

  • シグナリングの type: offer 時に connection_id が払い出され、常にユニークになります

  • 認証とイベントウェブフック時に connection_id が追加されます

  • sys.configallow_client_id_assignment 設定が追加されます

    • 設定を有効にした場合、シグナリング開始時に client_id を指定可能になります

    • 設定を有効にした場合、認証ウェブフック成功時に client_id を指定可能になります

    • 設定を有効にした場合、シグナリング開始時に client_id が指定されない場合、認証ウェブフック時に通知される client_idnull が入るようになります

    • 設定を有効にした場合、 client_id は重複が可能になります

    • 設定有効時には API で今まで client_id を指定できたものは connection_id での指定が必要になります

  • client_id をクライアントからも認証サーバからも指定しない場合は client_id は今までどおりユニークになります

  • 今まで client_id が含まれていた API の戻り値やログに connection_id の項目が追加されます

API の変更点

PushClient API

API の指定方法は後方互換性が維持されます。

ただし sys.config にて allow_client_id_assignmenttrue にした場合は、 指定した client_id が割り当てられた全ての接続にプッシュ通知が送られます。

DisconnectClient API

API の指定方法は後方互換性が維持されます。

ただし sys.config にて allow_client_id_assignmenttrue にした場合は、 指定した client_id が割り当てられた全ての接続が切断されます。

GetStats API

API の指定方法は後方互換性が維持されます。

ただし sys.config にて allow_client_id_assignmenttrue にした場合は、 利用ができなくなります。

代わりに GetStatsClient API と GetStatsConnection API を利用してください。

StartForwardingRtp API

API の指定方法は後方互換性が維持されます。

ただし sys.config にて allow_client_id_assignmenttrue にした場合は、 client_id が指定できなくなります。 代わりに connection_id を指定してください。

StopForwardingRtp API

API の指定方法は後方互換性が維持されます。

ただし sys.config にて allow_client_id_assignmenttrue にした場合は、 client_id が指定できなくなります。 代わりに connection_id を指定してください。

Disconnect API

API の指定方法は後方互換性が維持されます。

ただし sys.config にて allow_client_id_assignmenttrue にした場合は、 利用ができなくなります。

代わりに DisconnectClient API と DisconnectConnection API を利用してください。

CastAlwaysSpotlight API

後方互換性が維持されません

client_idconnection_id に変更されます。

CastSpotlight API

後方互換性が維持されません

client_idconnection_id に変更されます。

CancelSpotlight API

後方互換性が維持されません

client_idconnection_id に変更されます。

ChangeSimulcastQuality API

後方互換性が維持されません

client_idconnection_id に変更されます。