Skip to content

Commit

Permalink
chore: Update iOS and Android permissions in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
xuelink committed May 25, 2024
1 parent 6ea6d0c commit a12f227
Showing 1 changed file with 18 additions and 3 deletions.
21 changes: 18 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,25 @@ npm install --save @langx/capacitor-voice-recorder
npx cap sync
```

#### ios note
## iOS

Make sure to include the `NSMicrophoneUsageDescription`
key, and a corresponding purpose string in your app's Info.plist
iOS requires the following usage description to be added and filled out for your app in `Info.plist`:

- `NSMicrophoneUsageDescription` (`Privacy - Microphone Usage Description`)

Read about [Configuring `Info.plist`](https://capacitorjs.com/docs/ios/configuration#configuring-infoplist) in the [iOS Guide](https://capacitorjs.com/docs/ios) for more information on setting iOS permissions in Xcode.

## Android

This API requires the following permission to be added to your `AndroidManifest.xml`:

```xml
<uses-permission android:name="android.permission.RECORD_AUDIO" />
```

The RECORD_AUDIO permission is for recording audio.

Read about [Setting Permissions](https://capacitorjs.com/docs/android/configuration#setting-permissions) in the [Android Guide](https://capacitorjs.com/docs/android) for more information on setting Android permissions.

## Configuration

Expand Down

0 comments on commit a12f227

Please sign in to comment.