Meta Developers

As of April 2023 the Rooms API is deprecated and is no longer included in the list of available Platform APIs for integration. For more information click here.

Third-party solutions, such as Photon, can be used as an alternative to implement Rooms in your app. For an example of how Photon, and other third-party solutions integrate with the Platform API, check here.

Use the Platform VoIP service to add voice chat to your app.

The VoIP service transmits PCM (pulse-code modulation) data between users, which the Platform SDK decodes to audio.

VoIP is peer-to-peer so your app will be limited by bandwidth in most cases. In general, the VoIP service becomes unstable if you have 12 or more connections. You should have 8 or less 8 connections on Rift and 4 or less on mobile apps. You may be able to support more if you use push to talk or some proximity-type muting.

Note

VoIP data may be routed through relay servers located inside Meta's infrastructure when connecting to client devices that are behind network address translation (NAT), if a connection cannot be established from their detected external address. The VoIP data passing through a relay server is not inspected any more than is necessary to forward to the recipient; nor is it retained.

This is a Platform SDK feature requiring Data Use Checkup

To use this or any other Platform SDK feature, you must complete a Data Use Checkup (DUC). The DUC ensures that you comply with Developer Policies. It requires an administrator from your organization to certify that your use of user data aligns with platform guidelines. Until the app review team reviews and approves your DUC, platform features are only available for test users.

Implementation Overview

To integrate VoIP in your Unreal app, call the functions below once you’ve established the online session. You can call these functions from anywhere in your code that you’d like. See Epic’s Online::GetVoiceInterface page for more information.

First, if you are releasing your application for the Quest, you need to add the RECORD_AUDIO permission to your APK package. You can toggle this permission in Project Settings > Platforms > Android > Advanced APK Packaging > Add permissions to support Voice chat (RECORD_AUDIO).

Then, to enable VoIP in DefaultEngine.ini:

[OnlineSubsystem]
DefaultPlatformService=Oculus
bHasVoiceEnabled=true
[Voice]
bEnabled=true

In the session, you can retrieve an array of the players in the session and their corresponding FUniqueNetIdOculus.

To connect to someone else:

Online::GetVoiceInterface()->RegisterRemoteTalker(<FUniqueNetIdOculus>);

To disconnect from someone:

Online::GetVoiceInterface()->UnregisterRemoteTalker(<FUniqueNetIdOculus>);

To see if a remote user is talking:

Online::GetVoiceInterface()->IsRemotePlayerTalking(<FUniqueNetIdOculus>);

To unmute yourself:

Online::GetVoiceInterface()->StartNetworkedVoice(0);

To mute yourself:

Online::GetVoiceInterface()->StopNetworkedVoice(0);

Note: In your DefaultGame.ini file, there may be a PushToTalk value that defaults to True. This will require users to press a specified button to talk. Disable this to allow users to talk without pressing a button.

Did you find this page helpful?