docs.rs failed to build sora_sdk-2026.1.0
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.

Sora Rust SDK

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

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 Rust SDK について

様々なプラットフォームに対応した WebRTC SFU Sora 向けの Rust SDK です。

特徴

マルチストリーム対応
サイマルキャスト対応
スポットライト対応
DataChannel シグナリング対応
DataChannel メッセージング対応
JSON-RPC over DataChannel 対応
転送フィルター対応
シグナリング通知対応
シグナリングリダイレクト対応
複数シグナリング URL 対応
メタデータ認証対応
シグナリング通知メタデータ対応
クライアント証明書認証対応
TURN-TLS 対応
HTTP プロキシ対応
VP8 / VP9 / AV1 / H.264 / H.265 対応
OpenH264 による H.264 ソフトウェアエンコード / デコード対応
AMD AMF (Advanced Media Framework) によるハードウェアエンコード / デコード対応 (Windows / Linux)
NVIDIA Video Codec によるハードウェアエンコード / デコード対応 (Windows / Linux)
Intel VPL によるハードウェアエンコード / デコード対応 (Linux)
Raspberry Pi 向け libcamera による映像入力対応
Raspberry Pi 向け V4L2-M2M によるハードウェアエンコード / デコード対応
MP4 ファイルから無変換での映像送信対応
複数クライアント同時実行対応

対応コーデック

ハードウェアエンコード / デコードの実際の対応状況は GPU やドライバの対応状況に依存します。

バックエンド	対応プラットフォーム	エンコード	デコード
ソフトウェア	全プラットフォーム	VP8 / VP9 / AV1	VP8 / VP9 / AV1
OpenH264	全プラットフォーム	H.264	H.264
Apple VideoToolbox	macOS	H.264 / H.265	H.264 / H.265
AMD AMF	Windows / Linux	H.264 / H.265 / AV1	H.264 / H.265 / AV1
NVIDIA Video Codec	Windows / Linux	H.264 / H.265 / AV1	H.264 / H.265 / AV1 / VP8 / VP9
Intel VPL	Linux	H.264 / H.265 / VP9 / AV1	H.264 / H.265 / VP9 / AV1
V4L2-M2M	Raspberry Pi	H.264	H.264

MP4 無変換送信

MP4 ファイルに含まれる映像トラックをデコード / エンコードを挟まず、そのまま Sora に送信できる独自機能です。音声トラックは送信せずに無視します。

対応プラットフォーム: 全プラットフォーム
対応映像コーデック: H.264 / H.265 / VP8 / VP9 / AV1
B フレーム: 非対応

使い方

依存関係の追加

Cargo.toml に以下を追加してください。

[dependencies]
sora_sdk = "2026.1.0"
shiguredo_webrtc = "~0.150"
tokio = { version = "1", features = ["rt", "macros", "sync", "time"] }

shiguredo_webrtc は VideoTrack や AudioTrack、RtpTransceiver など sora_sdk の公開 API で必要な型を提供します。この例は tokio の current-thread ランタイムを使用します。 multi-thread ランタイムを使用する場合は、利用側で tokio の rt-multi-thread feature を追加してください。

sendrecv で接続する

映像・音声を送受信する例です。

use sora_sdk::{Role, SoraConnection, SoraConnectionContext, SoraConnectionEventHandler};

struct MyEventHandler;

impl SoraConnectionEventHandler for MyEventHandler {
    fn on_notify(&mut self, text: &str) {
        println!("notify: {text}");
    }
    fn on_track(&mut self, transceiver: shiguredo_webrtc::RtpTransceiver) {
        println!("track added: {:?}", transceiver.receiver().track().id());
    }
}

#[tokio::main(flavor = "current_thread")]
async fn main() -> Result<(), sora_sdk::Error> {
    // 1. SoraConnectionContext を作成する
    //    PeerConnectionFactory や WebRTC 関連スレッドを管理します。
    //    複数の SoraConnection で共有できます。
    let context = SoraConnectionContext::new()?;

    // 2. AudioTrack を作成する
    let audio_source = context.create_audio_source()?;
    let audio_track = context.create_audio_track(&audio_source)?;

    // VideoTrackSource は shiguredo_webrtc クレートから作成する
    // (FakeVideoCapturer や AdaptedVideoTrackSource など)

    // 3. SoraConnection::builder() で接続設定を組み立てる
    //    第 5 引数に SoraConnectionEventHandler 実装を渡す
    let (connection, _handle) = SoraConnection::builder(
        context,
        vec!["wss://sora.example.com/signaling".to_string()],
        "your-channel-id".to_string(),
        Role::SendRecv,
        MyEventHandler,
    )
    .sender_audio_track(audio_track)
    // .sender_video_track(video_track)
    .build()?;

    // 4. connection.run() で Sora に接続する
    //    接続が終了するまでブロックします。
    //    handle.disconnect() で切断できます。
    connection.run().await?;

    Ok(())
}

