> For the complete documentation index, see [llms.txt](https://docs.edgegap.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.edgegap.com/fr/docs/tools-and-integrations/eos-voice-chat.md).

# Chat vocal EOS

Ajoutez le chat vocal Epic Online Services aux joueurs appariés dans un jeu Unreal Engine, avec le serveur dédié Edgegap comme serveur vocal de confiance.

Ce guide montre comment notre [projet d'exemple Unreal Engine](https://github.com/edgegap/game-sample-unreal-engine-topdown) ajoute le chat vocal en jeu avec [EOS Voice](https://dev.epicgames.com/docs/epic-online-services/multiplayer/voice-and-rtc-interface/voice-interface/voice-overview) d'Epic Online Services. Les joueurs appariés par le [Edgegap Matchmaker](https://docs.edgegap.com/fr/learn/matchmaking.md) peuvent parler à leurs coéquipiers dans un salon vocal, et votre serveur dédié sur Edgegap décide qui rejoint quel salon.

Le chat vocal est **désactivé par défaut** dans l'exemple. Tant que vous ne l'activez pas, le jeu fonctionne comme décrit dans [Exemple Top-Down](https://docs.edgegap.com/fr/docs/sample-projects/unreal-engine/top-down-sample.md).

{% hint style="success" %}
**Nous vous recommandons de commencer par** [Unreal Engine](https://docs.edgegap.com/fr/unreal-engine.md) **le guide pour construire vos serveurs de jeu avant de continuer.**
{% endhint %}

## 🎙️ Comment ça fonctionne

Votre serveur dédié est le serveur EOS [de confiance](https://dev.epicgames.com/docs/epic-online-services/multiplayer/voice-and-rtc-interface/voice-interface/voice-overview#voice-with-a-trusted-server-application). Les clients de jeu ne détiennent jamais d'identifiants pouvant créer des salons vocaux.

### 1. Les joueurs se connectent à EOS

Le client de jeu connecte le joueur à EOS avec un ID d'appareil, donc les joueurs n'ont pas besoin de compte Epic. Il envoie ensuite au serveur son ID utilisateur de produit ainsi qu'un jeton d'ID EOS.

### 2. Le serveur vérifie le joueur

Le serveur vérifie le jeton d'ID à l'aide des clés publiques d'Epic, afin qu'un joueur ne puisse pas prétendre être quelqu'un d'autre. Il vérifie aussi que le jeton a été émis pour votre déploiement EOS.

### 3. Le serveur choisit le salon

Les noms des salons proviennent du match :

* le salon de base est nommé d'après l'ID de match du matchmaker (`MM_MATCH_ID`), ou d'après l'ID de déploiement pour un serveur que vous avez déployé manuellement,
* avec les salons d'équipe activés (par défaut, `bTeamRooms=True`), chaque équipe obtient son propre salon, nommé d'après le match et l'équipe.

Le serveur détermine l'équipe de chaque joueur à partir de [tickets du matchmaker injectés comme variables d'environnement](https://docs.edgegap.com/fr/learn/matchmaking/matchmaker-in-depth.md#injected-variables) - il fait correspondre l'IP depuis laquelle le joueur se connecte avec l'IP de chaque ticket, et lit l'équipe du ticket. **Il ne fait jamais confiance à une équipe envoyée par le client.** Les joueurs sans ticket correspondant (par exemple les joueurs connectés par IP) restent dans le salon de match. Définissez `bTeamRooms=False` pour mettre tout le match dans un seul salon.

### 4. Le serveur distribue un jeton de salon

Le serveur demande à [l'API Web EOS Voice](https://dev.epicgames.com/docs/web-api-ref/voice-web-api) un jeton de salon pour ce joueur, en transmettant l'IP du joueur afin qu'EOS utilise un serveur vocal proche de lui. Il envoie le jeton à ce joueur uniquement, et le client rejoint le salon avec le plugin EOSVoiceChat du moteur.

### 5. Le serveur retire les joueurs qui partent

Lorsqu'un joueur quitte le serveur, le serveur le retire de son salon vocal, ce qui révoque aussi son jeton. Le code du jeu peut aussi couper le micro d'un joueur pour tout le monde avec `UEdgegapVoiceServerSubsystem::SetHardMuted`.

{% hint style="info" %}
Votre mode de jeu et votre contrôleur de joueur ne changent pas. Lorsqu'un joueur se connecte (`PostLogin`), le serveur ajoute un petit composant répliqué, `UEdgegapVoiceComponent`, à son contrôleur de joueur. Il ne se réplique qu'auprès de son client propriétaire et transporte les `ServerRegisterVoice` et `ClientJoinVoiceRoom` RPC.
{% endhint %}

Le serveur appelle l'API Web EOS via HTTPS plutôt que le SDK EOS, car le SDK EOS ne prend pas en charge la voix sous Linux. Côté client, les builds sont pour Windows et Mac, où le plugin EOSVoiceChat existe.

| Fichier                       | Ce qu'il fait                                                                                          |
| ----------------------------- | ------------------------------------------------------------------------------------------------------ |
| `EdgegapVoiceSettings.h`      | L'interrupteur marche/arrêt et les options, depuis `DefaultGame.ini`                                   |
| `EdgegapVoiceClientSubsystem` | Connexion EOS avec ID d'appareil, jeton d'ID, rejoindre et quitter des salons                          |
| `EdgegapVoiceComponent`       | Ajouté à chaque joueur par le serveur, transporte les RPC voix                                         |
| `EdgegapVoiceServerSubsystem` | Vérification du jeton d'ID, choix du salon, appels à l'API Web EOS Voice, suppression à la déconnexion |

## ⚙️ Configuration

### 1. Créez des clients EOS

☑️ Ouvrez votre produit dans [le portail développeur Epic](https://dev.epicgames.com/portal), puis **Paramètres du produit**.

☑️ Notez votre ID de produit, votre ID de sandbox et votre ID de déploiement dans l'onglet **Téléchargement du SDK et identifiants**.

☑️ Ajoutez deux politiques dans l'onglet **Clients**, sous **Politiques client**:

* **Client de jeu** - type `GameClient`, **Utilisateur requis** coché, aucune autorisation Voice nécessaire,
* **Serveur de confiance** - **Créer une politique personnalisée**, **Utilisateur requis** décoché, avec les actions Voice `createRoomToken`, `kick` et `mute`.

☑️ Ajoutez un client pour chaque politique, et notez chaque ID client et secret client.

{% hint style="danger" %}
Le client de votre serveur de confiance peut créer un jeton pour n'importe quel salon de votre déploiement. **Ne le mettez jamais dans une version du jeu.**
{% endhint %}

✅ Vous pouvez maintenant passer à l'étape suivante.

### 2. Configurez le client de jeu

☑️ Remplissez `[EOSVoiceChat]` dans `MultiplayerGame/Config/UserEngine.ini` avec vos ID de produit, de sandbox et de déploiement, ainsi que votre **client de jeu** ID et secret. Ce fichier est ignoré par git et remplace `DefaultEngine.ini`, afin que vos identifiants restent hors du contrôle de version.

☑️ Activez la voix dans `MultiplayerGame/Config/UserGame.ini` (également ignoré par git) :

{% code collapsedlinecount="10" %}

```ini
[/Script/MultiplayerGame.EdgegapVoiceSettings]
bEnabled=True
```

{% endcode %}

✅ Vous pouvez maintenant passer à l'étape suivante.

### 3. Configurez le serveur

☑️ Ajoutez ces variables d'environnement à votre [version d'application](https://app.edgegap.com/application-management/applications/list), et marquez le secret comme masqué :

| Variable                   | Valeur                                                                                                                |
| -------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| `EOS_VOICE_CLIENT_ID`      | ID client du serveur de confiance                                                                                     |
| `EOS_VOICE_CLIENT_SECRET`  | Secret client du serveur de confiance                                                                                 |
| `EOS_VOICE_DEPLOYMENT_ID`  | ID de déploiement EOS (facultatif s'il est déjà dans `DefaultEngine.ini`)                                             |
| `EOS_VOICE_GAME_CLIENT_ID` | ID client du client de jeu, facultatif : le serveur n'accepte alors que les jetons d'ID émis pour votre client de jeu |

La voix est activée sur votre serveur une fois ces valeurs définies, donc vous n'avez pas besoin de reconstruire l'image de votre serveur. Pour un serveur exécuté localement, placez `ServerClientId` et `ServerClientSecret` dans `EdgegapVoiceSettings` section de `UserGame.ini` à la place.

✅ Vous pouvez maintenant passer à l'étape suivante.

### 4. Jouer

☑️ Créez de nouveau le package de votre serveur et de votre client, déployez, puis jouez. Avec le matchmaker activé, les coéquipiers partagent un salon.

☑️ Tapez `VoiceMute` dans la console pour couper ou réactiver votre microphone.

🙌 Félicitations, vos joueurs peuvent maintenant parler à leurs coéquipiers !

## 🧪 Test avec deux clients sur un seul PC

Un ID d'appareil appartient à l'utilisateur Windows, donc deux clients sur le même PC se connecteraient comme le même joueur EOS. Ajoutez `-EOSVoiceNewDeviceId` à la ligne de commande du deuxième client pour lui donner une nouvelle identité.

{% hint style="warning" %}
`-EOSVoiceNewDeviceId` crée un nouvel utilisateur EOS à chaque lancement, **utilisez-le uniquement pour les tests**. Lancez votre deuxième client seulement après que le premier se soit `Voix : connecté à EOS` - remplacer l'ID d'appareil alors que le premier client est encore en train de se connecter donne aux deux clients la même identité.
{% endhint %}

Pour vérifier que l'audio circule sans parler dans un microphone, démarrez un client avec `-ExecCmds="EOSVoiceChat.FakeAudioInputEnabled 1"` (builds de développement). Il envoie un signal de test, et l'autre client journalise `Voix : <id> a commencé à parler dans le salon <room>`.

Avec le matchmaker, les deux clients doivent se mettre en file d'attente à moins de 10 secondes d'intervalle, sinon le `occasionnel` profil lance un match solo. Les clients démarrent à des vitesses différentes, donc lancez les deux avec le même `-FindMatchAt=<unix time>` (par exemple deux minutes à l'avance) au lieu de `-FindMatch` - chacun se met en file d'attente à ce moment-là.

{% hint style="info" %}
Lignes de journal à rechercher (`LogEdgegapVoice`):

* serveur - `Voix : serveur vocal de confiance prêt`, puis `Voix : <id> obtient le salon <room>` pour chaque joueur, et `Voix : <id> supprimé` lorsqu'un joueur quitte,
* client - `Voix : connecté à EOS en tant que <id>`, `Voix : a rejoint le salon <room>`, et `Voix : <id> a commencé à parler`.
  {% endhint %}
