SkyWay JS-SDK

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

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

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

Issue / Pull Request

受け付けておりません。

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

SDK のインストール方法

ユーザアプリケーションで利用する際は NPM と CDN の2通りのインストール方法があります。

NPM を利用する場合

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

npm install @skyway-sdk/room

また、 SkyWay サービスの認証認可に使用する SkyWay Auth Token を生成するユーティリティライブラリをご利用いただく場合は、以下のコマンドを実行します。

npm install @skyway-sdk/token

CDN を利用する場合

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

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

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

const { SkyWayContext, SkyWayStreamFactory, SkyWayRoom } = skyway_room;

また SkyWay Auth Token 用モジュールは次の HTML 記述および グローバル変数 skyway_token より取得することができます。

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

const { SkyWayAuthToken, nowInSec, uuidV4 } = skyway_token;

ドキュメント

公式サイト

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

API リファレンス

• Room ライブラリ
• Token ライブラリ

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

examples 配下にサンプルアプリケーションを同梱しております。

• examples ディレクトリ以下の任意のサンプルアプリのディレクトリに移動する
• そのディレクトリで以下のコマンドを実行する

npm i
npm run dev

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

リポジトリのセットアップ方法(ビルドのための環境構築)

以下はこのリポジトリを用いて利用者自身で SDK をビルドするために必要な手順です。なおこのリポジトリはモノリポジトリ構成であり、依存関係は pnpm の workspace によって管理されています。

初期設定時

• Node.js（バージョンは v24.0.0 以降）および pnpm をインストールする
• corepack を有効化するために次のコマンドを実行する

corepack enable pnpm

• ルートディレクトリで次のコマンドを実行する

pnpm run first

• env.ts.templateをenv.tsにリネームし、ファイル中の appId と secret にダッシュボードで発行した appId と secret を入力する
  • appId と secret の発行方法はこちら

更新時

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

pnpm run compile

SDK のビルド方法

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

pnpm run build

License

• LICENSE
• THIRD_PARTY_LICENSE