sendonly で接続する

映像・音声を送信する例です。

use sora_sdk::{Role, SoraConnection, SoraConnectionContext, SoraConnectionEventHandler};

struct MyEventHandler;

impl SoraConnectionEventHandler for MyEventHandler {
    fn on_notify(&mut self, text: &str) {
        println!("notify: {text}");
    }
}

#[tokio::main(flavor = "current_thread")]
async fn main() -> Result<(), sora_sdk::Error> {
    let context = SoraConnectionContext::new()?;

    // AudioTrack を作成する
    let audio_source = context.create_audio_source()?;
    let audio_track = context.create_audio_track(&audio_source)?;

    // VideoTrackSource は shiguredo_webrtc クレートから作成する
    // (FakeVideoCapturer や AdaptedVideoTrackSource など)

    let (connection, _handle) = SoraConnection::builder(
        context,
        vec!["wss://sora.example.com/signaling".to_string()],
        "your-channel-id".to_string(),
        Role::SendOnly,
        MyEventHandler,
    )
    .sender_audio_track(audio_track)
    // .sender_video_track(video_track)
    .build()?;

    connection.run().await?;

    Ok(())
}

recvonly で接続する

映像・音声を受信する例です。

use sora_sdk::{Role, SoraConnection, SoraConnectionContext, SoraConnectionEventHandler};

struct MyEventHandler;

impl SoraConnectionEventHandler for MyEventHandler {
    fn on_notify(&mut self, text: &str) {
        println!("notify: {text}");
    }
}

#[tokio::main(flavor = "current_thread")]
async fn main() -> Result<(), sora_sdk::Error> {
    let context = SoraConnectionContext::new()?;

    let (connection, _handle) = SoraConnection::builder(
        context,
        vec!["wss://sora.example.com/signaling".to_string()],
        "your-channel-id".to_string(),
        Role::RecvOnly,
        MyEventHandler,
    )
    .build()?;

    connection.run().await?;

    Ok(())
}

SoraConnection::builder() の設定

SoraConnection::builder() では以下の設定が可能です。イベントハンドラは第 5 引数として SoraConnectionEventHandler トレイトを実装した型のインスタンスを渡します。トレイトの全メソッドにデフォルトの空実装が用意されているため、必要なメソッドのみオーバーライドすればよいです。

struct MyEventHandler;

impl SoraConnectionEventHandler for MyEventHandler {
    // 必要なメソッドのみオーバーライドする
    fn on_notify(&mut self, text: &str) { /* notify メッセージ受信時 */ }
    fn on_push(&mut self, text: &str) { /* push メッセージ受信時 */ }
    fn on_track(&mut self, transceiver: RtpTransceiver) { /* トラック追加時 */ }
    fn on_remove_track(&mut self, receiver: RtpReceiver) { /* トラック削除時 */ }
    fn on_switched(&mut self) { /* DataChannel に切り替わった時 */ }
    fn on_websocket_close(&mut self, code: Option<u16>, reason: &str) { /* WebSocket 切断時 */ }
    fn on_message(&mut self, label: &str, data: &[u8]) { /* メッセージ受信時 */ }
    fn on_data_channel(&mut self, label: &str) { /* DataChannel 作成時 */ }
    fn on_data_channel_open(&mut self, label: &str) { /* DataChannel オープン時 */ }
    fn on_data_channel_message(&mut self, label: &str, data: &[u8]) { /* DataChannel メッセージ受信時 */ }
    fn on_data_channel_close(&mut self, label: &str) { /* DataChannel クローズ時 */ }
    fn on_signaling_message(&mut self, type_: SignalingType, direction: SignalingDirection, text: &str) { /* シグナリングメッセージ送受信時 */ }
}

