# Sora Unity SDK 概要

Sora Unity SDK は [株式会社時雨堂](https://shiguredo.jp) の [WebRTC SFU Sora](https://sora.shiguredo.jp) の Unity 向けクライアントフレームワークです。

## 特徴

Sora Unity SDK は Sora C++ SDK をラップした Unity 向けのライブラリです。
そのため、Sora C++ SDK がサポートする機能の大半を利用できます。

### ハードウェアアクセラレーター

時雨堂が独自に様々なハードウェアアクセラレーターに対応することで、CPU 負荷を抑えて高画質な映像配信を行えます。

- [Apple macOS Video Toolbox](https://developer.apple.com/documentation/videotoolbox)- H.264 / H.265
  - VP9 / AV1 のデコードには対応していません
- [NVIDIA Video Codec SDK](https://developer.nvidia.com/video-codec-sdk)- VP8 / VP9 / AV1 / H.264 / H.265
  - VP8 / VP9 はデコードのみの対応です
- [Intel VPL](https://github.com/intel/libvpl) (Intel Media SDK の後継)- VP9 / AV1 / H.264 / H.265
- [AMD AMF](https://github.com/GPUOpen-LibrariesAndSDKs/AMF)- VP8 / VP9 / AV1 / H.264 / H.265
  - AV1 のデコードは Ubuntu x86_64 のみ対応です
  - VP8 / VP9 はデコードのみの対応です
  > **警告**
  >
  > AMD AMF は現在非推奨です。

### ソフトウェアコーデック

libwebrtc に含まれている VP8 / VP9 / AV1 に対応しています。

## ソースコードとリポジトリ構成

- ソースコード- SDK ソースコード
  - サンプルソースコード
- リポジトリ構成- `src/` : ネイティブプラグイン（Unity 向けラッパー）の SDK 実装です
  - `SoraUnitySdkExamples/` : Unity サンプルプロジェクトです
  - `SoraUnitySdkExamples/Assets/SoraUnitySdk/` : Unity 向けの C# での SDK 実装です

## 動作環境

### 対応 Unity バージョン

- Unity 6000.3 (LTS)
- Unity 6000.0 (LTS)

### 対応プラットフォーム

- Windows 10 22H2 x86_64 以降
- macOS 13.4.1 arm64 以降
- Android 7 以降
- iOS 13 以降
- visionOS 2.0 以降
- Ubuntu 22.04 x86_64
- Ubuntu 24.04 x86_64

### 対応 Sora

[リリースノート](release.html) をご確認ください

### 対応グラフィックス API

Unity カメラキャプチャを使用する場合は、対応プラットフォームごとに以下のグラフィックス API を利用してください。

#### macOS

- Metal

#### iOS

- Metal

#### visionOS (お試し版)

- Metal

#### Windows

- Direct3D 11
- Direct3D 12

#### Android

- OpenGL ES 3
- Vulkan

#### Linux (Ubuntu)

- OpenGLCore

## 問い合わせについて

Sora Unity SDK の質問などについては Discord の `#sora-sdk-faq` チャンネルをご利用ください。
ただし、Sora のライセンス契約の有無に関わらず、応答時間と問題の解決を保証しませんのでご了承ください。



## 使ってみる

まずは [プロジェクトにインストールする](use.html) をお読みください。