Documentation

Support

Vivox Core SDK

Vivox Core SDK

Required Info.plist settings for iOS apps

Review mandatory settings needed for iOS applications.
Read time 1 minuteLast updated 20 hours ago

The following Info.plist settings need to be used for the Vivox SDK to work on iOS devices.
UIBackgroundModes key
To stay connected to Vivox when an app is put in the background or if a device is locked, use the UIBackgroundModes Info.plist key and allow the audio setting. This setting allows users to continue to stream voice audio and use the microphone while the app is running in the background or the screen is off. The UIBackgroundModes key can be added to the Xcode project settings. If this setting is missing, the user will be disconnected from the channel and logged out after several seconds in the background, or the user will be logged out immediately when the device is locked. NSMicrophoneUsageDescription property The NSMicrophoneUsageDescription property must be included in your Info.plist in your Xcode project settings. Use it to describe what purpose your app will use the device’s microphone for; this will be displayed when requesting microphone permission. You can view code samples for these settings and entitlements in the SDKSampleApp under /Source/MediaCaptureAuth.cpp in the iOS distribution files. For more information, see How to: Request/check iOS & macOS microphone permission in Unity or Apple’s official documentation for requesting authorization of media capture on iOS.