Home

Awesome

Sora JavaScript SDK

Static Badge GitHub tag npm version License

Sora JavaScript SDK は株式会社時雨堂が開発、販売している WebRTC SFU Sora をブラウザから扱うための SDK です。

About Shiguredo's open source software

We will not respond to PRs or issues that have not been discussed on Discord. Also, Discord is only available in Japanese.

Please read https://github.com/shiguredo/oss before use.

時雨堂のオープンソースソフトウェアについて

利用前に https://github.com/shiguredo/oss をお読みください。

使い方

使い方は Sora JavaScript SDK ドキュメント を参照してください。

システム条件

サンプル集

# .env.local を作成して適切な値を設定してください
$ cp .env.template .env.local
$ pnpm install
$ pnpm run build
$ pnpm run dev

E2E (End to End) テスト

Playwright を利用した E2E テストを実行できます。

# .env.local を作成して適切な値を設定してください
$ cp .env.template .env.local
$ pnpm install
$ pnpm run build
$ pnpm exec playwright install chromium --with-deps
$ pnpm run e2e-test

E2EE (End to End Encryption) について

詳細については以下をご確認ください。

WebRTC SFU Sora 向け E2EE ライブラリ

マルチトラックについて

WebRTC SFU Sora は 1 メディアストリームにつき 1 音声トラック、 1 映像トラックまでしか対応していないため, Sora JavaScript SDK はマルチトラックに対応していません。

マルチトラックへの対応は今のところ未定です。

API 一覧

Sora JavaScript SDK ドキュメント API リファレンス

ライセンス

Apache License 2.0

Copyright 2017-2024, Shiguredo Inc.
Copyright 2017-2022, Yuki Ito (Original Author)

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

リンク

商用製品

無料検証サービス

クライアント SDK

クライアントツール

サーバーツール