SkyWay JS-SDK

このリポジトリは、2023 年 1 月 31 日にリリースされた SkyWay の JavaScript SDK です。旧 SkyWay の JavaScript SDK とは互換性がありません。

本リポジトリの運用方針について

このリポジトリは公開用のミラーリポジトリであり、こちらで開発は行いません。

Issue / Pull Request

受け付けておりません。

Enterprise プランをご契約のお客様はテクニカルサポートをご利用ください。 詳しくはSkyWay サポートをご確認ください。

SDK のインストール方法

NPM を利用する場合

npm がインストールされている環境下で以下のコマンドを実行します

Room ライブラリ

npm install @skyway-sdk/room

Core ライブラリ

npm install @skyway-sdk/core

その他のプラグインやユーティリティライブラリ

npm install @skyway-sdk/sfu-bot
npm install @skyway-sdk/token

CDN を利用する場合

以下のスクリプト要素を HTML に追加します

Room ライブラリ

<script src="https://cdn.jsdelivr.net/npm/@skyway-sdk/room/dist/skyway_room-latest.js"></script>

モジュールはグローバル変数の skyway_room に格納されるので以下のようにモジュールを取得することができます。

const { SkyWayContext, SkyWayStreamFactory, SkyWayRoom } = skyway_room;

ドキュメント

公式サイト

https://skyway.ntt.com/ja/docs/user-guide/javascript-sdk/

API リファレンス

• Room ライブラリ
• Core ライブラリ
• SFU Bot ライブラリ
• Token ライブラリ

環境構築

このリポジトリのサンプルアプリを起動したり、SDK をビルドするために必要な手順。

初期設定時

• Node.js をインストールする（バージョンは v18.12.0 以降）
• corepack を有効化するために次のコマンドを実行する
  • corepack enable npm
• ルートディレクトリで次のコマンドを実行する
  • npm run first
• env.ts.templateをenv.tsにリネームし、ファイル中の appId と secret にダッシュボードで発行した appId と secret を入力する
  • appId と secret の発行方法はこちら

更新時

git で更新を同期した時や packages ディレクトリ以下のソースコードを編集した際にはルートディレクトリで以下のコマンドを実行する必要がある。

npm run compile

サンプルアプリの起動方法

• 環境構築のセクションの作業を実施する

• examples ディレクトリ以下の任意のサンプルアプリのディレクトリに移動する

• そのディレクトリで以下のコマンドを実行する

  • npm run dev

• コマンドを実行するとローカルサーバが起動するので Web ブラウザでアクセスする

SDK のビルド方法

• 環境構築のセクションの作業を実施する
• ルートディレクトリで次のコマンドを実行する
  • npm run build

License

• LICENSE
• THIRD_PARTY_LICENSE