Documentation

Support

Vivox Core SDK

Vivox Core SDK

Required entitlements and Info.plist settings for macOS apps

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

The following Info.plist property and entitlements need to be used for the Vivox SDK to work on macOS devices.

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.

Entitlements

When shipping an application through the Mac App Store, you must include the
com.apple.security.device.microphone
entitlement. Add this entitlement for your app to use the device’s microphone if you are shipping a sandboxed app in the Mac App Store.
When shipping an app that’s notarized and shipped outside the Mac App Store, use the
com.apple.security.device.audio-input
entitlement. Add this entitlement for your app to use the device's microphone if you are shipping with Hardened Runtime enabled to ship outside Apple's Mac App Store.
You can view code samples for these settings and entitlements in the SDKSampleApp under /Source/MediaCaptureAuth.cpp in the macOS 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 macOS.