` タグ内に以下の内容を追加してください。
```xml
"forward"
"backward"
"left"
"right"
"stop"
```
これで `/cmd_vel_string` トピックに `forward` などの文字列を送信することで、ロボットを操作できるようになります。
以上でSDFファイルの編集は完了です。
## 遠隔操縦画面を作成
Gazebo上でのカメラ等の準備が完了したので、次に SkyWay JavaScript SDK を利用して遠隔操縦画面を作成します。
遠隔操縦画面では、ロボットからの映像を受信して表示し、ボタン操作により操作コマンドを DataStream として送信する機能を実装します。
まずは任意のディレクトリを作り、その中に `index.html` という名前で以下の HTML ファイルを作成します。
```html
room name:
DataStream PublicationId:
controller:
```
次に、`main.js` という名前で以下の JavaScript ファイルを作成します。
```javascript
const {
nowInSec,
SkyWayAuthToken,
SkyWayContext,
SkyWayRoom,
SkyWayStreamFactory,
uuidV4,
} = skyway_room
const appId = "" // SkyWay コンソールから取得したアプリケーションIDを指定してください
const secret = "" // SkyWay コンソールから取得したシークレットキーを指定してください
const token = new SkyWayAuthToken({
jti: uuidV4(),
iat: nowInSec(),
exp: nowInSec() + 60 * 60 * 24,
version: 3,
scope: {
appId: appId,
rooms: [
{
name: "*",
methods: ["create", "close", "updateMetadata"],
member: {
name: "*",
methods: ["publish", "subscribe", "updateMetadata"],
},
},
],
turn: {
enabled: true,
},
},
}).encode(secret)
void (async () => {
const roomNameInput = document.getElementById("room-name")
const joinButton = document.getElementById("join")
const leaveButton = document.getElementById("leave")
const videosArea = document.getElementById("videos")
const dataPublicationIdSpan = document.getElementById("data-publication-id")
const controllerButtons = document.querySelectorAll(".controller-button")
const dataStream = await SkyWayStreamFactory.createDataStream()
controllerButtons.forEach((button) => {
button.onclick = () => {
const command = button.getAttribute("data-type")
dataStream.write(command)
}
})
joinButton.onclick = async () => {
if (roomNameInput.value === "") return
const context = await SkyWayContext.Create(token)
const room = await SkyWayRoom.FindOrCreate(context, {
name: roomNameInput.value,
})
const me = await room.join()
const dataPublication = await me.publish(dataStream, { type: "p2p" })
dataPublicationIdSpan.textContent = dataPublication.id
const subscribeAndAttach = async (publication) => {
if (publication.contentType !== "video") return
const { stream } = await me.subscribe(publication.id)
const newMedia = document.createElement("video")
newMedia.playsInline = true
newMedia.autoplay = true
newMedia.id = `media-${publication.id}`
stream.attach(newMedia)
videosArea.appendChild(newMedia)
}
room.publications.forEach(subscribeAndAttach)
room.onStreamPublished.add((e) => subscribeAndAttach(e.publication))
leaveButton.onclick = async () => {
await me.leave()
await room.dispose()
videosArea.replaceChildren()
}
room.onStreamUnpublished.add((e) => {
document.getElementById(`media-${e.publication.id}`)?.remove()
})
}
})()
```
ファイル内の `` と `` には、SkyWay コンソールから取得したアプリケーションIDとシークレットキーを指定してください。
```javascript
const appId = "" // SkyWay コンソールから取得したアプリケーションIDを指定してください
const secret = "" // SkyWay コンソールから取得したシークレットキーを指定してください
```
ファイルの作成が完了したら、簡易的な Web サーバを起動します。
```bash
python -m http.server 8080
```
ブラウザで `http://localhost:8080` にアクセスすると、下記のような画面が表示されます。
## 実行手順
準備が整ったので、実際に動作させてみましょう。
以下、各種コマンドはGazeboを動かしているホストOS側のシェルまたはDockerコンテナ内のシェル上で実行する形になります。
Dockerコンテナ内のシェルで実行する際は、下記のコマンドを実施した上で実行してください。
```bash
# dockerコンテナ内のシェルを起動
docker compose exec ros bash
# コンテナ内で下記を実行し、skyway_ros_bridgeの環境をセットアップ
source ./install/setup.bash
```
### 1. Gazebo でシミュレーションを起動する
SDF を指定して Gazebo を起動します。
```bash
# ホストOSで下記を実行
gz sim building_robot.sdf
```
起動後、GUI 上で Play ボタンを押してシミュレーションを開始してください。
### 2. Gazebo のカメラ画像を ROS に転送する
Gazebo 側で発行される `/camera/image` と `/fixed_camera/image` を ROSへ転送します。
```bash
# ホストOSで下記を実行
ros2 run ros_gz_image image_bridge /camera/image
```
別のターミナルで下記も実行してください。
```bash
# ホストOSで下記を実行
ros2 run ros_gz_image image_bridge /fixed_camera/image
```
ROS 上に Image トピックが存在していることを確認します。
```bash
# ホストOSで下記を実行
ros2 topic list
```
実行結果として下記のように `/camera/image` と `/fixed_camera/image` トピックが表示されていれば問題ありません。
```
/camera/image
/camera/image/compressed
/camera/image/compressedDepth
/camera/image/theora
/camera/image/zstd
/fixed_camera/image
/fixed_camera/image/compressed
/fixed_camera/image/compressedDepth
/fixed_camera/image/theora
/fixed_camera/image/zstd
```
### 3. skyway_ros_bridge を起動し、SkyWayのRoomに参加する
Dockerコンテナ内のシェル上で `skyway_ros_bridge` を起動します。
```bash
# コンテナ内で下記を実行
ros2 run skyway_ros_bridge skyway
```
別ターミナルでもDockerコンテナ内のシェルで、下記コマンドを実行し、SkyWay の Room に参加します。この時 `` と `` は SkyWay のコンソールから取得したアプリケーションIDとシークレットキーを指定してください。
```bash
# コンテナ内で下記を実行
ros2 service call /join_room skyway_ros_bridge_msgs/srv/JoinRoom "{skyway_app_id: '', skyway_secret_key: '', room_name: 'ros_tutorial'}"
```
### 4. ROS の画像トピックを SkyWay に転送する
ROS 上のカメラ映像を SkyWay の VideoStream として Publish します。
```bash
# コンテナ内で下記を実行
ros2 service call /publish_video_stream_to_skyway_by_image skyway_ros_bridge_msgs/srv/PublishVideoStreamToSkywayByImage "{topic_name: '/camera/image'}"
ros2 service call /publish_video_stream_to_skyway_by_image skyway_ros_bridge_msgs/srv/PublishVideoStreamToSkywayByImage "{topic_name: '/fixed_camera/image'}"
```
### 5. 遠隔操縦ページを開く
Web サーバを起動し、ブラウザで遠隔操縦ページを開きます。
```bash
# ホストOSで下記を実行
python -m http.server 8080
open http://localhost:8080
```
ページ上部のルーム名に `ros_tutorial` join ボタンを押して Room に参加します。
この時点で、Gazebo 上のロボットカメラ映像がブラウザ上に表示されることを確認してください。
### 6. SkyWay の DataStream を ROS に転送する
遠隔操縦ページで操作コマンドを送信できるよう、SkyWay の DataStream を ROS の `/cmd_vel_string` トピックへ転送する設定を行います。
遠隔操縦ページに表示されている `DataStream PublicationId` を下記コマンドの `` 部分に指定し、SkyWay → ROS の転送を開始します。
```bash
# コンテナ内で下記を実行
ros2 service call /publish_data_topic_from_skyway skyway_ros_bridge_msgs/srv/PublishDataTopicFromSkyway "{publication_id: '', topic_name: '/cmd_vel_string'}"
```
### 7. ROS の トピックを Gazebo へ転送する
ここまでの操作で、SkyWay 経由で送信された操作コマンドが ROS の `/cmd_vel_string` トピックに到達するようになりました。
次にROSの `/cmd_vel_string` トピックを Gazebo へ転送します。
```bash
# ホストOSで下記を実行
ros2 run ros_gz_bridge parameter_bridge /cmd_vel_string@std_msgs/msg/String@gz.msgs.StringMsg
```
### 8. 動作確認
遠隔操作ページで操作ボタンを押して、ロボットが動くことを確認してください。
## まとめ
本ページでは、`skyway_ros_bridge`を用いてSkyWayとROSを連携させる方法紹介しました。
今回紹介した機能以外にも、`skyway_ros_bridge`ではSkyWay側の映像をROSに転送したり、ROSからRTP映像入力を制御することも可能です。
今回紹介した機能以外にも、`skyway_ros_bridge`ではSkyWay側の映像をROSに転送する機能や、ROSからRTP映像入力を制御する機能を提供しています。
詳しくは、[skyway_ros_bridgeのREADME.md](https://github.com/skyway/skyway_ros_bridge)をご覧ください。
## 商標
Linux®︎は、米国およびその他の国における Linus Torvalds の登録商標です。
---
## クックブック/Linux SDK/ログの設定を変更する
Path: cookbook_linux-sdk_log-config.md
# ログの設定を変更する
SkyWay Linux®︎ SDK では SDK のログレベルの変更や、出力されるログの取得、WebRTC 通信に関する詳細なログを確認できます。
## SDKのログレベルを変更する
SDK から出力されるログレベルを変更するには、`skyway::Context::Setup` に渡す`skyway::Context::SkyWayOptions` の `log_level` を変更してください。
設定可能なログレベルと説明については、[Linux SDK APIリファレンス](https://linux-sdk.api-reference.skyway.ntt.com/classskyway_1_1global_1_1interface_1_1_logger.html)を参照してください。
以下はログレベルを `TRACE` に設定した場合の例です。
```c++
skyway::Context::SkyWayOptions options{};
// SkyWayのログレベルの設定が行えます。
options.log_level = skyway::global::interface::Logger::kTrace;
skyway::Context::Setup(token, nullptr, options);
```
アプリケーション開発時は、不具合の調査や [SkyWay サポート](https://support.skyway.ntt.com/hc/ja)とのやり取りを円滑に行うために、ログレベルを `TRACE` に設定することをおすすめします。
## SDKのログを取得する
SDK から出力されるログを取得する場合は Logger にイベントリスナーを設定してください。
イベントリスナーは `skyway::global::Logger::Listener` をオーバーライドして実装してください。
イベントリスナーのインターフェースについては [Linux SDK API リファレンス](https://linux-sdk.api-reference.skyway.ntt.com/classskyway_1_1global_1_1_logger_1_1_listener.html)を参照してください。
以下は SDK のログを標準出力するリスナーの例です。
```c++
class LoggerListener : public skyway::global::Logger::Listener {
void OnLog(skyway::global::Logger::Level level, const std::string& text) override {
std::cout << "[" << level << "] " << text << std::endl;
}
};
// 実装したイベントリスナーを登録します。
auto logger_listener = std::make_shared();
skyway::global::Logger::RegisterListener(logger_listener);
```
> **注意**
> 各イベントリスナー内では直接、SkyWayの操作や処理をブロックするような処理は行わないでください。
>
> そのような処理を行う場合は他のスレッドへ処理を移譲してください。
## WebRTCに関するログを表示する
WebRTC 通信による詳細なログを出力する場合は、`skyway::Context::SkyWayOptions` の `enable_webrtc_log` を `true` に設定してください。
```c++
skyway::Context::SkyWayOptions options{};
// WebRTCのログ出力を有効にします。
options.enable_webrtc_log = true;
skyway::Context::Setup(token, nullptr, options);
```
## 商標
Linux®︎は、米国およびその他の国における Linus Torvalds の登録商標です。
---
## クックブック/Linux SDK/LLMを活用した効率的な開発
Path: cookbook_linux-sdk_llms-txt.md
# LLMを活用した効率的な開発
SkyWayの開発者ドキュメントは、llms.txt、およびllms-full.txtをサポートしています。
それぞれ、以下のURLから参照できます。
- https://skyway.ntt.com/llms.txt
- https://skyway.ntt.com/llms-full.txt
---
## クックブック/Room API ／ Channel API/Channel APIからRoom APIへの移行
Path: cookbook_rtc-api-server_migrate-channel-api-to-room-api.md
# Channel APIからRoom APIへの移行
この度、[SkyWay Channel API](/ja/docs/user-guide/rtc-api-server/channel-api) をより便利に拡張したサーバーサイド向け API として、[SkyWay Room API](/ja/docs/user-guide/rtc-api-server/room-api) をリリースしました。
Room API のリリースに伴い、Channel API は非推奨とさせていただきました。
今後は Room API をご利用いただくようお願い致します。
本ドキュメントでは、既に Channel API をご利用いただいている場合における Room API へ移行する手順を、JavaScript のコード例を交えながら説明します。
## Channel API と Room API の違い
Channel API と Room API には、以下のような違いがあります。
**API エンドポイントの違い**
Channel API のエンドポイント
```
https://channel.skyway.ntt.com/v1/json-rpc
```
Room API のエンドポイント
```
https://room.skyway.ntt.com/v1/json-rpc
```
**機能の違い**
|機能|Channel API|Room API|
|---|---|---|
|Room / Channel の作成| ○ | ○ |
|Room / Channel の取得| ○ | ○ |
|Room / Channel の削除| × | ○ |
|Room / Channel 失効時刻の取得| × | ○ |
|Room / Channel から Member を退出させる| × | ○ |
**メソッド名の違い**
|機能|Channel API|Room API|
|---|---|---|
|Room / Channel の作成| `createChannel` | `createRoom` |
|Room / Channel の取得| `findChannel` | `findRoom` |
|Room / Channel の作成および取得| `findOrCreateChannel` | `findOrCreateRoom` |
|Room / Channel の削除| ※ | `closeRoom` |
|Room / Channel から Member を退出させる| ※ | `removeMember` |
※当該機能は提供されておりません
**レスポンスの違い**
|レスポンスの内容|Channel API|Room API|
|---|---|---|
| Member 情報 | `type` や `subtype` を用いた Bot 判定処理などを自前で実装する必要がある | SDK を利用している Member のみが含まれるため、直感的に利用できる |
| Publication 情報 | `originId` などの SFU サーバーに関する情報を考慮する必要がある | SFU サーバーに関する複雑な情報が隠蔽され、直感的に利用できる |
## 移行手順
### 1. API エンドポイントを変更する
まず、アプリケーションサーバー側で呼び出している API エンドポイントを、Channel API のものから Room API のものに変更します。
```javascript
- const url = "https://channel.skyway.ntt.com/v1/json-rpc"
+ const url = "https://room.skyway.ntt.com/v1/json-rpc"
```
### 2. メソッド名を変更する
リクエストに含める `method` パラメータを変更します。
たとえば、Channel API の `findOrCreateChannel` メソッドを利用していた箇所は、`findOrCreateRoom` メソッドを利用するようにします。
```javascript
const response = await fetch(url, {
method: "POST",
headers: {
"Content-Type": "application/json",
Authorization: `Bearer ${createSkyWayAdminAuthToken()}`,
},
body: JSON.stringify({
jsonrpc: "2.0",
id: uuidV4(),
// メソッド名を変更する
- method: "findOrCreateChannel",
+ method: "findOrCreateRoom",
params: {
name: roomName,
},
}),
});
```
### 3. レスポンスの参照先を変更する
Channel API は `result.channel` を返しますが、Room API は `result.room` を返します。
そのため、取得したレスポンスの参照先を変更します。
```javascript
const {
result: {
// レスポンスの参照先を変更する
- channel: {
+ room: {
id: roomId
},
},
} = await response.json();
```
### 4. SFU Bot を前提とした処理を見直す
SFU サーバーもメディア通信を実施するため、SkyWay では 1 つの Member とみなして通信します。
そのため、SkyWay Core ライブラリでは、SFU Bot という特殊な Member を Channel 内に Join させることによって SFU サーバーを利用します。
Room API のレスポンスでは、この SFU Bot が隠蔽されているため、Channel API より直感的にご利用いただけます。
**Member に対する処理**
Channel API のレスポンスでは、`Members` オブジェクトに SFU Bot が含まれます。
したがって、Member から SDK を利用しているクライアントのみ抽出する場合などにおいて、SFU Bot を `Member.type` プロパティで判定して除外するといった特別な考慮が必要でした。
```javascript
// `fetchedChannel` には Channel API レスポンスから取得した Channel 情報が代入されている
const persons = fetchedChannel.members.filter(
(member) => member.type !== "Bot",
);
```
Room API のレスポンスでは SFU Bot が隠蔽されているため、上記のような処理を自前で実装する必要がありません。
```javascript
// `fetchedRoom` には Room API レスポンスから取得した Room 情報が代入されている
const persons = fetchedRoom.members;
```
**Publication に対する処理**
SFU を利用する場合、通常多くのアプリケーションでは中継後の Publication に関心があります。
しかし、Channel API のレスポンスは以下に示すオブジェクトのような構造になっており、SFU サーバーに中継される前後の Publication が両方含まれます。
```javascript
// fetchedChannel.publications
[
{
id: '8fd19070-3dfb-4840-aaa8-d967a8c196dd',
publisherId: 'cccccf82-fa06-4d59-b80e-ef07200b6bf4',
contentType: 'VIDEO',
isEnabled: true,
type: 'SFU'
},
{
id: '53af7758-64dc-4238-a79c-5a69bb3cded8',
publisherId: '212548ac-af5b-41b1-ac1e-c44288c2bcc9',
contentType: 'VIDEO',
originId: '8fd19070-3dfb-4840-aaa8-d967a8c196dd',
originPublisherId: 'cccccf82-fa06-4d59-b80e-ef07200b6bf4',
isEnabled: true,
type: 'SFU'
}
]
```
したがって、中継後の Publication を抽出する場合などでは、処理を自前で実装する必要がありました。
```javascript
const sfuPublications = fetchedChannel.publications.filter(
(publication) => publication.type === "SFU" && publication.originId != null,
);
```
一方で、Room API のレスポンスでは SFU サーバーによる中継前の Publication が隠蔽されます。
そのため、SFU 経由の Publication を容易に扱うことが可能です。
```javascript
const sfuPublications = fetchedRoom.publications.filter(
(publication) => publication.type === "SFU"
);
```
## Room API の新機能を活用する
Room API には Channel API で提供されていない機能も存在します。
ぜひご活用ください。
**Room を削除する**
Room API では、`closeRoom` メソッドが提供されています。
[Webhook 機能](/ja/docs/user-guide/webhook/overview/)と連携し、Member が 0 人になったことを契機として Room を削除するなどの用途でご活用いただけます。
**指定した Member を強制的に退出させる**
`removeMember` メソッドは、アプリケーション側の退出処理と連動して SkyWay の Room からもメンバーを強制退出させたい場合に有効です。
退出済みユーザーの残留を防ぎ、盗聴リスクを低減したい場合などにご活用いただけます。
**Room の失効時刻を取得する**
`findRoom` メソッドのレスポンスに含まれる `result.room.expiresAt` プロパティは、Room の失効時刻を ISO 8601 形式で表しています。
失効が迫っている Room に代わる新しい Room を `createRoom` メソッドで作成する場合などにご活用いただけます。
## 関連ドキュメント
- [Channel API の概要](/ja/docs/user-guide/rtc-api-server/channel-api)
- [Channel API リファレンス](/ja/docs/api-reference/rtc-api-server/channel-api)
- [Room API の概要](/ja/docs/user-guide/rtc-api-server/room-api)
- [Room API リファレンス](/ja/docs/api-reference/rtc-api-server/room-api)
---
## APIリファレンス/JavaScript SDK
Path: api-reference_javascript-sdk.md
# JavaScript SDK
- [Room ライブラリ](https://javascript-sdk.api-reference.skyway.ntt.com/room)
- [Token ライブラリ](https://javascript-sdk.api-reference.skyway.ntt.com/token)
# JavaScript SDK と連携可能なライブラリ
- [AI Noise Canceller](https://javascript-sdk.api-reference.skyway.ntt.com/ai-noise-canceller)
- [バーチャル背景と背景ぼかし処理](https://github.com/skyway/skyway-video-processors/tree/main#api)
- [STT Client](https://javascript-sdk.api-reference.skyway.ntt.com/stt-client)
---
## APIリファレンス/iOS SDK
Path: api-reference_ios-sdk.md
# iOS SDK
- [Room ライブラリ](https://ios-sdk.api-reference.skyway.ntt.com/room)
# iOS SDK と連携可能なライブラリ
- [AI Noise Canceller ライブラリ](https://ios-sdk.api-reference.skyway.ntt.com/ai-noise-canceller)
---
## APIリファレンス/Android SDK
Path: api-reference_android-sdk.md
# Android SDK
- [Room ライブラリ](https://android-sdk.api-reference.skyway.ntt.com/room)
# Android SDK と連携可能なライブラリ
- [AI Noise Canceller ライブラリ](https://android-sdk.api-reference.skyway.ntt.com/ai-noise-canceller)
---
## APIリファレンス/Linux SDK
Path: api-reference_linux-sdk.md
# Linux®︎ SDK
- [Room ライブラリ](https://linux-sdk.api-reference.skyway.ntt.com/)
## 商標
Linux®︎は、米国およびその他の国における Linus Torvalds の登録商標です。
---
## APIリファレンス/Unity SDK
Path: api-reference_unity-sdk.md
# Unity SDK
- [Room ライブラリ](https://unity-sdk.api-reference.skyway.ntt.com/)
---
## APIリファレンス/Room API ／ Channel API/Room API
Path: api-reference_rtc-api-server_room-api.md
# SkyWay Room API
SkyWay Room API は、SkyWay の Room に対する操作を実行するサーバーサイド向け API です。
API は [JSON-RPC 2.0](https://www.jsonrpc.org/specification) に準拠しています。
> 類似するサーバーサイド向け API として [SkyWay Channel API](/ja/docs/api-reference/rtc-api-server/channel-api) を提供しておりますが、現在は非推奨です。
> SkyWay Room API をご利用ください。
## API エンドポイント
```
https://room.skyway.ntt.com/v1/json-rpc
```
HTTP `POST` メソッドでリクエストを行なってください。
## 認証
リクエストの Authorization ヘッダーに SkyWay Admin Auth Token を入れる必要があります。
`YOUR_SKYWAY_ADMIN_AUTH_TOKEN` は生成した SkyWay Admin Auth Token で置き換えてください。
```
Authorization: Bearer YOUR_SKYWAY_ADMIN_AUTH_TOKEN
```
SkyWay Admin Auth Token の詳細については [SkyWay Admin Auth Token のドキュメント](/ja/docs/user-guide/authentication/skyway-admin-auth-token/)を参照してください。
## エラーレスポンスについて
エラーレスポンスのレスポンスボディに含まれる `error.code` は [JSON-RPC 2.0](https://www.jsonrpc.org/specification) の Error object で定義されているエラーコードのほか、SkyWay Room API として以下のコードを定義しています。
|code|説明|
|---|---|
|401|SkyWay Admin Auth Token が不正な場合|
|404|リソースが見つからなかった場合|
|409|すでにリソースが存在する場合|
|429|Free プランをご利用のプロジェクトで
月次の接続回数制限を超過している場合|
|429|リクエストのレートリミットを超過した場合|
以下のエラーレスポンスは、実行する Room API のメソッドに関わらず共通して発生し得る異常ケースです。
- SkyWay Admin Auth Token が不正な場合のレスポンスボディ
```json
{
"jsonrpc": "2.0",
"id": 0,
"error": {
"code": 401,
"message": "Verify admin token failed"
}
}
```
- Free プランをご利用のプロジェクトで月次の接続回数制限※を超過している場合のレスポンスボディ
```json
{
"jsonrpc": "2.0",
"id": 0,
"error": {
"code": 429,
"message": "Project usage limit has been exceeded"
}
}
```
※接続回数の上限は[「プランの詳細」ページの「接続料」](https://skyway.ntt.com/ja/pricing/#plan)をご確認ください。
- リクエストのレートリミット※を超過した場合のレスポンスボディ
```json
{
"jsonrpc": "2.0",
"id": 0,
"error": {
"code": 429,
"message": "exceeded rate limit",
}
}
```
※リクエストレートの制限に関する詳細は[「割り当てと制限」ページの「リクエストレートの制限」セクション](/ja/docs/user-guide/commons/quotas-and-limits)をご確認ください。
- リクエストボディの id プロパティが文字列もしくは整数以外の場合のレスポンスボディ
```json
{
"jsonrpc": "2.0",
"id": null,
"error": {
"code": -32600,
"message": "Request 'id' must be a string or integer",
}
}
```
## findRoom
id または name から Room を取得します。
id と name の両方が指定された場合は id に基づいて Room を取得します。
### リクエストボディ
リクエストボディ
|プロパティ|形式|必須|説明|
|---|---|---|---|
|jsonrpc|string|️✔|`2.0` を指定する|
|id|string \| integer|✔|任意の値を指定する。レスポンスボディにはリクエストボディで指定した id の値が入る|
|method|string|✔|`findRoom` を指定する|
|params|object|✔|Room の id または name を指定する（id あるいは name のいずれかは必須）|
params プロパティの構造
|プロパティ|形式|必須|説明|
|---|---|---|---|
|id|string (UUID v4)||Room の id を指定する|
|name|string||Room の name を指定する|
例 1. id `6abbecae-dd86-4e8b-ab9f-8da2c7740ddc` の Room を取得する場合のリクエストボディ
```json
{
"jsonrpc": "2.0",
"id": 0,
"method": "findRoom",
"params": {
"id": "6abbecae-dd86-4e8b-ab9f-8da2c7740ddc"
}
}
```
例 2. name `sample-room` の Room を取得する場合のリクエストボディ
```json
{
"jsonrpc": "2.0",
"id": 0,
"method": "findRoom",
"params": {
"name": "sample-room"
}
}
```
### レスポンスボディ
#### 正常系
レスポンスボディ
|プロパティ|形式|必須|説明|
|---|---|---|---|
|jsonrpc|string|️✔|`2.0` が入る|
|id|string \| integer|✔|リクエストボディで指定した id の値が入る|
|result|object|✔||
|result.room|Room|✔|Room 情報を表すオブジェクト|
Room オブジェクト
|プロパティ|形式|必須|説明|
|---|---|---|---|
|id|string (UUID v4)|️✔|Room を一意に特定する値|
|name|string||アプリケーション内で Room を一意に特定する値|
|expiresAt|string|✔|Room の失効時刻（ISO 8601 形式）|
|members|Member[]|✔|Member 情報を表すオブジェクトの配列|
|publications|Publication[]|✔|Publication 情報を表すオブジェクトの配列|
|subscriptions|Subscription[]|✔|Subscription 情報を表すオブジェクトの配列|
|metadata|string|||
Member オブジェクト
|プロパティ|形式|必須|説明|
|---|---|---|---|
|id|string (UUID v4)|️✔|Member を一意に特定する値|
|name|string||Room 内で Member を一意に特定する値|
|metadata|string|||
Publication オブジェクト
|プロパティ|形式|必須|説明|
|---|---|---|---|
|id|string (UUID v4)|️✔|Publication を一意に特定する値|
|publisher|Publisher|✔|Publish している Member の情報|
|contentType|string|✔|`AUDIO`、`VIDEO` または `DATA` が入る|
|isEnabled|boolean|✔|Publication が有効の場合 `true`、そうでなければ `false` が入る|
|type|string|✔|`P2P` または `SFU` が入る|
|metadata|string|||
Publisher オブジェクト
|プロパティ|形式|必須|説明|
|---|---|---|---|
|id|string (UUID v4)|️✔|Publisher の Member id|
|name|string||Publisher の Member name|
Subscription オブジェクト
|プロパティ|形式|必須|説明|
|---|---|---|---|
|id|string (UUID v4)|️✔|Subscription を一意に特定する値|
|publicationId|string (UUID v4)|️✔|subscribe している Publication の id|
|subscriber|Subscriber|✔|subscribe している Member の情報|
Subscriber オブジェクト
|プロパティ|形式|必須|説明|
|---|---|---|---|
|id|string (UUID v4)|️✔|Subscriber の Member id|
|name|string||Subscriber の Member name|
例
```json
{
"jsonrpc": "2.0",
"id": 0,
"result": {
"room": {
"id": "6abbecae-dd86-4e8b-ab9f-8da2c7740ddc",
"name": "sample-room",
"expiresAt": "2025-11-25T12:34:56Z",
"members": [
{
"id": "1adee02b-811d-4a79-b07d-cdcb1437c7c3",
"name": "user01",
"metadata": "publisher"
},
{
"id": "504ac623-7880-49b5-855f-aa73856ae5e7",
"name": "user02",
"metadata": "subscriber"
}
],
"publications": [
{
"id": "aa63b6d1-c1c5-447b-b7ea-faebe70a8b11",
"contentType": "VIDEO",
"isEnabled": true,
"type": "SFU",
"publisher": {
"id": "1adee02b-811d-4a79-b07d-cdcb1437c7c3",
"name": "user01"
}
},
{
"id": "7b213f12-42ba-40f2-9b36-9eb967d263d6",
"contentType": "DATA",
"isEnabled": true,
"type": "P2P",
"publisher": {
"id": "1adee02b-811d-4a79-b07d-cdcb1437c7c3",
"name": "user01"
}
}
],
"subscriptions": [
{
"id": "be35b8dc-bcc3-4005-bf2a-b4d52d51f2db",
"publicationId": "aa63b6d1-c1c5-447b-b7ea-faebe70a8b11",
"subscriber": {
"id": "504ac623-7880-49b5-855f-aa73856ae5e7",
"name": "user02"
}
},
{
"id": "4fcef9c1-3f7a-4287-92de-332c2baf3ce6",
"publicationId": "7b213f12-42ba-40f2-9b36-9eb967d263d6",
"subscriber": {
"id": "504ac623-7880-49b5-855f-aa73856ae5e7",
"name": "user02"
}
}
]
}
}
}
```
#### 異常系
例 1. 指定した id の Room が存在しなかった場合のレスポンスボディ
```json
{
"jsonrpc": "2.0",
"id": 0,
"error": {
"code": 404,
"message": "Room '6abbecae-dd86-4e8b-ab9f-8da2c7740ddc' not found"
}
}
```
例 2. 指定した name の Room が存在しなかった場合のレスポンスボディ
```json
{
"jsonrpc": "2.0",
"id": 0,
"error": {
"code": 404,
"message": "Room with name 'sample-room' not found"
}
}
```
例 3. Room の id および name がどちらも指定されていない場合
```json
{
"jsonrpc": "2.0",
"id": 0,
"error": {
"code": -32602,
"message": "'id' or 'name' must be specified",
},
}
```
## createRoom
Room を新規作成します。作成時に name や metadata を指定することができます。
### リクエストボディ
リクエストボディ
|プロパティ|形式|必須|説明|
|---|---|---|---|
|jsonrpc|string|️✔|`2.0` を指定する|
|id|string \| integer|✔|任意の値を指定する。レスポンスボディにはリクエストボディで指定した id の値が入る|
|method|string|✔|`createRoom` を指定する|
|params|object|✔|Room の name および metadata を指定できる|
params プロパティの構造
|プロパティ|形式|必須|説明|
|---|---|---|---|
|name|string||Room の name を指定する。アプリケーション内で一意である必要がある|
|metadata|string||Room の metadata を指定する|
例 1. `sample-room` という name を指定して Room を作成する場合のリクエストボディ
```json
{
"jsonrpc": "2.0",
"id": 0,
"method": "createRoom",
"params": {
"name": "sample-room"
}
}
```
例 2. name を指定しないで Room を作成する場合のリクエストボディ
```json
{
"jsonrpc": "2.0",
"id": 0,
"method": "createRoom",
"params": {}
}
```
### レスポンスボディ
#### 正常系
レスポンスボディ
|プロパティ|形式|必須|説明|
|---|---|---|---|
|jsonrpc|string|️✔|`2.0` が入る|
|id|string \| integer|✔|リクエストボディで指定した id の値が入る|
|result|object|✔||
|result.room|Room|✔|Room 情報を表すオブジェクト|
Room オブジェクト
|プロパティ|形式|必須|説明|
|---|---|---|---|
|id|string (UUID v4)|️✔|Room を一意に特定する値|
|name|string||アプリケーション内で Room を一意に特定する値|
|metadata|string|||
例
```json
{
"jsonrpc": "2.0",
"id": 0,
"result": {
"room": {
"id": "6abbecae-dd86-4e8b-ab9f-8da2c7740ddc",
"name": "sample-room"
}
},
}
```
#### 異常系
例 1. 指定した name の Room がすでに存在していた場合のレスポンスボディ
```json
{
"jsonrpc": "2.0",
"id": 0,
"error": {
"code": 409,
"message": "Room with name 'sample-room' already exists"
}
}
```
## findOrCreateRoom
指定された name の Room が存在すればその Room 情報を取得し、そうでなければ新規作成します。
### リクエストボディ
リクエストボディ
|プロパティ|形式|必須|説明|
|---|---|---|---|
|jsonrpc|string|️✔|`2.0` を指定する|
|id|string \| integer|✔|任意の値を指定する。レスポンスボディにはリクエストボディで指定した id の値が入る|
|method|string|✔|`findOrCreateRoom` を指定する|
|params|object|✔|Room の name および metadata を指定する（name は必須）|
params プロパティの構造
|プロパティ|形式|必須|説明|
|---|---|---|---|
|name|string|✔|Room の name を指定する|
|metadata|string||Room の metadata を指定する|
例
```json
{
"jsonrpc": "2.0",
"id": 0,
"method": "findOrCreateRoom",
"params": {
"name": "sample-room"
}
}
```
### レスポンスボディ
#### 正常系
レスポンスボディ
|プロパティ|形式|必須|説明|
|---|---|---|---|
|jsonrpc|string|️✔|`2.0` が入る|
|id|string \| integer|✔|リクエストボディで指定した id の値が入る|
|result|object|✔||
|result.room|Room|✔|Room 情報を表すオブジェクト|
Room オブジェクト
|プロパティ|形式|必須|説明|
|---|---|---|---|
|id|string (UUID v4)|️✔|Room を一意に特定する値|
|name|string||アプリケーション内で Room を一意に特定する値|
|expiresAt|string|✔|Room の失効時刻（ISO 8601 形式）|
|members|Member[]|✔|Member 情報を表すオブジェクトの配列|
|publications|Publication[]|✔|Publication 情報を表すオブジェクトの配列|
|subscriptions|Subscription[]|✔|Subscription 情報を表すオブジェクトの配列|
|metadata|string|||
Member オブジェクト
|プロパティ|形式|必須|説明|
|---|---|---|---|
|id|string (UUID v4)|️✔|Member を一意に特定する値|
|name|string||Room 内で Member を一意に特定する値|
|metadata|string|||
Publication オブジェクト
|プロパティ|形式|必須|説明|
|---|---|---|---|
|id|string (UUID v4)|️✔|Publication を一意に特定する値|
|publisher|Publisher|✔|Publish している Member の情報|
|contentType|string|✔|`AUDIO`、`VIDEO` または `DATA` が入る|
|isEnabled|boolean|✔|Publication が有効の場合 `true`、そうでなければ `false` が入る|
|type|string|✔|`P2P` または `SFU` が入る|
|metadata|string|||
Publisher オブジェクト
|プロパティ|形式|必須|説明|
|---|---|---|---|
|id|string (UUID v4)|️✔|Publisher の Member id|
|name|string||Publisher の Member name|
Subscription オブジェクト
|プロパティ|形式|必須|説明|
|---|---|---|---|
|id|string (UUID v4)|️✔|Subscription を一意に特定する値|
|publicationId|string (UUID v4)|️✔|subscribe している Publication の id|
|subscriber|Subscriber|✔|subscribe している Member の情報|
Subscriber オブジェクト
|プロパティ|形式|必須|説明|
|---|---|---|---|
|id|string (UUID v4)|️✔|Subscriber の Member id|
|name|string||Subscriber の Member name|
例
```json
{
"jsonrpc": "2.0",
"id": 0,
"result": {
"room": {
"id": "6abbecae-dd86-4e8b-ab9f-8da2c7740ddc",
"name": "sample-room",
"expiresAt": "2025-11-25T12:34:56Z",
"members": [
{
"id": "1adee02b-811d-4a79-b07d-cdcb1437c7c3",
"name": "user01",
"metadata": "publisher"
},
{
"id": "504ac623-7880-49b5-855f-aa73856ae5e7",
"name": "user02",
"metadata": "subscriber"
}
],
"publications": [
{
"id": "aa63b6d1-c1c5-447b-b7ea-faebe70a8b11",
"contentType": "VIDEO",
"isEnabled": true,
"type": "SFU",
"publisher": {
"id": "1adee02b-811d-4a79-b07d-cdcb1437c7c3",
"name": "user01"
}
},
{
"id": "7b213f12-42ba-40f2-9b36-9eb967d263d6",
"contentType": "DATA",
"isEnabled": true,
"type": "P2P",
"publisher": {
"id": "1adee02b-811d-4a79-b07d-cdcb1437c7c3",
"name": "user01"
}
}
],
"subscriptions": [
{
"id": "be35b8dc-bcc3-4005-bf2a-b4d52d51f2db",
"publicationId": "aa63b6d1-c1c5-447b-b7ea-faebe70a8b11",
"subscriber": {
"id": "504ac623-7880-49b5-855f-aa73856ae5e7",
"name": "user02"
}
},
{
"id": "4fcef9c1-3f7a-4287-92de-332c2baf3ce6",
"publicationId": "7b213f12-42ba-40f2-9b36-9eb967d263d6",
"subscriber": {
"id": "504ac623-7880-49b5-855f-aa73856ae5e7",
"name": "user02"
}
}
]
}
}
}
```
#### 異常系
例 1. Room の name が指定されていない場合のレスポンスボディ
```json
{
"jsonrpc": "2.0",
"id": 0,
"error": {
"code": -32602,
"message": "Parameter must have required property 'name'",
}
}
```
## closeRoom
id または name で指定した Room を削除します。
id と name の両方が指定された場合は id に基づいて Room を削除します。
### リクエストボディ
リクエストボディ
|プロパティ|形式|必須|説明|
|---|---|---|---|
|jsonrpc|string|️✔|`2.0` を指定する|
|id|string \| integer|✔|任意の値を指定する。レスポンスボディにはリクエストボディで指定した id の値が入る|
|method|string|✔|`closeRoom` を指定する|
|params|object|✔|Room の id または name を指定する（id あるいは name のいずれかは必須）|
params プロパティの構造
|プロパティ|形式|必須|説明|
|---|---|---|---|
|id|string (UUID v4)||Room の id を指定する|
|name|string||Room の name を指定する|
例 1. id `6abbecae-dd86-4e8b-ab9f-8da2c7740ddc` の Room を削除する場合のリクエストボディ
```json
{
"jsonrpc": "2.0",
"id": 0,
"method": "closeRoom",
"params": {
"id": "6abbecae-dd86-4e8b-ab9f-8da2c7740ddc"
}
}
```
例 2. name `sample-room` の Room を削除する場合のリクエストボディ
```json
{
"jsonrpc": "2.0",
"id": 0,
"method": "closeRoom",
"params": {
"name": "sample-room"
}
}
```
### レスポンスボディ
#### 正常系
レスポンスボディ
|プロパティ|形式|必須|説明|
|---|---|---|---|
|jsonrpc|string|️✔|`2.0` が入る|
|id|string \| integer|✔|リクエストボディで指定した id の値が入る|
|result|object|✔||
例
```json
{
"jsonrpc": "2.0",
"id": 0,
"result": {}
}
```
#### 異常系
例 1. 指定した id の Room が存在しなかった場合のレスポンスボディ
```json
{
"jsonrpc": "2.0",
"id": 0,
"error": {
"code": 404,
"message": "Room '6abbecae-dd86-4e8b-ab9f-8da2c7740ddc' not found"
}
}
```
例 2. 指定した name の Room が存在しなかった場合のレスポンスボディ
```json
{
"jsonrpc": "2.0",
"id": 0,
"error": {
"code": 404,
"message": "Room with name 'sample-room' not found"
}
}
```
例 3. Room の id および name がどちらも指定されていない場合
```json
{
"jsonrpc": "2.0",
"id": 0,
"error": {
"code": -32602,
"message": "'id' or 'name' must be specified",
},
}
```
## removeMember
id または name で指定した特定の Member を削除します。
id と name の両方が指定された場合は id に基づいて Member を削除します。
### リクエストボディ
リクエストボディ
|プロパティ|形式|必須|説明|
|---|---|---|---|
|jsonrpc|string|️✔|`2.0` を指定する|
|id|string \| integer|✔|任意の値を指定する。レスポンスボディにはリクエストボディで指定した id の値が入る|
|method|string|✔|`removeMember` を指定する|
|params|object|✔|Room および Member を指定する|
params プロパティの構造
|プロパティ|形式|必須|説明|
|---|---|---|---|
|room|object|✔|Room の id または name を指定する（id あるいは name のいずれかは必須）|
room プロパティの構造
|プロパティ|形式|必須|説明|
|---|---|---|---|
|id|string||Room の id を指定する|
|name|string||Room の name を指定する|
|member|object|✔|Member の id または name を指定する（id あるいは name のいずれかは必須）|
member プロパティの構造
|プロパティ|形式|必須|説明|
|---|---|---|---|
|id|string||Member の id を指定する|
|name|string||Member の name を指定する|
例 1. id `6abbecae-dd86-4e8b-ab9f-8da2c7740ddc` の Room から、id `1adee02b-811d-4a79-b07d-cdcb1437c7c3` の Member を削除する場合のリクエストボディ
```json
{
"jsonrpc": "2.0",
"id": 0,
"method": "removeMember",
"params": {
"room": {
"id": "6abbecae-dd86-4e8b-ab9f-8da2c7740ddc",
"member": {
"id": "1adee02b-811d-4a79-b07d-cdcb1437c7c3"
}
}
}
}
```
例 2. id `6abbecae-dd86-4e8b-ab9f-8da2c7740ddc` の Room から、name `user01` の Member を削除する場合のリクエストボディ
```json
{
"jsonrpc": "2.0",
"id": 0,
"method": "removeMember",
"params": {
"room": {
"id": "6abbecae-dd86-4e8b-ab9f-8da2c7740ddc",
"member": {
"name": "user01"
}
}
}
}
```
例 3. name `sample-room` の Room から、id `1adee02b-811d-4a79-b07d-cdcb1437c7c3` の Member を削除する場合のリクエストボディ
```json
{
"jsonrpc": "2.0",
"id": 0,
"method": "removeMember",
"params": {
"room": {
"name": "sample-room",
"member": {
"id": "1adee02b-811d-4a79-b07d-cdcb1437c7c3"
}
}
}
}
```
例 4. name `sample-room` の Room から、name `user01` の Member を削除する場合のリクエストボディ
```json
{
"jsonrpc": "2.0",
"id": 0,
"method": "removeMember",
"params": {
"room": {
"name": "sample-room",
"member": {
"name": "user01"
}
}
}
}
```
### レスポンスボディ
#### 正常系
レスポンスボディ
|プロパティ|形式|必須|説明|
|---|---|---|---|
|jsonrpc|string|️✔|`2.0` が入る|
|id|string \| integer|✔|リクエストボディで指定した id の値が入る|
|result|object|✔||
例
```json
{
"jsonrpc": "2.0",
"id": 0,
"result": {}
}
```
#### 異常系
例 1. 指定した id の Room が存在しなかった場合のレスポンスボディ
```json
{
"jsonrpc": "2.0",
"id": 0,
"error": {
"code": 404,
"message": "Room '6abbecae-dd86-4e8b-ab9f-8da2c7740ddc' not found"
}
}
```
例 2. 指定した name の Room が存在しなかった場合のレスポンスボディ
```json
{
"jsonrpc": "2.0",
"id": 0,
"error": {
"code": 404,
"message": "Room with name 'sample-room' not found"
}
}
```
例 3. Room の id および name がどちらも指定されていない場合
```json
{
"jsonrpc": "2.0",
"id": 0,
"error": {
"code": -32602,
"message": "Room 'id' or 'name' must be specified"
},
}
```
例 4. 指定した id の Member が存在しなかった場合のレスポンスボディ
```json
{
"jsonrpc": "2.0",
"id": 0,
"error": {
"code": 404,
"message": "Member '1adee02b-811d-4a79-b07d-cdcb1437c7c3' not found"
}
}
```
例 5. 指定した name の Member が存在しなかった場合のレスポンスボディ
```json
{
"jsonrpc": "2.0",
"id": 0,
"error": {
"code": 404,
"message": "Member with name 'user01' not found"
}
}
```
例 6. Member の id および name がどちらも指定されていない場合
```json
{
"jsonrpc": "2.0",
"id": 0,
"error": {
"code": -32602,
"message": "Member 'id' or 'name' must be specified"
},
}
```
---
## APIリファレンス/Recording API
Path: api-reference_recording-api.md
# Recording API
- [SkyWay Recording API](https://recording.api-reference.skyway.ntt.com)
---
## APIリファレンス/AI Noise Canceller
Path: api-reference_ai-noise-canceller.md
# SkyWay AI Noise Canceller
- [JavaScript版](https://javascript-sdk.api-reference.skyway.ntt.com/ai-noise-canceller)
- [iOS版](https://ios-sdk.api-reference.skyway.ntt.com/ai-noise-canceller/)
- [Android版](https://android-sdk.api-reference.skyway.ntt.com/ai-noise-canceller/)
---
## APIリファレンス/文字起こし β版
Path: api-reference_stt.md
# 文字起こし β版
- [SkyWay Speech to Text API](https://speech-to-text.api-reference.skyway.ntt.com/api-reference)
- [STT Client](https://javascript-sdk.api-reference.skyway.ntt.com/stt-client)
---
## APIリファレンス/Room API ／ Channel API/Channel API (非推奨)
Path: api-reference_rtc-api-server_channel-api.md
# SkyWay Channel API
SkyWay Channel API は、SkyWay の Channel の作成と取得を行うことができるサーバーサイド向けの API です。API は [JSON-RPC 2.0](https://www.jsonrpc.org/specification) に準拠しています。
> 類似するサーバーサイド向け API である [SkyWay Room API](/ja/docs/api-reference/rtc-api-server/room-api) のリリースに伴い、SkyWay Channel API は非推奨とさせていただきました。今後は SkyWay Room API をご利用ください。
>
> SkyWay Channel API から SkyWay Room API への移行については[移行ドキュメント](/ja/docs/cookbook/rtc-api-server/migrate-channel-api-to-room-api/)をご参照ください。
## API エンドポイント
```
https://channel.skyway.ntt.com/v1/json-rpc
```
HTTP `POST` メソッドでリクエストを行ってください。
## 認証
リクエストの Authorization ヘッダーに SkyWay Admin Auth Token を入れる必要があります。`YOUR_SKYWAY_ADMIN_AUTH_TOKEN` は生成した SkyWay Admin Auth Token で置き換えてください。
```
Authorization: Bearer YOUR_SKYWAY_ADMIN_AUTH_TOKEN
```
SkyWay Admin Auth Token の詳細については [SkyWay Admin Auth Token のドキュメント](/ja/docs/user-guide/authentication/skyway-admin-auth-token/)を参照してください。
## エラーレスポンスについて
エラーレスポンスのレスポンスボディに含まれる `error.code` は [JSON-RPC 2.0](https://www.jsonrpc.org/specification) の Error object で定義されているエラーコードのほか、SkyWay Channel API として以下のコードを定義しています。
|code|説明|
|---|---|
|401| SkyWay Admin Auth Token が不正な場合|
|404| リソースが見つからなかった場合|
|409| すでにリソースが存在する場合|
|429| Free プランをご利用のプロジェクトで
月次の接続回数制限を超過している場合|
## findChannel
id または name から Channel を取得します。id と name の両方が指定された場合は id によって Channel を取得します。
### リクエストボディ
|プロパティ|形式|必須|説明|
|---|---|---|---|
|jsonrpc|string|️✔|`2.0` を指定する|
|id|string \| integer |✔| 任意の値を指定する。レスポンスボディにはリクエストボディで指定した id の値が入る |
|method|string|✔|`findChannel` を指定する|
|params|object|✔|Channel の id または name を指定する（id あるいは name のいずれかは必須）|
|params.id|string (UUID v4) ||Channel の id を指定する|
|params.name|string||Channel の name を指定する|
例 1. id `7e19cb20-fc79-4d2f-bf29-d498ff76299a` の Channel を id から取得する場合のリクエストボディ
```json
{
"jsonrpc": "2.0",
"id": 0,
"method": "findChannel",
"params": {
"id": "7e19cb20-fc79-4d2f-bf29-d498ff76299a"
}
}
```
例 2. name `sample-channel` の Channel を name から取得する場合のリクエストボディ
```json
{
"jsonrpc": "2.0",
"id": 0,
"method": "findChannel",
"params": {
"name": "sample-channel"
}
}
```
### レスポンスボディ
#### 正常系
レスポンスボディ
|プロパティ|形式|必須|説明|
|---|---|---|---|
|jsonrpc|string|️✔|`2.0` が入る|
|id|string \| integer |✔| リクエストボディで指定した id の値が入る |
|result|object|✔||
|result.channel|Channel|✔|Channel 情報を表すオブジェクト|
Channel オブジェクト
|プロパティ|形式|必須|説明|
|---|---|---|---|
|id|string (UUID v4)|️✔|Channel を一意に特定する値|
|name|string ||アプリケーション内で Channel を一意に特定する値|
|members|Member[]|✔|Member 情報を表すオブジェクトの配列|
|publications|Publication[]|✔|Publication 情報を表すオブジェクトの配列|
|subscriptions|Subscription[]|✔|Subscription 情報を表すオブジェクトの配列|
|metadata|string|||
Member オブジェクト
|プロパティ|形式|必須|説明|
|---|---|---|---|
|id|string (UUID v4)|️✔|Member を一意に特定する値|
|name|string ||Channel 内で Member を一意に特定する値|
|type|string|✔|`person` または `bot` が入る|
|subtype|string||`SFU` が入る|
|metadata|string|||
Publication オブジェクト
|プロパティ|形式|必須|説明|
|---|---|---|---|
|id|string (UUID v4)|️✔|Publication を一意に特定する値|
|publisherId|string (UUID v4)|️✔|publish している Member の id|
|contentType|string |✔|`AUDIO`、`VIDEO` または `DATA` が入る|
|isEnabled|boolean|✔|Publication が有効の場合 `true`、そうでなければ `false` が入る|
|originId|string||forwarding されている Publication の id|
|originPublisherId|string||forwarding されている Publication を publish している Member の id|
|metadata|string|||
|type|string||`P2P` または `SFU` が入る|
Subscription オブジェクト
|プロパティ|形式|必須|説明|
|---|---|---|---|
|id|string (UUID v4)|️✔|Subscription を一意に特定する値|
|publicationId|string (UUID v4)|️✔|subscribe している Publication の id|
|subscriberId|string |✔|subscribe している Member の id|
例
```json
{
"jsonrpc": "2.0",
"id": 0,
"result": {
"channel": {
"id": "7e19cb20-fc79-4d2f-bf29-d498ff76299a",
"name": "sample-channel",
"members": [
{
"id": "16548baf-e4b8-4137-afc0-e8e329837a39",
"type": "person",
"name": "publisher-user"
},
{
"id": "82e31b82-b391-4f84-924a-ca1e89f1a037",
"type": "person",
"name": "subscriber-user"
},
{
"id": "e5782c43-d1f6-4e27-b8f0-4e23269f48d2",
"type": "bot",
"subtype": "SFU"
}
],
"publications": [
{
"id": "f124ab4a-c3c6-40f1-800d-889c6c664924",
"publisherId": "16548baf-e4b8-4137-afc0-e8e329837a39",
"contentType": "AUDIO",
"isEnabled": true,
"type": "P2P",
},
{
"id": "cbb6f98e-2e29-4b3c-a17c-c2cc76c54182",
"publisherId": "16548baf-e4b8-4137-afc0-e8e329837a39",
"contentType": "VIDEO",
"isEnabled": true,
"type": "SFU"
},
{
"id": "81c0c1c0-7ec2-4b71-ba79-15033954de14",
"publisherId": "e5782c43-d1f6-4e27-b8f0-4e23269f48d2",
"contentType": "VIDEO",
"originId": "cbb6f98e-2e29-4b3c-a17c-c2cc76c54182",
"originPublisherId": "16548baf-e4b8-4137-afc0-e8e329837a39",
"isEnabled": true,
"type": "SFU",
}
],
"subscriptions": [
{
"id": "bbc6ac3c-6d13-44ad-9f66-251974bb2635",
"publicationId": "81c0c1c0-7ec2-4b71-ba79-15033954de14",
"subscriberId": "82e31b82-b391-4f84-924a-ca1e89f1a037"
}
]
}
}
}
```
#### 異常系
例 1. 認証に失敗した場合のレスポンスボディ
```json
{
"jsonrpc": "2.0",
"id": 0,
"error": {
"code": 401,
"message": "Verify admin token failed"
}
}
```
例 2. 指定した id の Channel が存在しなかった場合のレスポンスボディ
```json
{
"jsonrpc": "2.0",
"id": 0,
"error": {
"code": 404,
"message": "Channel '7e19cb20-fc79-4d2f-bf29-d498ff76299a' not found"
}
}
```
例 3. 指定した name の Channel が存在しなかった場合のレスポンスボディ
```json
{
"jsonrpc": "2.0",
"id": 0,
"error": {
"code": 404,
"message": "Channel with name 'sample-channel' not found"
}
}
```
例 4. Free プランをご利用のプロジェクトで接続回数制限※を超過している場合のレスポンスボディ
```json
{
"jsonrpc": "2.0",
"id": 0,
"error": {
"code": 429,
"message": "Project usage limit has been exceeded"
}
}
```
※接続回数の上限は[プランの詳細](https://skyway.ntt.com/ja/pricing/#plan)の接続料をご確認ください。
## createChannel
Channel を新規作成します。作成時に name や metadata を指定することができます。
### リクエストボディ
|プロパティ|形式|必須|説明|
|---|---|---|---|
|jsonrpc|string|️✔|`2.0` を指定する|
|id|string \| integer |✔| 任意の値を指定する。レスポンスボディにはリクエストボディで指定した id の値が入る |
|method|string|✔|`createChannel` を指定する|
|params|object|✔|Channel の name または metadata を指定できる|
|params.name|string ||Channel の name を指定する。アプリケーション内で一意である必要がある|
|params.metadata|string||Channel の metadata を指定する|
例
```json
{
"jsonrpc": "2.0",
"id": 0,
"method": "createChannel",
"params": {
"name": "sample-channel"
}
}
```
### レスポンスボディ
#### 正常系
レスポンスボディ
|プロパティ|形式|必須|説明|
|---|---|---|---|
|jsonrpc|string|️✔|`2.0` が入る|
|id|string \| integer |✔| リクエストボディで指定した id の値が入る |
|result|object|✔||
|result.channel|Channel|✔|Channel 情報を表すオブジェクト|
Channel オブジェクト
|プロパティ|形式|必須|説明|
|---|---|---|---|
|id|string (UUID v4)|️✔|Channel を一意に特定する値|
|name|string ||アプリケーション内で Channel を一意に特定する値|
|metadata|string|||
例
```json
{
"jsonrpc": "2.0",
"id": 0,
"result": {
"channel": {
"id": "7e19cb20-fc79-4d2f-bf29-d498ff76299a",
"name": "sample-channel"
}
},
}
```
#### 異常系
例 1. 認証に失敗した場合のレスポンスボディ
```json
{
"jsonrpc": "2.0",
"id": 0,
"error": {
"code": 401,
"message": "Verify admin token failed"
}
}
```
例 2. 指定した name の Channel がすでに存在していた場合のレスポンスボディ
```json
{
"jsonrpc": "2.0",
"id": 0,
"error": {
"code": 409,
"message": "Channel with name 'sample-channel' already exists"
}
}
```
例 3. Free プランをご利用のプロジェクトで接続回数制限※を超過している場合のレスポンスボディ
```json
{
"jsonrpc": "2.0",
"id": 0,
"error": {
"code": 429,
"message": "Project usage limit has been exceeded"
}
}
```
※接続回数の上限は[プランの詳細](https://skyway.ntt.com/ja/pricing/#plan)の接続料をご確認ください。
## findOrCreateChannel
指定された name の Channel が存在すればその Channel 情報を取得し、そうでなければ新規作成します。
### リクエストボディ
|プロパティ|形式|必須|説明|
|---|---|---|---|
|jsonrpc|string|️✔|`2.0` を指定する|
|id|string \| integer |✔| 任意の値を指定する。レスポンスボディにはリクエストボディで指定した id の値が入る |
|method|string|✔|`findOrCreateChannel` を指定する|
|params|object|✔|Channel の name および metadata を指定する（name は必須）|
|params.name|string |✔|Channel の name を指定する|
|params.metadata|string||Channel の metadata を指定する|
例
```json
{
"jsonrpc": "2.0",
"id": 0,
"method": "findOrCreateChannel",
"params": {
"name": "sample-channel"
}
}
```
### レスポンスボディ
#### 正常系
レスポンスボディ
|プロパティ|形式|必須|説明|
|---|---|---|---|
|jsonrpc|string|️✔|`2.0` が入る|
|id|string \| integer |✔| リクエストボディで指定した id の値が入る |
|result|object|✔||
|result.channel|Channel|✔|Channel 情報を表すオブジェクト|
Channel オブジェクト
|プロパティ|形式|必須|説明|
|---|---|---|---|
|id|string (UUID v4)|️✔|Channel を一意に特定する値|
|name|string ||アプリケーション内で Channel を一意に特定する値|
|members|Member[]|✔|Member 情報を表すオブジェクトの配列|
|publications|Publication[]|✔|Publication 情報を表すオブジェクトの配列|
|subscriptions|Subscription[]|✔|Subscription 情報を表すオブジェクトの配列|
|metadata|string|||
Member オブジェクト
|プロパティ|形式|必須|説明|
|---|---|---|---|
|id|string (UUID v4)|️✔|Member を一意に特定する値|
|name|string ||Channel 内で Member を一意に特定する値|
|type|string|✔|`person` または `bot` が入る|
|subtype|string||`SFU` が入る|
|metadata|string|||
Publication オブジェクト
|プロパティ|形式|必須|説明|
|---|---|---|---|
|id|string (UUID v4)|️✔|Publication を一意に特定する値|
|publisherId|string (UUID v4)|️✔|publish している Member の id|
|contentType|string |✔|`AUDIO`、`VIDEO` または `DATA` が入る|
|isEnabled|boolean|✔|Publication が有効の場合 `true`、そうでなければ `false` が入る|
|originId|string||forwarding されている Publication の id|
|originPublisherId|string||forwarding されている Publication を publish している Member の id|
|metadata|string|||
|type|string||`P2P` または `SFU` が入る|
Subscription オブジェクト
|プロパティ|形式|必須|説明|
|---|---|---|---|
|id|string (UUID v4)|️✔|Subscription を一意に特定する値|
|publicationId|string (UUID v4)|️✔|subscribe している Publication の id|
|subscriberId|string |✔|subscribe している Member の id|
例
```json
{
"jsonrpc": "2.0",
"id": 0,
"result": {
"channel": {
"id": "7e19cb20-fc79-4d2f-bf29-d498ff76299a",
"name": "sample-channel",
"members": [
{
"id": "16548baf-e4b8-4137-afc0-e8e329837a39",
"type": "person",
"name": "publisher-user"
},
{
"id": "82e31b82-b391-4f84-924a-ca1e89f1a037",
"type": "person",
"name": "subscriber-user"
},
{
"id": "e5782c43-d1f6-4e27-b8f0-4e23269f48d2",
"type": "bot",
"subtype": "SFU"
}
],
"publications": [
{
"id": "f124ab4a-c3c6-40f1-800d-889c6c664924",
"publisherId": "16548baf-e4b8-4137-afc0-e8e329837a39",
"contentType": "AUDIO",
"isEnabled": true,
"type": "P2P",
},
{
"id": "cbb6f98e-2e29-4b3c-a17c-c2cc76c54182",
"publisherId": "16548baf-e4b8-4137-afc0-e8e329837a39",
"contentType": "VIDEO",
"isEnabled": true,
"type": "SFU"
},
{
"id": "81c0c1c0-7ec2-4b71-ba79-15033954de14",
"publisherId": "e5782c43-d1f6-4e27-b8f0-4e23269f48d2",
"contentType": "VIDEO",
"originId": "cbb6f98e-2e29-4b3c-a17c-c2cc76c54182",
"originPublisherId": "16548baf-e4b8-4137-afc0-e8e329837a39",
"isEnabled": true,
"type": "SFU"
}
],
"subscriptions": [
{
"id": "bbc6ac3c-6d13-44ad-9f66-251974bb2635",
"publicationId": "81c0c1c0-7ec2-4b71-ba79-15033954de14",
"subscriberId": "82e31b82-b391-4f84-924a-ca1e89f1a037"
}
]
}
}
}
```
#### 異常系
例 1. 認証に失敗した場合のレスポンスボディ
```json
{
"jsonrpc": "2.0",
"id": 0,
"error": {
"code": 401,
"message": "Verify admin token failed"
}
}
```
例 2. Free プランをご利用のプロジェクトで接続回数制限※を超過している場合のレスポンスボディ
```json
{
"jsonrpc": "2.0",
"id": 0,
"error": {
"code": 429,
"message": "Project usage limit has been exceeded"
}
}
```
※接続回数の上限は[プランの詳細](https://skyway.ntt.com/ja/pricing/#plan)の接続料をご確認ください。
---
## サンプルコード/JavaScript SDK
Path: sample-code_javascript-sdk.md
# JavaScript SDK
- [Room ライブラリ による Web 会議のサンプル](https://github.com/skyway/js-sdk/tree/main/examples/simple-conference)
- [Room ライブラリの P2PRoom による 映像・音声・データの PubSub](https://github.com/skyway/js-sdk/tree/main/examples/p2p-room)
- [Room ライブラリの SFURoom による 映像・音声の PubSub](https://github.com/skyway/js-sdk/tree/main/examples/sfu-room)
- [React を利用した Web 会議デモアプリケーション](https://github.com/skyway/example-conference-webapp)
---
## サンプルコード/iOS SDK
Path: sample-code_ios-sdk.md
# iOS SDK
こちらにサンプルアプリを公開しています。
- Room ライブラリの P2PRoom による映像・音声・データの PubSub(P2PRoom)
- Room ライブラリの SFURoom による映像・音声の PubSub(SFURoom)
- Room ライブラリによる Web 会議のサンプル(AutoSubscribingRoom)
https://github.com/skyway/ios-sdk/tree/main/Examples
---
## サンプルコード/Android SDK
Path: sample-code_android-sdk.md
# Android SDK
こちらにサンプルアプリを公開しています。
- Room ライブラリの P2PRoom による映像・音声・データの PubSub(P2PRoom)
- Room ライブラリの SFURoom による映像・音声の PubSub(SFURoom)
- Room ライブラリによる Web 会議のサンプル(AutoSubscribingRoom)
https://github.com/skyway/android-sdk/tree/main/examples
---
## サンプルコード/Linux SDK
Path: sample-code_linux-sdk.md
# Linux®︎ SDK
こちらにサンプルアプリを公開しています。
- P2PRoom による映像・音声・データの PubSub(QuickStart)
https://github.com/skyway/linux-sdk/tree/main/examples
## 商標
Linux®︎は、米国およびその他の国における Linus Torvalds の登録商標です。
---
## サンプルコード/Unity SDK
Path: sample-code_unity-sdk.md
# Unity SDK
こちらでQuickStartを公開しています。
- [Windows](./user-guide/unity-sdk/quickstart-windows)
- [Android](./user-guide/unity-sdk/quickstart-android)
- [iOS](./user-guide/unity-sdk/quickstart-ios)
---
## サンプルコード/認証・認可
Path: sample-code_authentication.md
# 認証・認可サンプル
こちらにサンプルアプリを公開しています。
- 認証情報を発行するサーバーアプリケーション
- 認証情報を取得するクライアントアプリケーション
https://github.com/skyway/authentication-samples
---
## 旧SkyWayからの移行/はじめに
Path: migration-guide_introduction.md
# はじめに
> 旧 SkyWay のサービスは2026年4月30日をもって終了します。
>
> 旧 SkyWay をご利用のお客様は新 SkyWay への移行をお願いします。
>
> ※新 SkyWay を商用利用される際は Enterprise プランをご利用ください。
このガイドでは、旧 SkyWay をご利用していたお客様向けに、新 SkyWay との変更点をまとめています。
新 SkyWay について詳しくは [ユーザーガイド](/ja/docs/user-guide/introduction/)をご確認ください。
## 仕様について
仕様については以下のページをご確認ください。
- [サービス仕様](/ja/docs/migration-guide/service-specs)
- 料金体系の違い
- サポートブラウザ・OS の違い
- [機能差分](/ja/docs/migration-guide/feature-diffs)
- 機能比較
- 旧 SkyWay から進化したポイント
- [通信要件](/ja/docs/migration-guide/communication-requirements)
- 通信要件
## 開発について
移行時の開発については以下のページをご確認ください。
- [ユースケース](/ja/docs/migration-guide/use-cases)
- ミュート機能の実現方法
- 画面共有の実現方法
- カメラ・マイクデバイスの切替/画質・音質の切替の実現方法
- [通信モデルの違い](/ja/docs/migration-guide/diffs-in-communication-model)
- 旧 SkyWay の通信モデル
- 新 SkyWay の通信モデル
- [API の違い](/ja/docs/migration-guide/api-diffs)
- 認証・認可の違い
- 旧 SkyWay の API について
- 管理 API
- 対応コーデック
## 運用・お問い合わせについて
運用・お問い合わせについては以下のページをご確認ください。
- [運用情報](/ja/docs/migration-guide/operation-information)
- メンテナンス/障害情報の掲載先
- [お問い合わせ](/ja/docs/migration-guide/contact-information)
- テクニカルサポートの連絡先
- 移行に関するお問い合わせ
---
## 旧SkyWayからの移行/サービス仕様
Path: migration-guide_service-specs.md
# サービス仕様
## 料金体系の違い
旧 SkyWay Enterprise Edition（有料版）と新 SkyWay Enterprise プラン（有料版）の料金体系については、以下をご参照ください。
- 旧 SkyWay Enterprise Edition（有料版）: https://sdpf.ntt.com/services/skyway/pricing/
- 新 SkyWay Enterprise プラン（有料版）: https://skyway.ntt.com/ja/pricing/
新 SkyWay では、旧 SkyWay であった接続回数(Signaling 回数)が100万回を超えると発生した追加料金が無くなっています。
## サポートブラウザ・OS の違い
旧 SkyWay と新 SkyWay はサポートしているブラウザ・OS が異なります。
以下のリンクよりご確認ください。
旧 SkyWay
- [JavaScript SDKの動作確認済みブラウザ](https://webrtc.ecl.ntt.com/documents/javascript-sdk.html#%E5%8B%95%E4%BD%9C%E7%A2%BA%E8%AA%8D%E6%B8%88%E3%81%BF%E3%83%96%E3%83%A9%E3%82%A6%E3%82%B6)
- [iOS SDKの対応OS](https://webrtc.ecl.ntt.com/documents/ios-sdk.html#%E5%AF%BE%E5%BF%9Cos)
- [Android SDKの対応OS](https://webrtc.ecl.ntt.com/documents/android-sdk.html#%E5%AF%BE%E5%BF%9Cos)
新 SkyWay
- [JavaScript SDKのサポートブラウザ](/ja/docs/user-guide/javascript-sdk/browser/)
- [iOS SDKの対応環境](/ja/docs/user-guide/ios-sdk/overview/#7)
- [Android SDKの対応環境](/ja/docs/user-guide/android-sdk/overview/#10)
---
## 旧SkyWayからの移行/機能差分
Path: migration-guide_feature-diffs.md
# 機能差分
## 機能比較
旧 SkyWay と新 SkyWay での機能比較は以下のようになります。
| 機能 | 旧 SkyWay | 新 SkyWay |
| -------------- | -------- | -------- |
| P2P 通信 | ⚪︎ | ⚪︎ |
| SFU サーバー | ⚪︎ | ⚪︎ |
| STUN/TURN | ⚪︎ | ⚪︎ |
| 録音 | ⚪︎ | ⚪︎ |
| 録画 | × | ⚪︎ |
| Analytics | × | ⚪︎ |
上記のように新 SkyWay では旧 SkyWay の機能を引き続き使うことができ、また新たに映像の[録画](/ja/docs/user-guide/recording/)や通信状況と品質を分析するための [Analytics](/ja/docs/user-guide/analytics/) などの機能が追加されています。
## 旧 SkyWay から進化したポイント
新 SkyWay では、以下の機能により、旧 SkyWay 以上にさまざまなユースケースのアプリケーションを実装できるようになりました。
- Pub/Sub メッセージングモデルによるメディアの柔軟な送受信
- 最大同時通話人数の拡大
- 柔軟でセキュアな認証・認可機能の提供
---
## 旧SkyWayからの移行/通信要件
Path: migration-guide_communication-requirements.md
# 通信要件
旧 SkyWay と新 SkyWay で通信先のサーバーアドレスやポートを変更しています。
新/旧 SkyWay の通信要件について詳しくは、以下をご参照ください。
- [旧 SkyWay の通信要件](https://support.skyway.io/hc/ja/articles/115002273767)
- [新 SkyWay の通信要件](/ja/docs/user-guide/commons/communication-requirements/)
---
## 旧SkyWayからの移行/ユースケース
Path: migration-guide_use-cases.md
# ユースケース
このページでは、旧 SkyWay で実現可能だったユースケースのうち、代表的なケースの移行方法を記載しています。
## ミュート機能の実現方法
新 SkyWay でもミュート機能を実現できます。
具体的な実装方法は[マイクやカメラ映像のミュートやアンミュートの実装方法](/ja/docs/cookbook/javascript-sdk/enable-disable)を参照ください。
## 画面共有の実現方法
JavaScript SDK、Android SDK について、新 SkyWay でも画面共有を実現できます。
また、新 SkyWay では iOS SDK でも画面共有を実現できるようになりました。
詳細については以下のページを参照ください。
- [JavaScript SDKを用いた実現方法](/ja/docs/cookbook/javascript-sdk/screen-share)
- [iOS SDKを用いた実現方法](/ja/docs/cookbook/ios-sdk/screen-share)
- [Android SDKを用いた実現方法](/ja/docs/cookbook/android-sdk/screen-share)
## カメラ・マイクデバイスの切替/画質・音質の切替の実現方法
新 SkyWay でも送信している Stream を入れ替える API を提供しています。
詳細については以下のページを参照ください。
- [JavaScript SDKのAPI](https://javascript-sdk.api-reference.skyway.ntt.com/room/interfaces/RoomPublication.html#replaceStream)
- [iOS SDKのAPI](https://ios-sdk.api-reference.skyway.ntt.com/room/Classes/RoomPublication.html#/c:@M@SkyWayRoom@objc(cs)RoomPublication(im)replace:)
- [Android SDKのAPI](https://android-sdk.api-reference.skyway.ntt.com/room/room/com.ntt.skyway.room/-room-publication/replace-stream.html)
## このページに記載のないユースケースについて
未記載の内容についてサポートが必要な場合は、別途テクニカルサポートへお問い合わせください。
---
## 旧SkyWayからの移行/通信モデルの違い
Path: migration-guide_diffs-in-communication-model.md
# 通信モデルの違い
## 旧 SkyWay の通信モデル
電話モデルを採用しています。
Peer と Room の2種類の要素が存在します。
詳細は[こちら](https://webrtc.ecl.ntt.com/documents/at-first.html#peer)をご参照ください。
## 新 SkyWay の通信モデル
Pub/Sub モデルを採用しています。
Room に入室した Member が Publish/Subscribe することでメディアの疎通を可能にします。
詳細は[こちら](/ja/docs/user-guide/introduction/#31)をご参照ください。
---
## 旧SkyWayからの移行/API の違い
Path: migration-guide_api-diffs.md
# API の違い
## 認証・認可の違い
新 SkyWay では認証・認可の方法が変わります。
旧 SkyWay では認証のみ提供していましたが、新 SkyWay では新たに認可も行うことができるようになりました。
### 旧 SkyWay
ドメインによる認証または Peer による認証を行います。
ドメインによる認証方法については[ダッシュボードの操作方法](https://sdpf.ntt.com/services/docs/skyway/tutorials/rsts/webrtc.html#id1)をご参照ください。
Peer の認証方法については[認証サンプル](https://github.com/skyway/old-skyway-peer-authentication-samples/blob/master/README.jp.md)をご参照ください。
### 新 SkyWay
トークンベースの認証・認可機能を提供しています。
詳しい認証・認可の方法は[ユーザーガイド](/ja/docs/user-guide/authentication/)をご参照ください。
## 旧 SkyWay の API について
旧 SkyWay で一部提供しなくなった API について新 SkyWay での代替手段を記載します。
### Peer.listAllPeers()
- API リファレンス: [Peer.listAllPeers()](https://webrtc.ecl.ntt.com/api-reference/javascript.html#listallpeers-callback)
旧 SkyWay の Peer は新 SkyWay の Member にあたります。Room に参加している Member 一覧は、[Room.members プロパティ](https://javascript-sdk.api-reference.skyway.ntt.com/room/interfaces/Room.html#members)で取得できます。
### Peer.fetchPeerExists()
- API リファレンス: [Peer.fetchPeerExists()](https://webrtc.ecl.ntt.com/api-reference/javascript.html#fetchpeerexists-peerid)
[Room.members プロパティ](https://javascript-sdk.api-reference.skyway.ntt.com/room/interfaces/Room.html#members)から Room に参加している Member 一覧を取得し、[Member.id](https://javascript-sdk.api-reference.skyway.ntt.com/room/interfaces/RoomMember.html#id) でフィルタリングすることで特定の Member が Room に存在するかを確認できます。
### MeshRoom.send() / SFURoom.send()
- API リファレンス
- [MeshRoom.send()](https://webrtc.ecl.ntt.com/api-reference/javascript.html#send-data-2)
- [SFURoom.send()](https://webrtc.ecl.ntt.com/api-reference/javascript.html#send-data-3)
新 SkyWay では代替手段として DataChannel を使う方法と Room.metadata を使う方法があります。
#### DataChannel を使ってデータを送信する
Room(P2P publish) と P2PRoom のみサポートしています。WebRTC の DataChannel を使ってデータの送受信を行うことができます。
[SkyWayStreamFactory.createDataStream](https://javascript-sdk.api-reference.skyway.ntt.com/room/classes/StreamFactory.html#createDataStream) を使って LocalDataStream を作成し、[LocalDataStream.write](https://javascript-sdk.api-reference.skyway.ntt.com/room/classes/LocalDataStream.html#write) メソッドでデータの送信を行います。データの受信は [RemoteDataStream.onData](https://javascript-sdk.api-reference.skyway.ntt.com/room/classes/RemoteDataStream.html#onData) でハンドリングできます。
送受信できるデータは `string`、JSON-serializable オブジェクト、`ArrayBuffer` として扱えるオブジェクトで、[DataStreamMessageType](https://javascript-sdk.api-reference.skyway.ntt.com/room/types/DataStreamMessageType.html) として定義されています。
```js
import {
...,
SkyWayRoom,
SkyWayStreamFactory,
} from '@skyway-sdk/room';
...
const dataStream = await SkyWayStreamFactory.createDataStream();
const dataButton = document.getElementById('data-button');
dataButton.onclick = () => {
dataStream.write('Hello, World!'); // string
dataStream.write({ message: 'Hello, World!' }); // JSON-serializable object
dataStream.write(new Uint8Array([0, 1, 2, 3, 4])); // kind of ArrayBuffer
};
const room = await SkyWayRoom.FindOrCreate(context, {
name: 'p2p-room',
});
const me = await room.join();
await me.publish(dataStream, { type: "p2p" });
let n = 1;
room.onStreamPublished.add(async (e) => {
const { stream } = await me.subscribe(e.publication.id);
if (stream.contentType === 'data') {
// stream is RemoteDataStream
stream.onData.add((data) => {
console.log(`data${n}:`, data);
// data1: Hello, World!
// data2: { message: 'Hello, World!' }
// data3: ArrayBuffer(5)
});
}
});
```
#### Room.metadata での文字列の共有
Room は文字列を格納する [Room.metadata プロパティ](https://javascript-sdk.api-reference.skyway.ntt.com/room/interfaces/Room.html#metadata)を持っています。同じ Room を使用しているアプリケーション間で値で共有されるため、Room 内のすべてのユーザーに文字列を送信するときに使うことができます。
[Room.updateMetadata() メソッド](https://javascript-sdk.api-reference.skyway.ntt.com/room/interfaces/Room.html#updateMetadata) で metadata の更新を行うと [RoomMetadataUpdatedEvent](https://javascript-sdk.api-reference.skyway.ntt.com/room/types/RoomMetadataUpdatedEvent.html) が発火します。このイベントは、[Room.onMetadataUpdated](https://javascript-sdk.api-reference.skyway.ntt.com/room/interfaces/Room.html#onMetadataUpdated) でハンドリングできます。
```js
let msg;
await room.updateMetadata('hi everyone!');
await room.onMetadataUpdated.add((e) => {
msg = e.metadata;
});
```
使用可能な文字列は [割り当てと制限の「Channel、Member の metadata として使用可能な文字種」](/ja/docs/user-guide/commons/quotas-and-limits/#76) を参照してください。
### MeshRoom.getLog() / SFURoom.getLog()
- API リファレンス
- [MeshRoom.getLog()](https://webrtc.ecl.ntt.com/api-reference/javascript.html#getlog)
- [SFURoom.getLog()](https://webrtc.ecl.ntt.com/api-reference/javascript.html#getlog-2)
getLog() で取得できるログの仕様は以下の通りです。
ログの形式
|プロパティ|説明|
|:---:|:---:|
|timestamp|イベント発生時刻|
|messageType|メッセージの種類|
|message|メッセージ|
メッセージの種類
|メッセージの種類|説明|
|:---:|:---:|
|ROOM_USER_JOIN|いずれかのユーザーが room に join した際に記録されるログ|
|ROOM_USER_LEAVE|いずれかのユーザーが room から leave した際に記録されるログ|
|ROOM_DATA|いずれかのユーザーが room に send でデータを送信した際に記録されるログ|
ROOM_USER_JOIN メッセージのフォーマット
|プロパティ|説明|
|:---:|:---:|
|roomName|room 名|
|roomType|room の種類（Mesh \| SFU）|
|src|room に join した Peer の PeerID|
ROOM_USER_LEAVE メッセージのフォーマット
|プロパティ|説明|
|:---:|:---:|
|roomName|room 名|
|src|room から leave した Peer の PeerID|
ROOM_DATA メッセージのフォーマット
|プロパティ|説明|
|:---:|:---:|
|src|room に send した Peer の PeerID|
|data|room に send で送信したデータ|
新 SkyWay では MeshRoom.getLog() / SFURoom.getLog() のようにログを取得する機能を提供していませんが、イベント発火時にログの内容に相当する情報を取得することは可能です。
#### ROOM_USER_JOIN メッセージの代替手段
ある Member が Room へ join したとき [MemberJoinedEvent](https://javascript-sdk.api-reference.skyway.ntt.com/room/types/MemberJoinedEvent.html) が発火します。[Room.onMemberJoined](https://javascript-sdk.api-reference.skyway.ntt.com/room/interfaces/Room.html#onMemberJoined) に MemberJoinedEvent を引数に取るイベントハンドラーを add することで、MemberJoinedEvent から ROOM_USER_JOIN メッセージ相当の情報を取得できます。
|プロパティ|代替手段|
|:---:|:---:|
|roomName|MemberJoinedEvent.member.roomName で取得可能|
|roomType|MemberJoinedEvent.member.roomType で取得可能|
|src|MemberJoinedEvent.member.id で Room に join した Member の id を取得可能|
```js
room.onMemberJoined.add((memberJoinedEvent) => {
console.log(memberJoinedEvent.member.roomName);
console.log(memberJoinedEvent.member.roomType);
console.log(memberJoinedEvent.member.id);
});
```
#### ROOM_USER_LEAVE メッセージの代替手段
ある Member が Room から leave したとき [MemberLeftEvent](https://javascript-sdk.api-reference.skyway.ntt.com/room/types/MemberLeftEvent.html) が発火します。[Room.onMemberLeft](https://javascript-sdk.api-reference.skyway.ntt.com/room/interfaces/Room.html#onMemberLeft) に MemberLeftEvent を引数に取るイベントハンドラーを add することで、MemberLeftEvent から ROOM_USER_LEAVE メッセージ相当の情報を取得できます。
|プロパティ|代替手段|
|:---:|:---:|
|roomName|MemberLeftEvent.member.roomName で取得可能|
|src|MemberLeftEvent.member.id で Room から leave した Member の id を取得可能|
```js
room.onMemberLeft.add((memberLeftEvent) => {
console.log(memberLeftEvent.member.roomName);
console.log(memberLeftEvent.member.id);
});
```
#### ROOM_DATA メッセージの代替手段
[MeshRoom.send() / SFURoom.send()](#41) での記載の通り、新 SkyWay ではデータの送受信方法として DataChannel を使う方法と Room.metadata を使う方法があります。
src に相当する情報は、DataChannel を使う方法の場合 Member の id を含めたデータを送信することで [DataStreamMessageType](https://javascript-sdk.api-reference.skyway.ntt.com/room/types/DataStreamMessageType.html) から取得できます。
同様に、Room.metadata を使う方法の場合 Room.metadata に Member の id を含めて update することで、[RoomMetadataUpdatedEvent](https://javascript-sdk.api-reference.skyway.ntt.com/room/types/RoomMetadataUpdatedEvent.html) から取得できます。
|プロパティ|代替手段|
|:---:|:---:|
|src|Room.updateMetadata() または LocalDataStream.write() で Member の id を送信することで [RoomMetadataUpdatedEvent](https://javascript-sdk.api-reference.skyway.ntt.com/room/types/RoomMetadataUpdatedEvent.html) または [DataStreamMessageType](https://javascript-sdk.api-reference.skyway.ntt.com/room/types/DataStreamMessageType.html) で取得可能|
|data| [RoomMetadataUpdatedEvent](https://javascript-sdk.api-reference.skyway.ntt.com/room/types/RoomMetadataUpdatedEvent.html) または [DataStreamMessageType](https://javascript-sdk.api-reference.skyway.ntt.com/room/types/DataStreamMessageType.html) で取得可能|
## 管理 API
### 旧 SkyWay
Enterprise Edition ユーザーの方はご利用情報を API リクエストでご確認いただけます。
詳細は[こちら](https://webrtc.ecl.ntt.com/documents/sdpf-api.html)をご参照ください。
### 新 SkyWay
新 SkyWay では API リクエストではご利用情報は取得できません。
ご利用状況は [SkyWay コンソール](https://console.skyway.ntt.com/)にログインいただくことで、「ご利用状況」画面よりご確認いただけます。
## 対応コーデック
旧 SkyWay と新 SkyWay で対応コーデックを変更しています。
- 凡例
- ○: 指定可能
- *1: リリース時のみ動作検証
- *2: DTX オプションあり
- *3: サイマルキャスト対応
- ×: 指定不可
- *1の有無(指定可能コーデックとサポートコーデック)の違いについては、新 SkyWay の[共通仕様 - 対応コーデック - 分類](/ja/docs/user-guide/commons/codecs/#7)をご参照ください
- *2の DTX オプションは、非発話区間における帯域を削減するオプションです
- Opus/RED は、メディアパケットを冗長化しパケロス耐性を向上したコーデックです
- 通信量は多くなりますが、パケロスの多い環境での通話品質向上に効果的です
新/旧 SkyWay の対応コーデックについて詳しくは、以下をご参照ください。
- 旧 SkyWay の対応コーデック:
- JavaScript SDK: [Peer クラスの call メソッドの call options object](https://webrtc.ecl.ntt.com/api-reference/javascript.html#call-options-object)
- iOS SDK: [SKWCallOption クラス](https://webrtc.ecl.ntt.com/ios-reference/a00085)
- Android SDK: [io.skyway.Peer.CallOption クラス](https://webrtc.ecl.ntt.com/android-reference/classio_1_1skyway_1_1_peer_1_1_call_option.html)
- [新 SkyWay の対応コーデック](/ja/docs/user-guide/commons/codecs/)
---
## 旧SkyWayからの移行/運用情報
Path: migration-guide_operation-information.md
# 運用情報
## メンテナンス/障害情報の掲載先
旧 SkyWay と新 SkyWay でメンテナンス/障害情報の掲載先を以下の通り変更しています。
- 旧 SkyWay: [旧 SkyWay サポート](https://support.skyway.io/hc/ja)サイトのページ下部の `メンテナンス情報` タブや `障害情報` タブ、`SFU通話切断事象` タブ
- 新 SkyWay: [SkyWay サポート](https://support.skyway.ntt.com/hc/ja)サイトの `工事・障害情報` 欄の [ドコモビジネスお客さまサポート SkyWay サービスページ](https://support.ntt.com/skyway)
---
## 旧SkyWayからの移行/お問い合わせ
Path: migration-guide_contact-information.md
# お問い合わせ
## テクニカルサポートの連絡先
旧 SkyWay と新 SkyWay でテクニカルサポートの連絡先を変更しています。
新/旧 SkyWay のテクニカルサポートの窓口は、以下の通りです。
- 旧 SkyWay の Enterprise Edition（有料版）をご契約の方は[旧 SkyWay サポート](https://support.skyway.io/hc/ja)サイトの `チケットサポート（Enterprise限定）` よりお問い合わせください
- 移行中の新 SkyWay に関するテクニカルサポートも上記の窓口からお受けできます。
- 新 SkyWay の Enterprise プラン（有料版）をご契約の方は [SkyWay コンソール](https://console.skyway.ntt.com/login/)の `サポート` メニュー よりお問い合わせください
## 移行に関するお問い合わせ
旧 SkyWay から新 SkyWay への移行に関するお問い合わせは、以下のようにお問い合わせください。
- テクニカル面でのお問い合わせ: 上記の「テクニカルサポートの連絡先」をご確認の上、お問い合わせください
- テクニカル面以外でのお問い合わせ: [こちらのフォーム](https://support.skyway.ntt.com/hc/ja/requests/new?ticket_form_id=14615614124185)よりお問い合わせください