アプリサーバーデータ
アプリケーションは、1対1通話を作成したり、グループ通話（カンファレンス）に参加したりする際にアプリクライアントとアプリサーバーとの間でアプリケーションデータを共有できます。このため、アプリクライアントからアプリサーバーに送信するアプリケーションデータをアプリサーバーデータ（app server data）といいます。
| 対応する通話タイプ | SDKの最低バージョン |
|---|---|
| 1対1通話、グループ通話 | 1.2 |
アプリサーバーデータを送信する
通話のタイプによってアプリサーバーデータを送信する方法について説明します。
1対1通話
1対1通話では、発信者だけがアプリサーバーデータを送信できます。
1対1通話でアプリサーバーデータを送信するには、PlanetKitMakeCallParamにアプリサーバーデータを設定し、makeCall()を呼び出す際にPlanetKitMakeCallParamを渡します。
final param = PlanetKitMakeCallParamBuilder()
.setMyUserId(myUserId)
.setMyServiceId(myServiceId)
.setPeerUserId(peerUserId)
.setPeerServiceId(peerServiceId)
.setAccessToken(accessToken)
.setAppServerData("App server data for a 1-to-1 call")
.build();
final result = await PlanetKitManager.instance.makeCall(param, eventHandler);
アプリサーバーデータは、サーバーコールバックの Notifyコールバックおよび1対1通話のイベントコールバックのapp_svr_dataパラメーターで渡されます。
グループ通話
グループ通話では、参加者全員がアプリサーバーデータを送信できます。
グループ通話でアプリサーバーデータを送信するには、PlanetKitJoinConferenceParamにアプリサーバーデータを設定し、joinConference()を呼び出す際にPlanetKitJoinConferenceParamを渡します。
final param = PlanetKitJoinConferenceParamBuilder()
.setMyUserId(myUserId)
.setMyServiceId(myServiceId)
.setRoomId(roomId)
.setRoomServiceId(roomServiceId)
.setAccessToken(accessToken)
.setAppServerData("App server data for a group call")
.build();
final result = await PlanetKitManager.instance.joinConference(param, eventHandler);
アプリサーバーデータは、グループ通話イベントのサーバーコールバックのapp_svr_dataパラメーターで渡されます。
サイズの制限
アプリサーバーデータの最大サイズはnull終端文字を含めて4096バイトです。
関連API
アプリサーバーデータ機能に関連するAPIは、以下のとおりです。