let (connection, handle) = SoraConnection::builder(context, signaling_urls, channel_id, role, MyEventHandler)
    // 送信トラック
    .sender_video_track(video_track)
    .sender_audio_track(audio_track)
    // 接続オプション
    .client_id("client-1".to_string())           // クライアント ID
    .bundle_id("bundle-1".to_string())           // バンドル ID
    .metadata(metadata)                          // メタデータ (認証用など)
    .audio(audio)                                // 音声設定
    .video(video)                                // 映像設定
    .data_channel_signaling(true)                // DataChannel シグナリング
    .ignore_disconnect_websocket(true)           // WebSocket 切断を無視
    .simulcast(true)                             // サイマルキャスト
    .simulcast_request_rid("r0".to_string())     // サイマルキャスト rid 指定
    .spotlight(true)                             // スポットライト
    .spotlight_focus_rid("r1".to_string())       // スポットライト フォーカス rid
    .spotlight_unfocus_rid("r0".to_string())     // スポットライト アンフォーカス rid
    .signaling_notify_metadata(notify_metadata)  // シグナリング通知メタデータ
    .data_channels(data_channels)                // DataChannel 設定
    .forwarding_filters(filters)                 // 転送フィルター
    // ICE サーバー設定
    .ice_server_url_configurer(|server, urls| { /* IceServer に追加する URL を取捨選択 */ })
    // TLS 設定
    .insecure(false)                             // サーバー証明書の検証をスキップ
    .client_cert(cert, key)                      // クライアント証明書 (PEM)
    .ca_cert(ca)                                 // CA 証明書 (PEM)
    // TURN-TLS 設定
    .turn_tls_insecure(false)                    // TURN-TLS 証明書の検証をスキップ
    .turn_tls_ca_cert(der)                       // TURN-TLS CA 証明書 (DER)
    // プロキシ設定
    .proxy(proxy_info)                           // HTTP プロキシ
    // タイムアウト設定
    .websocket_connection_timeout(Duration::from_secs(30))
    .websocket_close_timeout(Duration::from_secs(3))
    .disconnect_wait_timeout(Duration::from_secs(5))
    // その他
    .user_agent("MyApp/1.0".to_string())         // WebSocket User-Agent
    .build()?;

切断と統計情報の取得

SoraConnection::builder().build() が返す SoraConnectionHandle を使って、別タスクから切断や統計情報の取得ができます。

// 別タスクから切断する
let handle_clone = handle.clone();
tokio::spawn(async move {
    tokio::time::sleep(std::time::Duration::from_secs(60)).await;
    let _ = handle_clone.disconnect().await;
});

// 統計情報を取得する
let stats = handle.get_stats().await?;

// 最初に WebSocket 接続が成功したシグナリング URL を取得する
let selected = handle.selected_signaling_url().await?;

// 現在接続中のシグナリング URL を取得する (リダイレクト後はリダイレクト先)
let connected = handle.connected_signaling_url().await?;

メッセージ受信

SoraConnectionEventHandler::on_message メソッドをオーバーライドすることで、# プレフィックス付きラベルのユーザー定義 DataChannel からメッセージを受信できます。

impl SoraConnectionEventHandler for MyEventHandler {
    fn on_message(&mut self, label: &str, data: &[u8]) {
        println!("received on {label}: {} bytes", data.len());
    }
}

メッセージ送信

SoraConnectionHandle を使って # プレフィックス付きラベルのユーザー定義 DataChannel にバイナリデータを送信できます。

handle.send_message("#my-channel", b"hello").await?;

compress: true を指定した DataChannel メッセージは、zlib 展開後 16 MiB まで受信できます。上限を超えるメッセージや不正な zlib ストリームはメッセージ単位で破棄し、接続を継続します。

RPC

SoraConnectionHandle を使って JSON-RPC 2.0 over DataChannel でリクエストを送信できます。 SDK が JSON-RPC 2.0 メッセージの組み立てと id 採番を行います。応答が JSON-RPC 2.0 の要件を満たさず、応答待機中の Request ID と対応付けられる場合は Error::RpcProtocolViolation を返します。

use sora_sdk::{JsonString, RpcRequestOptions, RpcResponse};

// リクエストを送信してレスポンスを待つ (デフォルトタイムアウト 5 秒)
let params: JsonString = r#"{"key": "value"}"#.parse()?;
let response = handle.send_rpc_request(
    "method_name",
    Some(params),
    RpcRequestOptions::default(),
).await?;

match response {
    Some(RpcResponse::Success { result }) => {
        // result: JsonString
    }
    Some(RpcResponse::Error { code, message, data }) => {
        // code: i32, message: String, data: Option<JsonString>
    }
    None => {
        // notification の場合
    }
}

