Skip to content

Latest commit

 

History

History
181 lines (115 loc) · 5.84 KB

README.md

File metadata and controls

181 lines (115 loc) · 5.84 KB

メッセージング受信サンプルを使ってみる

概要

WebRTC SFU Sora の メッセージング機能 を使って送信されたメッセージを受信して、標準出力にメッセージのラベルとデータサイズを表示するサンプルです。

動作環境

動作環境 をご確認ください。

接続先として WebRTC SFU Sora サーバ が必要です。対応 Sora をご確認ください。

サンプルをビルドする

以下にそれぞれのプラットフォームでのビルド方法を記載します。

ビルドに関しての問い合わせは受け付けておりません。うまくいかない場合は GitHub Actions の内容をご確認ください。

リポジトリをクローンする

sora-cpp-sdk をクローンして、examples 以下のディレクトリを利用してください。

develop ブランチは開発ブランチであり、ビルドが失敗することがあるため、 main またはリリースタグを指定するようにしてください。

以下は main ブランチを指定する例です。

git clone -b main https://github.com/shiguredo/sora-cpp-sdk.git
cd sora-cpp-sdk/examples

メッセージング受信サンプルをビルドする

Windows x86_64 向けのビルドをする

事前準備

以下のツールを準備してください。

  • Visual Studio 2022
    • C++ をビルドするためのコンポーネントを入れてください。
  • Python 3.10.5
ビルド
> python3 messaging_recvonly_sample\windows_x86_64\run.py

成功した場合、_build\windows_x86_64\release\messaging_recvonly_sample\Release に messaging_recvonly_sample.exe が作成されます。

\_BUILD\WINDOWS_X86_64\RELEASE\MESSAGING_RECVONLY_SAMPLE\RELEASE
    messaging_recvonly_sample.exe

macOS arm64 向けのビルドをする

事前準備

以下のツールを準備してください。

  • Python 3.12.4
ビルド
python3 messaging_recvonly_sample/macos_arm64/run.py

成功した場合、_build/macos_arm64/release/messaging_recvonly_sample に messaging_recvonly_sample が作成されます。

_build/macos_arm64/release/messaging_recvonly_sample
└── messaging_recvonly_sample

Ubuntu 20.04 x86_64 向けのビルドをする

事前準備

必要なパッケージをインストールしてください。

sudo apt install build-essential libx11-dev pkg-config python3
ビルド
python3 messaging_recvonly_sample/ubuntu-20.04_x86_64/run.py

成功した場合、_build/ubuntu-20.04_x86_64/release/messaging_recvonly_sample に messaging_recvonly_sample が作成されます。

_build/ubuntu-20.04_x86_64/release/messaging_recvonly_sample/
└── messaging_recvonly_sample

Ubuntu 22.04 x86_64 向けのビルドをする

事前準備

必要なパッケージをインストールしてください。

sudo apt install build-essential libx11-dev pkg-config python3
ビルド
python3 messaging_recvonly_sample/ubuntu-22.04_x86_64/run.py

成功した場合、以下のファイルが作成されます。_build/ubuntu-22.04_x86_64/release/messaging_recvonly_sample に messaging_recvonly_sample が作成されます。

_build/ubuntu-22.04_x86_64/release/messaging_recvonly_sample/
└── messaging_recvonly_sample

Ubuntu 24.04 x86_64 向けのビルドをする

事前準備

必要なパッケージをインストールしてください。

sudo apt install build-essential libx11-dev pkg-config python3
ビルド
python3 messaging_recvonly_sample/ubuntu-24.04_x86_64/run.py

成功した場合、以下のファイルが作成されます。_build/ubuntu-24.04_x86_64/release/messaging_recvonly_sample に messaging_recvonly_sample が作成されます。

_build/ubuntu-24.04_x86_64/release/messaging_recvonly_sample/
└── messaging_recvonly_sample

実行する

コマンドラインから必要なオプションを指定して実行します

ビルドされたバイナリのあるディレクトリに移動して、コマンドラインから必要なオプションを指定して実行します。 以下は Sora サーバのシグナリング URL wss://sora.example.com/signaling の sora チャンネルに接続する例です。 デフォルトでは #sora-devtools ラベルのメッセージが受信対象となります。

Windows の場合

> .\messaging_recvonly_sample.exe --signaling-url wss://sora.example.com/signaling --channel-id sora

Windows 以外の場合

./messaging_recvonly_sample --signaling-url wss://sora.example.com/signaling --channel-id sora

Sora に関するオプション

設定内容については Sora のドキュメント も参考にしてください。

  • --signaling-url : Sora サーバのシグナリング URL (必須)
  • --channel-id : channel_id (必須)
    • 任意のチャンネル ID
  • --data-channels : 受信対象のデータチャネルのリストを JSON 形式で指定します
    • 未指定の場合は [{"label":"#sora-devtools", "direction":"recvonly"}] が設定されます
    • 指定可能な内容については Sora のドキュメントの "type": "connect" 時の "data_channels" を参照してください

その他のオプション

  • --help
    • ヘルプを表示します