Sora JavaScript SDK ドキュメント

このドキュメントは Sora JavaScript SDK バージョン 2024.2.2 に対応しています。

Sora 自体の製品お問い合わせは sora at shiguredo dot jp までお願い致します。 (このメールアドレスへの特定電子メールの送信を拒否いたします)

シングルページ版

すべてのコンテンツを 1 つのページで表示できる、シングルページ版は こちら にあります。

問い合わせについて

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

https://discord.gg/shiguredo

Sora JavaScript SDK に対する有償のサポートについては提供しておりません。

注意事項

Sora JavaScript SDK 2024.2.0 以降は Compression Stream API を利用しています。 そのため、 Apple Safari の場合はバージョン 16.4 以降が必要です。

詳細は 対応ブラウザについて をご確認ください。

お知らせ

• リリースノート
• Sora JavaScript SDK 概要
• FAQ

利用

• インストール
  • インストール方法
    • npm
    • pnpm
  • 使用方法
• チュートリアル
  • プロジェクトの作成
  • sora-js-sdk の追加
    • jose について
  • Vite と TypeScript を最新にする
  • 不要なファイルの削除
  • index.html の変更
  • .env.local の作成
    • Sora を自前で立てる場合
    • Sora Cloud
    • Sora Labo
  • src/client.ts の追加
  • src/vite-env.d.ts の変更
  • src/main.ts の変更
  • 起動
• サンプル
  • 概要
  • Vite
    • .env または .env.local
    • VITE_SORA_SIGNALING_URL
    • VITE_SORA_CHANNEL_ID
    • VITE_SORA_CHANNEL_ID_PREFIX
    • VITE_SORA_CHANNEL_ID_SUFFIX
    • VITE_SECRET_KEY
    • vite-env.d.ts
  • jose
    • インストール
    • JWT 生成するコード
  • チャネル ID の生成
  • 送受信で接続する
  • 送信のみで接続する
  • 受信のみで接続する
  • 接続して 5 秒後に切断する
  • サイマルキャストを有効にして接続する
  • スポットライトで接続する
  • 音声や映像コーデックを指定する
  • 音声や映像のビットレートを指定する
  • 映像コーデックパラメーターを指定する
  • 映像と音声の可否を指定する
  • クライアントIDを指定する
  • DataChannel 経由のシグナリングを使用する
  • メッセージング機能を使用する
  • シグナリング通知機能を使用する

API

• API リファレンス
  • Sora
  • SoraConnection
  • ConnectionPublisher / ConnectionSubscriber / ConnectionMessaging
• コールバック
  • track
  • removetrack
  • disconnect
  • push
  • notify
  • timeout
  • message
  • datachannel
  • signaling
  • log
  • timeline
  • シーケンス図
  • typedocs

サービス

• Sora Labo
  • Sora Labo にサインアップする
  • Sora JavaScript SDK のサンプルを動かしてみる

その他

• 古いリリースノート

コンテンツ

• Sora JavaScript SDK ドキュメント
  • シングルページ版
  • 問い合わせについて
  • 注意事項