SDK利用時の注意事項
SkyWay 閉域接続プランを利用する際に SDK の設定において注意が必要なポイントを説明します。
本ドキュメントは SkyWay JavaScript SDK クイックスタートをベースとした差分ガイドです。 手順の大部分は元ページと共通であるため、このページには記載していません。
まずは元ページを開き、下記を読み替えながらチュートリアルを実施してください。
読み替えが必要な理由
閉域接続プランで利用できない機能をOFFにするため
現時点での閉域接続プランは基本的な通話機能のみを提供しています。提供している機能は概要をご確認ください。
提供機能に含まれない機能のうち、SkyWay Auth Tokenで制御できるものは明示的に OFF にすることを推奨します。 明示的に OFF にしない場合、過剰なエラーログが出力される場合があります。
⚠️ 提供機能に含まれない機能を明示的にOFFにしない場合、不要なエラーログが出力されますが、通話自体は利用できます。SFU に関しては通話を開始できないリスクがあるため、次の節をご確認ください。
SFUの利用をOFFにするため(SFUを利用しない契約が対象)
SkyWay 閉域接続プランでは、契約によって SFU の利用可否が分かれます。なお、契約している SFU の利用可否は SkyWay コンソールから確認できます。
SFU を利用しない契約の場合、SkyWay Auth Tokenで SFU の利用を明示的に OFF にする必要があります。
❗️ SFU を利用しない契約の場合、環境に SFU サーバーが構築されません。そのため、明示的に機能の利用を OFF にしないと、Room 作成時にエラーとなり通話を開始できません。
進め方
元ページの章立てに沿って、以下のとおり読み替えてください。
| 元ページの章 | 閉域接続プランでの扱い |
|---|---|
| 環境構築[CDN/NPM] | そのまま(後述の追加 import のみ反映) |
| アプリケーションIDとシークレットキーの取得 | そのまま |
| 開発環境向けAPIで初期化する | 下記「SkyWay Auth Tokenを準備する」に読み替え ↓ |
| カメラ映像、マイク音声の取得 | そのまま |
| 通信処理の追加 | SkyWayContext.CreateForDevelopment(...) の行だけ下記「初期化処理を置き換える」に対応 |
SkyWay Auth Tokenを準備する
importに SkyWayAuthToken を追加する
NPM版:SkyWay Auth Token 用の処理を main.js の import 行に追加
import {
SkyWayContext,
SkyWayRoom,
SkyWayStreamFactory,
SkyWayAuthToken, // 追加
uuidV4, // 追加
nowInSec, // 追加
} from "@skyway-sdk/room";CDN版:SkyWay Auth Token 用の処理を main.js の分割代入に追加
const {
SkyWayContext,
SkyWayRoom,
SkyWayStreamFactory,
SkyWayAuthToken, // 追加
uuidV4, // 追加
nowInSec, // 追加
} = skyway_room;トークン生成関数を追加する
元ページの appId / secret の定義の下に、以下の関数を追加してください。
const appId = "ここにアプリケーションIDをペーストしてください";
const secret = "ここにシークレットキーをペーストしてください";
const createAuthToken = (roomName) => {
const iat = nowInSec();
const exp = iat + 24 * 60 * 60;
return new SkyWayAuthToken({
jti: uuidV4(),
iat,
exp,
version: 3,
scope: {
appId,
turn: { enabled: true }, // TURNは閉域接続プランで提供済みであるためON
analytics: { enabled: false }, // 閉域接続プラン未提供のため明示的にOFF
noiseCancelling: { enabled: false }, // 閉域接続プラン未提供のため明示的にOFF
stt: { enabled: false }, // 閉域接続プラン未提供のため明示的にOFF
rooms: [
{
id: "*",
name: roomName,
methods: ["create", "close", "updateMetadata"],
// SFUを利用する契約: enabled: true
// SFUを利用しない契約: enabled: false (必須)
sfu: { enabled: true, maxSubscribersLimit: 99 },
member: {
id: "*",
name: "*",
methods: ["publish", "subscribe", "updateMetadata"],
},
},
],
},
}).encode(secret);
};❗️ SFU を利用しない契約を選択している場合、
sfu: { enabled: false }に変更してください。trueのままにすると、Room 作成時に SFU サーバーへの接続を試みてエラーとなります。
なお、トークンの詳しい構造については SkyWay Auth Token のドキュメントを参照してください。
初期化処理を置き換える
元ページの「通信処理の追加」章で言及されている joinButton.onclick 内にある以下の行を:
const context = await SkyWayContext.CreateForDevelopment(appId, secret);次のように置き換えてください:
const token = createAuthToken(roomNameInput.value);
const context = await SkyWayContext.Create(token);以降(SkyWayRoom.FindOrCreate 以降)は元ページの手順のまま進めてください。
⚠️ 本チュートリアルでは、簡単のためシークレットキーをブラウザ側の JavaScript に直接埋め込んでトークンを生成しています。実運用ではトークンの発行をサーバー側で行ってください。クライアント側でシークレットキーを保持すると、漏洩する恐れがあります。