Skip to main content

WebRTC SFU Sora Python SDK

Project description

Sora Python SDK

PyPI image License Actions status

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 JetPack SDK に対応
  • Intel / Apple / NVIDIA のハードウェアデコーダー/エンコーダーに対応
    • Intel VPL (AV1 / H.264 / H.265)
    • Apple Video Toolbox (H.264 / H.265)
    • NVIDIA Video Codec SDK (VP9 / H.264 / H.265)
    • NVIDIA Jetson JetPack SDK (AV1 / H.264 / H.265)
  • OpenH264 を利用した H.264 のソフトウェアエンコーダー/デコーダーに対応
  • 物体検出などの入力に Sora 経由で受信した映像が利用できる
  • 音声認識などの入力に Sora 経由で受信した音声を利用できる
  • pip install sora_sdk でインストール可能

利用イメージ

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

ドキュメント

Sora Python SDK

サンプル集

examples を参照してください。

sora_sdk パッケージの追加

pip

pip install sora_sdk

Rye

Rye

rye add sora_sdk
rye sync

NVIDIA Jetson 向けパッケージ

PyPI 経由ではインストールできません。 パッケージバイナリを配布しておりますので、そちらをご利用ください。

システム条件

  • WebRTC SFU Sora 2023.2.0 以降
  • Python 3.10 以上

対応プラットフォーム

  • Windows 11 x86_64
  • Windows Server 2022 x86_64
  • macOS Ventura 14 arm64
  • macOS Sonoma 13 arm64
  • Ubuntu 24.04 LTS x86_64
  • Ubuntu 22.04 LTS x86_64
  • Ubuntu 22.04 LTS arm64 (NVIDIA Jetson JetPack SDK 6)
    • PyPI からではなくパッケージファイルを利用してください

対応機能

優先実装

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

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

優先実装が可能な機能一覧

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

  • Windows 11 arm64
  • Ubuntu 24.04 arm64
  • Ubuntu 22.04 arm64
  • Ubuntu 20.04 arm64 (NVIDIA Jetson JetPack SDK 5)
  • AMD Video Core Next (VCN) 対応
    • VP9 / AV1 / H.264 / H.265
  • Python 3.9 以前への対応

サポートについて

Discord

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

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

https://discord.gg/shiguredo

バグ報告

Discord へお願いします。

ライセンス

Apache License 2.0

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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sora_sdk-2024.3.0.tar.gz (6.4 MB view details)

Uploaded Source

Built Distributions

sora_sdk-2024.3.0-cp312-cp312-win_amd64.whl (7.7 MB view details)

Uploaded CPython 3.12 Windows x86-64

sora_sdk-2024.3.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (8.6 MB view details)

Uploaded CPython 3.12 manylinux: glibc 2.17+ x86-64

sora_sdk-2024.3.0-cp312-cp312-macosx_14_0_arm64.whl (6.4 MB view details)

Uploaded CPython 3.12 macOS 14.0+ ARM64

sora_sdk-2024.3.0-cp312-cp312-macosx_13_0_arm64.whl (6.4 MB view details)

Uploaded CPython 3.12 macOS 13.0+ ARM64

sora_sdk-2024.3.0-cp311-cp311-win_amd64.whl (7.7 MB view details)

Uploaded CPython 3.11 Windows x86-64

sora_sdk-2024.3.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (8.6 MB view details)

Uploaded CPython 3.11 manylinux: glibc 2.17+ x86-64

sora_sdk-2024.3.0-cp311-cp311-macosx_14_0_arm64.whl (6.4 MB view details)

Uploaded CPython 3.11 macOS 14.0+ ARM64

sora_sdk-2024.3.0-cp311-cp311-macosx_13_0_arm64.whl (6.4 MB view details)

Uploaded CPython 3.11 macOS 13.0+ ARM64

sora_sdk-2024.3.0-cp310-cp310-win_amd64.whl (7.7 MB view details)

Uploaded CPython 3.10 Windows x86-64

sora_sdk-2024.3.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (8.6 MB view details)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

sora_sdk-2024.3.0-cp310-cp310-macosx_14_0_arm64.whl (6.4 MB view details)

Uploaded CPython 3.10 macOS 14.0+ ARM64

sora_sdk-2024.3.0-cp310-cp310-macosx_13_0_arm64.whl (6.4 MB view details)

Uploaded CPython 3.10 macOS 13.0+ ARM64

File details

Details for the file sora_sdk-2024.3.0.tar.gz.

File metadata

  • Download URL: sora_sdk-2024.3.0.tar.gz
  • Upload date:
  • Size: 6.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for sora_sdk-2024.3.0.tar.gz
Algorithm Hash digest
SHA256 7281a8c04d4ad2b9c4c888fc9378bfb6a8c5bd971c8079468c347598da113488
MD5 6a252b5c33538ddb1c0b6c02003854c2
BLAKE2b-256 493d99d197a3a78cf27290b77d7656757a2106f5150f51ff80145732d780af69

See more details on using hashes here.

File details

Details for the file sora_sdk-2024.3.0-cp312-cp312-win_amd64.whl.

File metadata

File hashes

Hashes for sora_sdk-2024.3.0-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 9cffbbb651d452f68b9d4c557dd36f1bc0cf0b4bc355e30509922186e384afb8
MD5 daba5f6e8d364348559662d727d441f1
BLAKE2b-256 d7c456b2c8ca03eabebd7e6c5b10658f36c121c15ccc46a66c033b9140c3bb0f

See more details on using hashes here.

File details

Details for the file sora_sdk-2024.3.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for sora_sdk-2024.3.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 3ec95e22fdf405c55e8e5d9fa775c3306f7778929b7c87bf03786c8e9b145688
MD5 b177909a3c3d695486b62fc3652062d1
BLAKE2b-256 1db3492b2994516cec9f060cf265c4d441fbfacc95b2361212b103477a0c7707