// notification (レスポンスを待たない)
let response = handle.send_rpc_request(
    "method_name",
    None,
    RpcRequestOptions {
        notification: true,
        ..Default::default()
    },
).await?;
// response: None

// タイムアウトを 10 秒に変更
let response = handle.send_rpc_request(
    "method_name",
    None,
    RpcRequestOptions {
        timeout: std::time::Duration::from_secs(10),
        ..Default::default()
    },
).await?;

複数クライアントの同時実行

SoraConnectionContext は Send + Sync を実装しているため、複数の SoraConnection で共有できます。

let context = SoraConnectionContext::new()?;

struct EmptyHandler;
impl SoraConnectionEventHandler for EmptyHandler {}

for i in 0..5 {
    let ctx = context.clone();
    let channel_id = format!("channel-{i}");
    tokio::spawn(async move {
        let (connection, _handle) = SoraConnection::builder(
            ctx,
            vec!["wss://sora.example.com/signaling".to_string()],
            channel_id,
            Role::RecvOnly,
            EmptyHandler,
        )
        .build()
        .unwrap();
        let _ = connection.run().await;
    });
}

構成

sora-rust-sdk/
├── src/                      # sora_sdk クレート
├── examples/
│   └── sumomo/               # Sora クライアントサンプル
├── e2e-tests/                # エンドツーエンドテスト
├── pbt/                      # Property-Based Testing
├── tests/                    # sora_sdk の結合テスト
├── docs/                     # 補足ドキュメント
└── skills/
    └── sora-rust-sdk/        # AI エージェント向けリファレンス

サンプル

sumomo

Sora クライアントのサンプルです。

cargo run -p sumomo -- \
    --signaling-url wss://sora.example.com/signaling \
    --channel-id your-channel-id \
    --role sendrecv

ビルド

前提条件

Rust 1.93 以上
libclang (bindgen 用)
Python 3 (WebRTC ビルド用)

Ubuntu 上の CI は、以下のパッケージをインストールしてビルドしています。

sudo apt-get update
sudo apt-get install -y \
  build-essential \
  libx11-dev libxext-dev libxrandr-dev libxi-dev libxfixes-dev \
  libxcursor-dev libxss-dev libxtst-dev \
  libwayland-dev libxkbcommon-dev \
  libasound2-dev libpulse-dev libpipewire-0.3-dev \
  libvulkan-dev libdbus-1-dev libudev-dev libdrm-dev libgbm-dev \
  libclang-dev

amf / nvcodec / vpl / v4l2 / libcamera feature を利用する場合は、対応するハードウェア、ドライバー、SDK、システムライブラリも必要です。

ビルド手順

cargo build

対応 WebRTC SFU Sora

Sora 2025.2.0 以降

対応プラットフォーム

Ubuntu 26.04 LTS x86_64
Ubuntu 26.04 LTS arm64
Ubuntu 24.04 LTS x86_64
Ubuntu 24.04 LTS arm64
Ubuntu 22.04 LTS x86_64
Ubuntu 22.04 LTS arm64
macOS Tahoe 26 arm64
macOS Sequoia 15 arm64
Windows 11 x86_64
Windows Server 2025 x86_64
Raspberry Pi (Linux arm64)

Ubuntu の対応バージョン

直近の LTS 3 バージョンをサポートします。

macOS の対応バージョン

直近の 2 バージョンをサポートします。

Windows の対応バージョン

直近のバージョンをサポートします。

優先実装

優先実装とは Sora のライセンスを契約頂いているお客様限定で Sora Rust SDK の実装予定機能を有償にて前倒しで実装することです。

優先実装が可能な対応一覧

詳細は Discord やメールなどでお気軽にお問い合わせください

Windows arm64 対応

サポートについて

Discord

サポートしません
アドバイスします
フィードバック歓迎します

最新の状況などは Discord で共有しています。質問や相談も Discord でのみ受け付けています。

https://discord.gg/shiguredo

バグ報告

Discord へお願いします。

ライセンス

Apache License 2.0

Copyright 2026 Wandbox LLC (Original Author)
Copyright 2026 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.

OpenH264

https://www.openh264.org/BINARY_LICENSE.txt

"OpenH264 Video Codec provided by Cisco Systems, Inc."

NVIDIA Video Codec SDK

https://docs.nvidia.com/video-technologies/video-codec-sdk/13.0/index.html

https://docs.nvidia.com/video-technologies/video-codec-sdk/13.0/license/index.html

“This software contains source code provided by NVIDIA Corporation.”

sora_sdk 2026.1.0