- For Permission Handle:
Upgrade pre 1.12 Android projects
Since version 4.4.0 this plugin is implemented using the Flutter 1.12 Android plugin APIs. Unfortunately this means App developers also need to migrate their Apps to support the new Android infrastructure. You can do so by following the Upgrading pre 1.12 Android projects migration guide. Failing to do so might result in unexpected behaviour. Most common known error is the permission_handler not returning after calling the .request()
method on a permission.
AndroidX
As of version 3.1.0 the permission_handler plugin switched to the AndroidX version of the Android Support Libraries. This means you need to make sure your Android project is also upgraded to support AndroidX. Detailed instructions can be found here.
The TL;DR version is:
- Add the following to your "gradle.properties" file:
android.useAndroidX=true
android.enableJetifier=true
- Make sure you set the
compileSdkVersion
in your "android/app/build.gradle" file to 33:
android {
compileSdkVersion 33
...
}
- Make sure you replace all the
android.
dependencies to their AndroidX counterparts (a full list can be found here).
Add permissions to your AndroidManifest.xml
file.
There's a debug
, main
and profile
version which are chosen depending on how you start your app.
In general, it's sufficient to add permission only to the main
version.
Here's an example AndroidManifest.xml
with a complete list of all possible permissions.
- For Record Permission:
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<!-- Optional, you'll have to check this permission by yourself. -->
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
- min SDK: 19 (maybe higher => encoder dependent)
-
For Vibrate Permission:
Make sure you add the following permissions to your Android Manifest
<uses-permission android:name="android.permission.VIBRATE"/>
-
For Permission Handle:
Add permission to your
Info.plist
file. Here's an exampleInfo.plist
with a complete list of all possible permissions.IMPORTANT:
You will have to include all permission options when you want to submit your App.This is because thepermission_handler
plugin touches all different SDKs and because the static code analyser (run by Apple upon App submission) detects this and will assert if it cannot find a matching permission option in theInfo.plist
. More information about this can be found here.The permission_handler plugin use
macros
(https://github.com/Baseflow/flutter-permission- handler/blob/master/permission_handler_apple/ios/Classes/PermissionHandlerEnums.h) to control whether a permission is enabled.You must list permission you want to use in your application :
-
Add the following to your
Podfile
file:post_install do |installer| installer.pods_project.targets.each do |target| ... # Here are some configurations automatically generated by flutter # Start of the permission_handler configuration target.build_configurations.each do |config| # You can enable the permissions needed here. For example to enable camera # permission, just remove the `#` character in front so it looks like this: # # ## dart: PermissionGroup.camera # 'PERMISSION_CAMERA=1' # # Preprocessor definitions can be found in: https://github.com/Baseflow/flutter-permission-handler/blob/master/permission_handler_apple/ios/Classes/PermissionHandlerEnums.h config.build_settings['GCC_PREPROCESSOR_DEFINITIONS'] ||= [ '$(inherited)', ## dart: PermissionGroup.calendar # 'PERMISSION_EVENTS=1', ## dart: PermissionGroup.reminders # 'PERMISSION_REMINDERS=1', ## dart: PermissionGroup.contacts # 'PERMISSION_CONTACTS=1', ## dart: PermissionGroup.camera # 'PERMISSION_CAMERA=1', ## dart: PermissionGroup.microphone # 'PERMISSION_MICROPHONE=1', ## dart: PermissionGroup.speech # 'PERMISSION_SPEECH_RECOGNIZER=1', ## dart: PermissionGroup.photos # 'PERMISSION_PHOTOS=1', ## dart: [PermissionGroup.location, PermissionGroup.locationAlways, PermissionGroup.locationWhenInUse] # 'PERMISSION_LOCATION=1', ## dart: PermissionGroup.notification # 'PERMISSION_NOTIFICATIONS=1', ## dart: PermissionGroup.mediaLibrary # 'PERMISSION_MEDIA_LIBRARY=1', ## dart: PermissionGroup.sensors # 'PERMISSION_SENSORS=1', ## dart: PermissionGroup.bluetooth # 'PERMISSION_BLUETOOTH=1', ## dart: PermissionGroup.appTrackingTransparency # 'PERMISSION_APP_TRACKING_TRANSPARENCY=1', ## dart: PermissionGroup.criticalAlerts # 'PERMISSION_CRITICAL_ALERTS=1' ] end # End of the permission_handler configuration end end
-
Remove the
#
character in front of the permission you do want to use. For example if you need access to the calendar make sure the code looks like this:## dart: PermissionGroup.calendar 'PERMISSION_EVENTS=1',
-
Delete the corresponding permission description in
Info.plist
e.g. when you don't need camera permission, just delete 'NSCameraUsageDescription' The following lists the relationship betweenPermission
andThe key of Info.plist
:Permission Info.plist Macro PermissionGroup.calendar NSCalendarsUsageDescription PERMISSION_EVENTS PermissionGroup.reminders NSRemindersUsageDescription PERMISSION_REMINDERS PermissionGroup.contacts NSContactsUsageDescription PERMISSION_CONTACTS PermissionGroup.camera NSCameraUsageDescription PERMISSION_CAMERA PermissionGroup.microphone NSMicrophoneUsageDescription PERMISSION_MICROPHONE PermissionGroup.speech NSSpeechRecognitionUsageDescription PERMISSION_SPEECH_RECOGNIZER PermissionGroup.photos NSPhotoLibraryUsageDescription PERMISSION_PHOTOS PermissionGroup.location, PermissionGroup.locationAlways, PermissionGroup.locationWhenInUse NSLocationUsageDescription, NSLocationAlwaysAndWhenInUseUsageDescription, NSLocationWhenInUseUsageDescription PERMISSION_LOCATION PermissionGroup.notification PermissionGroupNotification PERMISSION_NOTIFICATIONS PermissionGroup.mediaLibrary NSAppleMusicUsageDescription, kTCCServiceMediaLibrary PERMISSION_MEDIA_LIBRARY PermissionGroup.sensors NSMotionUsageDescription PERMISSION_SENSORS PermissionGroup.bluetooth NSBluetoothAlwaysUsageDescription, NSBluetoothPeripheralUsageDescription PERMISSION_BLUETOOTH PermissionGroup.appTrackingTransparency NSUserTrackingUsageDescription PERMISSION_APP_TRACKING_TRANSPARENCY PermissionGroup.criticalAlerts PermissionGroupCriticalAlerts PERMISSION_CRITICAL_ALERTS -
Clean & Rebuild
-
For Record Permission:
<key>NSMicrophoneUsageDescription</key>
<string>We need to access to the microphone to record audio file</string>
- min SDK: 11.0
Usage
For init path
import 'package:social_media_audio_recorder/social_media_audio_recorder.dart';
void main() async {
WidgetsFlutterBinding.ensureInitialized();
SocialMediaFilePath.init();
runApp(const MyApp());
}
User RecordButton
import 'package:flutter/material.dart';
import 'package:social_media_audio_recorder/social_media_audio_recorder.dart';
import 'package:voice_message_package/voice_message_package.dart';
class _ExampleState extends State<Example> with SingleTickerProviderStateMixin {
AnimationController? controller;
String filepath = "";
bool readOnly = false;
@override
void initState() {
controller = AnimationController(
vsync: this,
duration: const Duration(milliseconds: 600),
);
super.initState();
}
@override
Widget build(BuildContext context) {
return Scaffold(
backgroundColor: Colors.black,
body: SafeArea(
child: Column(
mainAxisAlignment: MainAxisAlignment.center,
crossAxisAlignment: CrossAxisAlignment.center,
children: [
filepath != ""
? Expanded(
child: Column(
children: [
VoiceMessage(
audioSrc: filepath,
me: true,
),
],
),
)
: Expanded(child: Container()),
Row(
children: [
Expanded(
child: Padding(
padding: const EdgeInsets.only(left: 19),
child: Container(
height: 55,
decoration: BoxDecoration(
borderRadius: BorderRadius.circular(10),
color: Colors.white.withOpacity(0.2),
),
child: Padding(
padding: const EdgeInsets.symmetric(horizontal: 20),
child: TextField(
readOnly: readOnly,
maxLines: null,
decoration: InputDecoration(
border: InputBorder.none,
),
),
),
),
),
),
const SizedBox(width: 4),
RecordButton(
color: Colors.black,
allTextColor: Colors.white,
controller: controller!,
arrowColor: Colors.white,
onRecordEnd: (String value) {
setState(() {
filepath = value;
readOnly = false;
});
},
onRecordStart: () {
setState(() {
readOnly = true;
});
},
onCancelRecord: () {
setState(() {
readOnly = false;
});
},
),
],
),
],
),
),
);
}
}