本文にスキップする
Version: 5.5

アプリケーションガイド

ここでは、サブグループAPIの使用に関するガイドラインについて説明します。サブグループAPIを利用するアプリケーションを実装する際には、以下の項目に注意する必要があります。

  1. サブグループメンバーだけがサブグループにメディア(オーディオ、ビデオ、共有画面)を送信できます。
    • サブグループに加入していない参加者は、サブグループにメディアを送信できません。
  2. サブグループメンバーだけがサブグループのメディア(オーディオ、ビデオ、共有画面)を受信できます。
    • サブグループに加入していない参加者は、サブグループのメディアを受信できません。
  3. サブグループ名は、NULL文字を含む長さが16バイト未満でなければなりません。
  4. サブグループ名は、一意でなければなりません。
    • LINE Planet Cloudは、サブグループ名でそれぞれのサブグループを区別します。
    • subscribe()メソッドを呼び出す際に同じサブグループ名を引数として使用すると同じサブグループに加入できます。
  5. サブグループのプロパティが異なる場合、サブグループへの加入に失敗します。
    • サブグループのプロパティはsubscribe()メソッドで設定します。そのメソッドはpeerUpdate、videoUpdate、dataSessionにあたるパラメーターを受け取ります。
    • 同じサブグループに属したサブグループメンバーは、必ず上記のパラメーターに同じ値を使用しなければなりません。
    • 他のサブグループのプロパティを使用した参加者が加入しようとすると、wrongAttributeというPlanetKitSubgroupSubscribeFailReasonと共に加入に失敗します。
    • peerUpdateをNONEに、dataSessionをTRUEに設定した組み合わせはサポートしていませんので、使用しないでください。そのように設定すると、wrongAttributeというPlanetKitSubgroupSubscribeFailReasonと共に加入に失敗します。
  6. サブグループのメディアは、それぞれ独立しています。
    • アプリケーションは、それぞれ異なるサブグループに、オーディオとビデオを送信できます。
  7. サブグループ数には上限があります。
    • サブグループを作成すると、LINE Planet Cloudのリソースが大きく消費されます。
    • グループ通話あたりのサブグループ数は最大30個です。
    • サブグループ数が既に上限に達している場合は、overMaxSubgroupCountというPlanetKitSubgroupSubscribeFailReasonと共に加入に失敗します。
  8. 以下のように、どのサブグループからメディアが送信されているかを確認できます。
    • オーディオ:PlanetKitが、現在アクティブになっている発話者のオーディオボリュームとユーザーID、サブグループ名を共に提供します。
    • ビデオ:PlanetKitConferencePeercurrentVideoSubgroupNameでサブグループ名を得られます。
    • 画面共有:PlanetKitConferencePeercurrentScreenShareSubgroupNameでサブグループ名を得られます。
  9. サブグループから退会する前に、サブグループに送信していたすべてのメディア(オーディオ、ビデオ、共有画面)を中断する必要があります。

関連ドキュメント

より詳細な情報が記載されているサブグループの基本概念も参照してください。