SkyWay Unity SDK β版の概要
SkyWay Unity SDK β版(以下、Unity SDK)は Unityアプリケーションから SkyWay を利用するための SDK です。
このセクションでは、Unity SDK の動作環境や入手方法を掲載しています。 Unity SDK の採用を検討する際の参考情報としてください。
対応環境
| 項目 | SkyWay Unity SDKの対応状況 |
|---|---|
| OS | Android 8.0 Pie(API Level 26)以降 |
| Unity | 2022.3.2f1 |
アプリケーション開発言語
- C#
配布ライブラリ
Unity SDK は .unitypackage 形式のRoomライブラリが提供されています。 P2P Room と SFU Room の 2 種類の Room があり、どちらかを選択して利用できます。
Roomの使い分けは以下の通りです。
- P2P Room は少人数向け
- 上限人数に制限はありませんが、ユーザーが快適に通話できる人数は 4 人までです
- SFU Room は多人数向け
- SFU サーバーを経由してメディア通信を行います
SDK のダウンロード
以下のリポジトリでリリースノートと Unity Packageを公開しています。
Room ライブラリの仕様
Room ライブラリを使って SkyWay を利用する上で理解する必要のある基本的な仕様について説明します。
Room
通話を行うグループの単位であり、ユーザーは共通の Room に参加したユーザー同士で通話を行います。 Room に参加しているユーザーのことを Member と呼びます。
Stream
Room 上で送受信できるメディアのことを Stream といいます。以下の 3 種類の Stream を利用できます。
- AudioStream
- ユーザーのマイク音声など
- VideoStream
- ユーザーのカメラ映像など
- DataStream
- 任意のメッセージ
- SFU Room では利用できません
Publish
Member が Stream を Room に公開することを Publish といいます。
Stream を Publish すると Room 上に Stream に対応する Publication というリソースが作成されます。
Subscribe
Member が Room 上の Publication を受信することを Subscribe といいます。
Subscribe をすると Room 上に Subscription というリソースが作成されます。
Publication を Subscribe した Member は Subscription を通じて Stream にアクセスし映像や音声を受信できます。
SkyWay Auth Token
SkyWay Auth Token は、SkyWay を利用するために必要な JWT（JSON Web Token）形式のトークンです。
ユーザー毎に権限を細かく設定することでき、例えば Room ごとの入室を特定ユーザーに制限する、といったことができます。
SkyWay Auth Token を利用するためには、これを払い出すアプリケーションサーバーを構築する必要があります。SkyWay SDK を利用したクライアントアプリは、アプリケーションサーバーから SkyWay Auth Token を取得し、これを用いて各種 SkyWay の機能を利用します。
なお、サーバーを構築せずにフロントエンドで SkyWay Auth Token を生成した場合、シークレットキーをエンドユーザーが取得できるため、権限の制限が機能せず注意する必要があります。