Voice Interface Sample - C SDK

この ボイス サンプル (Voice Sample) は、C SDK 用のクライアントとサーバーのアプリケーションを使用してセキュアな ボイス チャット システム を実装する方法の実例を示しています。

このサンプルには以下の機能が含まれています。

• 他のユーザーが参加しているルームにユーザーが参加できるようにするトークンをリクエストする (サーバー経由)
• フレンドや他のユーザーが参加しているルームに参加する
• ルームから退出する
• 自分の音声をミュートにする
• 他のユーザーの音声をミュートにする (サーバー経由、ルームの所有者のみが可能)
• 他のユーザーをルームから追い出す (サーバー経由、ルームの所有者のみが可能)
• ユーザーの発言時やミュート時にステータスの更新を表示する
• オーディオ入力/出力デバイスを変更する

このセクションでは、32 ビットおよび 64 ビットの Windows オペレーティング システム用の Voice クライアントのサンプル アプリケーションのビルドおよび実行について説明します。

1. 「EOS-SDK.zip」を任意の場所に解凍します。
2. 「EOS-SDK\Samples」フォルダに移動します。
3. Samples.sln をダブルクリックすると、Visual Studio の [ソリューション エクスプローラ] にサンプルが表示されます。
4. [スタートアップ プロジェクト] を [Voice] に設定します。
5. SampleConstants.h を開き、自分のテスト アプリの値に合わせて、ProductId、SandboxId、DeploymentId、ClientCredentialsId、および ClientCredentialsSecret を変更します。
6. [ソリューション構成] で Release_DX または Debug_DX を選択します。
7. [ソリューション プラットフォーム] で [x64 (Win64)] または [x86 (Win32)] を選択します。
8. [ソリューション エクスプローラ] で、Voice プロジェクトを右クリックして [ビルド] を選択します。
9. ビルドが正常に終了すると、「\EOS-SDK\Samples\Voice\Client\Bin\Win64\Release_DX\」フォルダに「Voice.exe」が作成されています。

これで、サンプル アプリケーションを実行できるようになりました。

Voice クライアントのサンプル アプリケーションを実行するには、以下の手順に従います。

1. 「\EOS-SDK\Samples\Voice\Client\Bin\Win64\Release_DX\」フォルダに移動します。
2. Voice.exe を実行します。
3. サーバーのリッスン ポートを変更するには、-serverport <port> を追加します。
4. サーバーの URL を変更するには、-serverurl <url>を追加します。

Voice クライアントのサンプル アプリケーションを MacOS でビルドするには、次の依存関係をインストールする必要があります。

• SDL2
• SDL2_ttf
• GLEW
• cmake
• gcc (Mac 用の Xcode コマンドライン ツールを使用)

1. 「EOS-SDK.zip」を任意の場所に解凍します。
2. ターミナルで「/EOS-SDK/Samples/Voice/Client/」に移動します。
3. SampleConstants.h を開き、自分のテスト アプリの値に合わせて、ProductId、SandboxId、DeploymentId、ClientCredentialsId、および ClientCredentialsSecret を変更します。
4. 「./Build.sh」と入力して実行します (または、Mac の Finder で Build.command を実行します)。
5. ビルドが正常に終了すると、「/EOS-SDK/Samples/Voice/Client/Build/」フォルダに複数のファイルが新規作成されています。

これで、サンプル アプリケーションを実行できるようになりました。

サンプル アプリケーションを実行するには、以下の手順に従います。

1. 「/EOS-SDK/Samples/Voice/Client/」に移動します。
2. 「./Run.sh」と入力して実行します (または、Mac の Finder で Run.command を実行します)。
3. サーバーのリッスン ポートを変更するには、-serverport <port> を追加します。
4. サーバーの URL を変更するには、-serverurl <url>を追加します。

デベロッパー認証ツール にログインするには、[Dev Auth] オプションを選択してから [Log In (ログイン)] を選択します。ログインすると、Voice クライアントのサンプル アプリケーションには以下のオプションがあります。

[JOIN] を選択すると、ルーム参加プロセスが開始されます。ルームの参加するために使用するルーム参加トークンを取得するためのリクエストがサーバー経由で行われます。

現在のルームには他にプレイヤーはいないので、新規ルームが作成されて、そのルームに自分が追加されます。[Room:] ボックスに RoomId が表示され、[ROOM MEMBERS] テーブルが更新されて、自分がルームに追加されたことが表示されます。

[LEAVE] をクリックすると、現在メンバーである現在のルームを退出します。

[MUTE] は、ローカル ユーザーのみが使用可能であり、をクリックすると、自分の音声がミュートになります。音声がミュートになると、音声ステータス アイコンが次のような赤色に変化します。

ルームの所有者であれば、ユーザーをミュートにするオプションおよびユーザーを現在のルームから追い出すオプションがあります。

[REMOTE MUTE] をクリックすると、そのユーザーがミュートになります。

