Sora Python SDK

Sora Python SDK は WebRTC SFU Sora の Python クライアントアプリケーションを開発するためのライブラリです。Sora C++ 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/blob/master/README.en.md before use.

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

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

Sora Python SDK について

様々なプラットフォームに対応しすぐに使い始められる WebRTC SFU Sora 向けの Python SDK です。

特徴

• Sora C++ SDK ベース
• WebRTC 部分の機能は libwebrtc を採用
• Windows / macOS / Linux (Ubuntu)
• NVIDIA Jetson に対応
• ハードウェアデコーダー/エンコーダーに対応
• 物体検出などの入力に Sora 経由で受信した映像が利用できる
• 音声認識などの入力に Sora 経由で受信した音声を利用できる
• pip install sora_sdk でインストール可能

利用イメージ

• データチャンネルを利用して Python において映像、音声を解析した結果を Sora 経由で配信する
• Text to Speech の音声を Sora 経由で配信する
• 映像入力に対して Pillow などで加工した映像を Sora を経由で配信する
• A チャンネルの参加者からの映像と音声を B チャンネルに対して加工した上で Sora 経由で配信する

ドキュメント

Sora Python SDK

sora_sdk パッケージの追加

pip

$ pip install sora_sdk

Rye

Rye

$ rye add sora_sdk
$ rye sync

システム条件

• WebRTC SFU Sora 2023.1.0 以降
• Python 3.8 以上

対応プラットフォーム

• Windows 11 x86_64 以降
• macOS 13 arm64 以降
• Ubuntu 22.04 x86_64
• Ubuntu 20.04 arm64
  • Python 3.8 のみ対応
  • NVIDIA Jetson JetPack SDK 5 系

対応機能

• Sora の機能へ追従
• VP8 / VP9 / AV1 / H.264 のハードウェアアクセラレーター (HWA) 対応
• OpenH264 を利用した H.264 のソフトウェアエンコーダー/デコーダーへの対応
  • Ubuntu 22.04 x86_64 でのみ対応

優先実装

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

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

• DataChannel 対応
  • アダワープジャパン株式会社 様

サポートについて

Discord

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

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

https://discord.gg/shiguredo

バグ報告

Discord へお願いします。

ライセンス

Apache License 2.0

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

このリポジトリに含まれる shiguremaru.png ファイルのライセンスは CC BY-NC-ND 4.0 です。

OpenH264

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

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