See more details on using hashes here.

File details

Details for the file sora_sdk-2024.3.0-cp312-cp312-macosx_14_0_arm64.whl.

File metadata

File hashes

Hashes for sora_sdk-2024.3.0-cp312-cp312-macosx_14_0_arm64.whl
Algorithm Hash digest
SHA256 6bf16bd78fc9d69c1ba600a6e30097937565042f516e0602b1fcd5a17c982062
MD5 b7744e98c0e18da4687eacc4351cee58
BLAKE2b-256 bcc1064483f1e5c929ad674887ba0bfaa9c288e00a8224be4df636e05df9111c

See more details on using hashes here.

File details

Details for the file sora_sdk-2024.3.0-cp312-cp312-macosx_13_0_arm64.whl.

File metadata

File hashes

Hashes for sora_sdk-2024.3.0-cp312-cp312-macosx_13_0_arm64.whl
Algorithm Hash digest
SHA256 5e11b8f262e7fb0e5be171de016a16e98695ab51ad060b3c02b98c987a2521de
MD5 c3c262332e903f2b6bf0b0d83c0af54d
BLAKE2b-256 061a82fe232fc0e7adbca7c20d277d78cbc728911f1f44eda87d06247458c2f9

See more details on using hashes here.

File details

Details for the file sora_sdk-2024.3.0-cp311-cp311-win_amd64.whl.

File metadata

File hashes

Hashes for sora_sdk-2024.3.0-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 8d20aba0d9f962ad5b2319f1813841ee7321714cfdcf842a5f8abbef4fb904c9
MD5 9952d3d672acb3464fc2c1de51a4adf5
BLAKE2b-256 86cf4da900604e2f750f0dcc4c9eb85b0603b9edc7d984e119876a96637a1639

See more details on using hashes here.

File details

Details for the file sora_sdk-2024.3.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for sora_sdk-2024.3.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 d0c21ade90c9773f06c060632e40301135bdad1dc83b37e94a57d7077b6c5ec0
MD5 04b5c201aee14ed71cbdd7c94b5621f5
BLAKE2b-256 03a3675e39fb9b58f4c54d57ce9192ee0d05cb4a5e752a1aaf58cf887e28bbda

See more details on using hashes here.

File details

Details for the file sora_sdk-2024.3.0-cp311-cp311-macosx_14_0_arm64.whl.

File metadata

File hashes

Hashes for sora_sdk-2024.3.0-cp311-cp311-macosx_14_0_arm64.whl
Algorithm Hash digest
SHA256 f6cb4900b19d80b447a04eb41cd81b1abb4381952cf79550e9aa85260da95e38
MD5 b09ebd14494f111b7e35f7931c2cf65f
BLAKE2b-256 439b3cc3fae3089e9e06aeddb7a3f5211b34fbb390a79e5e4df669d190370e67

See more details on using hashes here.

File details

Details for the file sora_sdk-2024.3.0-cp311-cp311-macosx_13_0_arm64.whl.

File metadata

File hashes

Hashes for sora_sdk-2024.3.0-cp311-cp311-macosx_13_0_arm64.whl
Algorithm Hash digest
SHA256 f1750d14d04be8b214e78e1f6d3e24b926b09cbfb5257656522ff4b3b6809919
MD5 0f3682750545cb64e3dbdd871cfb719d
BLAKE2b-256 01a44b5bc365bbcd6b62b8f331a9dce21b9d23b478bae85dabc277f980d7e75c

See more details on using hashes here.

File details

Details for the file sora_sdk-2024.3.0-cp310-cp310-win_amd64.whl.

File metadata

File hashes

Hashes for sora_sdk-2024.3.0-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 5f3298c18bcbed602fe05208710755a60c8c89e3f9b0bd9881495eecf04e6d6a
MD5 80ad086ed1b659dc49ddd8f5f046bade
BLAKE2b-256 47609a6404308804ade753aadefcd0080325c739584dbd8daf9865d2ab9304bd

See more details on using hashes here.

File details

Details for the file sora_sdk-2024.3.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for sora_sdk-2024.3.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 24b83e0d215aa3cca63ddfb113d9b113e9698767bc2be613eb1d00a34e743be4
MD5 25ce97a89f77d701ef69eeaf49f7feb8
BLAKE2b-256 60d2893f4064cf27018aed6636880516066592e830c679b63f31b2c9dafab314

See more details on using hashes here.

File details

Details for the file sora_sdk-2024.3.0-cp310-cp310-macosx_14_0_arm64.whl.

File metadata

File hashes

Hashes for sora_sdk-2024.3.0-cp310-cp310-macosx_14_0_arm64.whl
Algorithm Hash digest
SHA256 367a4f00fe0ecf2c98f7fb80659716d789a39b5d3a6a2887879753a8b3cf12b8
MD5 c406bc7c4b76d10d55a62cf1b29f97e0
BLAKE2b-256 c8fb366126617b49c98bd18e1caf490588cb9b13193526ba2235ad2d2f65dc49

See more details on using hashes here.

File details

Details for the file sora_sdk-2024.3.0-cp310-cp310-macosx_13_0_arm64.whl.

File metadata

File hashes

Hashes for sora_sdk-2024.3.0-cp310-cp310-macosx_13_0_arm64.whl
Algorithm Hash digest
SHA256 24b524b68b37480eee639827cb438550a17b8e86ef0db2c338c198328a34c74b
MD5 42c7ce2a0a3f8fd0f401dd05661032c9
BLAKE2b-256 5d8cd6160044aae45b38f5f6b0603b5ebe3388106a7332a04482f755c00cbda4

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page