Skip to content

Commit

Permalink
chore(Android): Update readme.md with Gradle info.
Browse files Browse the repository at this point in the history
closes #335, closes #329
  • Loading branch information
llfbandit committed Jun 3, 2024
1 parent ac37e68 commit 0bc1bbe
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 1 deletion.
2 changes: 2 additions & 0 deletions record/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@ record.dispose(); // As always, don't forget this one.
## Setup, permissions and others

### Android
Plugin targets API level 34 uses Java 17. Follow [Gradle setup](https://github.com/llfbandit/record/blob/master/record_android/README.md) if needed.

```xml
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<!-- Optional: Add this permission if you want to use bluetooth telephony device like headset/earbuds -->
Expand Down
31 changes: 30 additions & 1 deletion record_android/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,32 @@
# record Android

Android specific implementation for record package called by record_platform_interface.
Android specific implementation for record package called by record_platform_interface.

## Setup
### Plugin targets API level 34:

You must set Android Gradle Plugin to at least version 8.1.1 for compatibility.

In android/settings.gradle, apply:
```groovy
plugins {
id "com.android.application" version "8.3.1" apply false
...
}
```

### Plugin uses Java 17:

You must set Gradle to at least version 7.3.0 for compatibility.

Since we raised Android Gradle Plugin, minimum is version 8.4.

In android/gradle/wrapper/gradle-wrapper.properties, apply:
```
distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-bin.zip
```

or use `android/gradle/gradlew wrapper --gradle-version=8.7`

For more info on how to update Gradle:
https://developer.android.com/build/releases/gradle-plugin

0 comments on commit 0bc1bbe

Please sign in to comment.