[KICK] をクリックすると、そのユーザーが現在のルームから追い出されます。新しいルーム参加トークンをリクエストして付与されない限り、そのユーザーはそのルームに再度参加することはできません。

フレンド リストでフレンドの名前の横にある [CHAT] をクリックすると、そのフレンドのルームに自分が追加されて、そのフレンドとチャットできるようになります。

[SETUP (セットアップ)] ダイアログのドロップダウン メニューを使用して、入力と出力のオーディオ デバイスを変更することができます。

ユーザーが発言しているときは、音声ステータス アイコンが次のような緑色の完全なスピーカーに変化します。

• 使用法：“JOIN ROOM_NAME”。
• ローカル ユーザーのルーム参加プロセスを開始します。
• ROOM_NAME を指定していれば、そのルームに参加します (許可されている場合)。
• ROOM_NAME を指定していなければ、新規ルームが作成されて、そのルームに参加します。

• 使用法：“LEAVE”。
• ローカル ユーザーが現在のルームから退出します。

• 使用法：“KICK USER_ID”。
• 現在のルームからユーザーを追い出します。
• 自分がルーム所有者でない場合は、何も行われません。
• USER_ID は ProductUserId です。

• 使用法：“REMOTEMUTE USER_ID MUTE”。
• ユーザーのリモート ミュート状態を設定します。
• 自分がルーム所有者でない場合は、何も行われません。
• USER_ID は ProductUserId です。
• MUTE が「1」であればミュートになり、「0」であればミュートが解除されます。

このセクションでは、32 ビットおよび 64 ビットの Windows オペレーティング システム用の Voice サーバーのサンプル アプリケーションのビルドおよび実行について説明します。

1. 「EOS-SDK.zip」を任意の場所に解凍します。
2. 「\EOS-SDK\Samples\」フォルダに移動します。
3. Samples.sln をダブルクリックすると、Visual Studio の [ソリューション エクスプローラ] にサンプルが表示されます。
4. [スタートアップ プロジェクト] を [VoiceServer] に設定します。
5. SampleConstants.h を開き、自分のテスト アプリの値に合わせて、ProductId、SandboxId、DeploymentId、ClientCredentialsId、および ClientCredentialsSecret を変更します。
6. [ソリューション構成] で Release または Debug を選択します。
7. [ソリューション プラットフォーム] で [x64 (Win64)] または [x86 (Win32)] を選択します。
8. [ソリューション エクスプローラ] で、VoiceServer プロジェクトを右クリックして [ビルド] を選択します。
9. ビルドが正常に終了すると、「\EOS-SDK\Samples\Voice\Server\Bin\Win64\Release\」フォルダに「VoiceServer.exe」が作成されています。

これで、サンプル アプリケーションを実行できるようになりました。

Voice サーバーのサンプル アプリケーションを実行するには、以下の手順に従います。

1. 「\EOS-SDK\Samples\Voice\Server\Bin\Win64\Release\」フォルダに移動します。
2. VoiceServer.exe を実行します。
3. サーバーのリッスン ポートを変更するには、-voiceserverport <port> を追加します。
4. サーバーの URL を変更するには、 -voiceserverurl <url> を追加します。

Voice サーバーのサンプル アプリケーションを MacOS でビルドするには、次の依存関係をインストールする必要があります。

• cmake
• gcc (Mac 用の Xcode コマンドライン ツールを使用)

1. 「EOS-SDK.zip」を任意の場所に解凍します。
2. ターミナル で「/EOS-SDK/Samples/Voice/Server/」に移動します。
3. SampleConstants.h を開き、自分のテスト アプリの値に合わせて、ProductId、SandboxId、DeploymentId、ClientCredentialsId、および ClientCredentialsSecret を変更します。
4. 「./Build.sh」と入力して実行します (または、Mac の Finder で Build.command を実行します)。
5. ビルドが正常に終了すると、「/EOS-SDK/Samples/Voice/Server/Build/」フォルダに複数のファイルが新規作成されています。

これで、サンプル アプリケーションを実行できるようになりました。

サンプル アプリケーションを実行するには、以下の手順に従います。

1. 「/EOS-SDK/Samples/Voice/Server/」に移動します。
2. 「./Run.sh」と入力して実行します (または、Mac の Finder で Run.command を実行します)。
3. サーバーのリッスン ポートを変更するには、-voiceserverport <port> を追加します。
4. サーバーの URL を変更するには、 -voiceserverurl <url> を追加します。

Voice サーバーはコンソール ベースのアプリケーションであるため、GUI 要素はなく、デバッグ テキストがコンソールとデバッグ ログファイル (デフォルトでは、「DebugOutput.log」) に出力されます。エラーは 赤色の テキストで出力され、警告は 黄色の テキストで出力されます。

Voice サーバー アプリケーションを開始すると実行されたままになり、複数のクライアントからのリクエストが処理されます。

サーバー アプリケーションを停止するには、Ctrl+C キーを押します。