Sora Unity SDK

Sora Unity SDK は WebRTC SFU Sora の Unity クライアントアプリケーションを開発するためのライブラリです。

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/blob/master/README.en.md before use.

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

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

利用方法

Sora Unity SDK を使ってみたい人は USE.md をお読みください。

ビルド方法

ビルド方法の詳細は GitHub Actions をご確認ください、ビルドに関しての問い合わせは受け付けておりません

Windows でのビルド方法は BUILD_WINDOWS.md をお読みください
macOS でのビルド方法は BUILD_MACOS.md をお読みください

サンプル

shiguredo/sora-unity-sdk-samples: WebRTC SFU Sora Unity SDK サンプル集

サンプル動作例

対応 Unity バージョン

Unity 2019.4 (LTS)
Unity 2020.3 (LTS)

システム条件

Sora 2021.2 以降

対応プラットフォーム

Windows 10 1809 x86_64 以降
macOS 10.15 x86_64 以降
Android 7 以降
iOS 10 以降

対応機能

AV1 への対応
Windows への対応
macOS への対応
Android への対応
iOS 対応
SRTP/SRTCP の AES-GCM 対応
Unity のカメラ映像を取得し Sora で送信
カメラから映像を取得し Sora に送信
カメラから映像を取得し Unity アプリに出力
マイクから音声を取得し Sora に送信
マイクから音声を取得し Unity アプリに出力
Unity アプリで Sora からの音声を受信
Unity アプリで Sora からの映像を受信
Unity アプリで Sora からの音声を再生
ソフトウェアエンコード/デコード VP8 / VP9 への対応
Opus への対応
デバイス指定機能
マイクの代わりに Unity からのオーディオ出力
Unity カメラからの映像取得に対応
Unity 側で受信したオーディオの再生に対応
Sora から受信した音声を Unity アプリに出力
Sora から受信した映像を Unity アプリに出力
Sora マルチストリーム機能への対応
Sora シグナリング通知への対応
Sora メタデータへの対応
Sora シグナリング開始時の音声コーデック/ビットレート指定に対応
Sora シグナリング開始時の映像コーデック/ビットレート指定に対応
Sora シグナリング通知への対応
Sora プッシュ通知への対応
Sora サイマルキャストへの対応
Sora スポットライトへの対応
Sora データチャネルへの対応
Sora データチャネルメッセージングへの対応
- 実験的機能
Apple VideoToolbox
- H.264 ハードウェアエンコードへの対応
- H.264 ハードウェアデコードへの対応
NVIDIA VIDEO CODEC SDK
- Windows 版
  - H.264 のハードウェアエンコードへの対応
  - H.264 のハードウェアデコードへの対応

H.264 の利用について

Sora Unity SDK ではソフトウェアでの H.264 エンコード/デコードの利用はできません。これは H.264 のソフトウェアエンコーダ/デコーダを含んで配布した場合はライセンス費用が発生することから、無効にしているためです。

そのため Windows では NVIDIA VIDEO CODEC SDK 、macOS では VideoToolbox を利用し、H.264 のエンコード/デコードを実現しています。また Android でも H.264 ハードウェアエンコーダを利用します。

詳細は H.264 を USE_H264.md をお読みください

有償での優先実装

Windows 版 NVIDIA VIDEO CODEC SDK による H.264 エンコーダ対応
- スロースネットワークス株式会社様
WebRTC's Statistics 対応
- 企業名非公開
Windows 版 NVIDIA VIDEO CODEC SDK による H.264 デコーダ対応
- スロースネットワークス株式会社様
Android 版対応
- 株式会社KDDIテクノロジー様

有償での優先実装が可能な機能一覧

詳細は Discord またはメールにてお問い合わせください

オープンソースでの公開が前提
可能であれば企業名の公開
- 公開が難しい場合は 企業名非公開 と書かせていただきます

機能

ミュート機能
デバイスをつかまないようにする機能
Apple M1 対応
音声のみ送受信機能
サイマルキャスト rid 指定対応

プラットフォーム

Ubuntu 20.04 への対応
ARM 版 Windows への対応

NVIDIA VIDEO CODEC SDK

VP8 のハードウェアデコードへの対応
VP9 のハードウェアデコードへの対応
AV1 のハードウェアデコードへの対応
Ubuntu 20.04 への対応

INTEL Media SDK 対応

H.264 のハードウェアエンコードへの対応
VP8 のハードウェアエンコードへの対応
VP9 のハードウェアエンコードへの対応
H.264 のハードウェアデコードへの対応
VP8 のハードウェアデコードへの対応
VP9 のハードウェアデコードへの対応

ライセンス

Apache License 2.0

Copyright 2019-2022, Wandbox LLC (Original Author)
Copyright 2019-2022, Shiguredo Inc.

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.

yamada-esp/sora-unity-sdk