Documentation

Support

Vivox Unreal SDK

Vivox Unreal SDK

Android Sdk Permission Requirements

Understand Android SDK permission requirements for Vivox.
Read time 1 minuteLast updated 2 days ago
The following permission requirements apply when working with the Vivox Android SDK:
  • Required 
    • android.permission.INTERNET
      - Allows communication with Vivox servers       
    • android.permission.RECORD_AUDIO
      - Allows microphone access       For more information, see the Android developer documentation on requesting app permissions.
  • Recommended 
    • android.permission.MODIFY_AUDIO_SETTINGS
       
    • android.permission.ACCESS_NETWORK_STATE
      - Allows access to network information       
    • android.permission.ACCESS_WIFI_STATE
      - Allows access to Wi-Fi information       
    • android.permission.BLUETOOTH
      - Allows access to Bluetooth devices on Android versions earlier than 12       
    • android.permission.BLUETOOTH_CONNECT
      - Allows access to Bluetooth devices on Android version 12 and later
The Vivox SDK plugin includes a UPL (Unreal Plugin Language) file, which complements the permissions that are defined by your project. Use this file to add or remove permissions. The UPL file is available at the following location: 
Your_Project_Path/Plugins/VivoxCore/Source/ThirdParty/VivoxCoreLibrary
 The UPL file includes the following permissions: 
  • INTERNET
  • RECORD_AUDIO
  • MODIFY_AUDIO_SETTINGS
  • ACCESS_NETWORK_STATE
  • BLUETOOTH
  • BLUETOOTH_CONNECT
When working with the UPL file, consider the following use cases:
  • You have a permission defined in your project and you want to keep it.
    • In this scenario, you can optionally remove the duplicated permission from the UPL file in order to keep one source of truth.
  • You need to define more permissions.
    • In this scenario, you can add permissions as necessary to the UPL file.
    • For example, if you need access to the network information, add the following permission to the UPL file: 
      <addPermission android:name="android.permission.ACCESS\_NETWORK\_STATE" />
  • You have a permission defined in your project and you want to remove it.
    • In this scenario, you can remove the permission from your manifest file.
    • If the manifest file is automatically generated, use the UPL file to remove the permission. For example, if you have the Bluetooth permission defined in your manifest file, remove the following permission with the UPL file: 
      <removePermission android:name="android.permission.BLUETOOTH "/>