feat(UNT-T20529): ask media access permission iOS

Author: kuldip-simform

example/src/App.tsx

@@ -1,4 +1,4 @@
-import { useRef, useState } from 'react';
+import { useCallback, useEffect, useRef, useState } from 'react';
 import { Button, Linking, SafeAreaView, ScrollView, View } from 'react-native';
 import {
   FinishMode,
@@ -9,7 +9,7 @@ import {
   RecorderState,
   UpdateFrequency,
   Waveform,
-  useRecorderPermission,
+  useAudioPermission,
 } from 'react-native-audio-waveform';
 import { GestureHandlerRootView } from 'react-native-gesture-handler';
 import RNFetchBlob from 'rn-fetch-blob';
@@ -71,8 +71,8 @@ const ListItem = ({
 const LivePlayerComponent = () => {
   const newRef = useRef<IRecordWaveformRef>(null);
   const [recorderState, setRecorderState] = useState(RecorderState.stopped);
-  const { checkHasRecorderPermission, getAudioRecorderPermission } =
-    useRecorderPermission();
+  const { checkHasAudioRecorderPermission, getAudioRecorderPermission } =
+    useAudioPermission();
 
   const startRecording = () => {
     newRef.current
@@ -89,7 +89,7 @@ const LivePlayerComponent = () => {
           title={Strings.start}
           disabled={recorderState !== RecorderState.stopped}
           onPress={async () => {
-            let hasPermission = await checkHasRecorderPermission();
+            let hasPermission = await checkHasAudioRecorderPermission();
 
             if (hasPermission === PermissionStatus.granted) {
               startRecording();
@@ -136,27 +136,57 @@ const LivePlayerComponent = () => {
 
 const App = () => {
   const [shouldScroll, setShouldScroll] = useState(true);
+  const [list, setList] = useState<string[]>([]);
+  const [hasAudioReadPermission, setHasAudioReadPermission] = useState(
+    PermissionStatus.granted
+  );
   const { fs } = RNFetchBlob;
   const filePath = `${fs.dirs.MainBundleDir}`;
-  const list = [
-    `${filePath}/file_example_MP3_1MG.mp3`,
-    `${filePath}/file_example_MP3_700KB.mp3`,
-  ];
+
+  const { checkHasAudioReadPermission, getAudioReadPermission } =
+    useAudioPermission();
+  const checkAudioReadPermission = useCallback(async () => {
+    const hasPermission = await checkHasAudioReadPermission();
+    setHasAudioReadPermission(hasPermission);
+    if (hasPermission) {
+      const newList = [
+        `${filePath}/file_example_MP3_1MG.mp3`,
+        `${filePath}/file_example_MP3_700KB.mp3`,
+      ];
+      setList(newList);
+    }
+  }, []);
+
+  const getPermissionForAudioRead = async () => {
+    const hasPermission = await getAudioReadPermission();
+    setHasAudioReadPermission(hasPermission);
+  };
+
+  useEffect(() => {
+    checkAudioReadPermission();
+  }, [checkHasAudioReadPermission]);
+
   return (
     <SafeAreaView style={styles.container}>
       <GestureHandlerRootView style={styles.container}>
         <View style={styles.container}>
           <LivePlayerComponent />
-          <ScrollView scrollEnabled={shouldScroll}>
-            {list.map((item, index) => (
-              <ListItem
-                key={`${item}${index}`}
-                index={index}
-                item={item}
-                onPanStateChange={value => setShouldScroll(!value)}
-              />
-            ))}
-          </ScrollView>
+          {hasAudioReadPermission === PermissionStatus.granted ? (
+            <ScrollView scrollEnabled={shouldScroll}>
+              {list.map((item, index) => (
+                <ListItem
+                  key={`${item}${index}`}
+                  index={index}
+                  item={item}
+                  onPanStateChange={value => setShouldScroll(!value)}
+                />
+              ))}
+            </ScrollView>
+          ) : (
+            <Button
+              title={Strings.getAudioReadPermission}
+              onPress={getPermissionForAudioRead}></Button>
+          )}
         </View>
       </GestureHandlerRootView>
     </SafeAreaView>

example/src/constants/Strings.ts

@@ -3,4 +3,5 @@ export default {
   start: 'Start',
   pause: 'Pause',
   resume: 'Resume',
+  getAudioReadPermission: 'Get Audio Read Permission',
 };

ios/AudioRecorder.swift

@@ -146,7 +146,7 @@ public class AudioRecorder: NSObject, AVAudioRecorderDelegate{
       resolve(getDecibelLevel())
   }
 
-  public func checkHasPermission(_ resolve: RCTPromiseResolveBlock) -> Void{
+  public func checkHasAudioRecorderPermission(_ resolve: RCTPromiseResolveBlock) -> Void{
     var hasPermission = ""
     switch AVAudioSession.sharedInstance().recordPermission{
     case .granted:
@@ -163,7 +163,7 @@ public class AudioRecorder: NSObject, AVAudioRecorderDelegate{
     resolve(hasPermission)
   }
 
-  public func getAudioPermission(_ resolve: @escaping RCTPromiseResolveBlock) -> Void{
+  public func getAudioRecorderPermission(_ resolve: @escaping RCTPromiseResolveBlock) -> Void{
     AVAudioSession.sharedInstance().requestRecordPermission() { allowed in
       DispatchQueue.main.async {
         print("Permission \(allowed)")

ios/AudioWaveform.m

@@ -12,10 +12,15 @@
 
 @interface RCT_EXTERN_MODULE(AudioWaveform, RCTEventEmitter)
 
-RCT_EXTERN_METHOD(checkHasPermission:(RCTPromiseResolveBlock)resolve
+RCT_EXTERN_METHOD(checkHasAudioRecorderPermission:(RCTPromiseResolveBlock)resolve
                   rejecter: (RCTPromiseRejectBlock)reject)
-RCT_EXTERN_METHOD(getAudioPermission:(RCTPromiseResolveBlock)resolve
+RCT_EXTERN_METHOD(getAudioRecorderPermission:(RCTPromiseResolveBlock)resolve
                   rejecter: (RCTPromiseRejectBlock)reject)
+RCT_EXTERN_METHOD(checkHasAudioReadPermission:(RCTPromiseResolveBlock)resolve
+                  rejecter: (RCTPromiseRejectBlock)reject)
+RCT_EXTERN_METHOD(getAudioReadPermission:(RCTPromiseResolveBlock)resolve
+                  rejecter: (RCTPromiseRejectBlock)reject)
+
 RCT_EXTERN_METHOD(startRecording:(NSDictionary *)args
                   resolver: (RCTPromiseResolveBlock)resolve
                   rejecter: (RCTPromiseRejectBlock)reject)

ios/AudioWaveform.swift

@@ -42,12 +42,22 @@ class AudioWaveform: RCTEventEmitter {
     return ["AudioPlayerEvent"]
   }
 
-  @objc func checkHasPermission(_ resolve: @escaping RCTPromiseResolveBlock, rejecter reject: RCTPromiseRejectBlock) -> Void {
-    audioRecorder.checkHasPermission(resolve)
+  @objc func checkHasAudioRecorderPermission(_ resolve: @escaping RCTPromiseResolveBlock, rejecter reject: RCTPromiseRejectBlock) -> Void {
+    audioRecorder.checkHasAudioRecorderPermission(resolve)
   }
+    
+    @objc func checkHasAudioReadPermission(_ resolve: @escaping RCTPromiseResolveBlock, rejecter reject: RCTPromiseRejectBlock) -> Void {
+        // iOS does not need to ask for permission to read files so this will resolve "granted" every time
+        resolve("granted")
+    }
+
+    @objc func getAudioReadPermission(_ resolve: @escaping RCTPromiseResolveBlock, rejecter reject: RCTPromiseRejectBlock) -> Void {
+        // iOS does not need to ask for permission to read files so this will resolve "granted" every time
+        resolve("granted")
+    }
 
-  @objc func getAudioPermission(_ resolve: @escaping RCTPromiseResolveBlock, rejecter reject: RCTPromiseRejectBlock) -> Void {
-    audioRecorder.getAudioPermission(resolve)
+  @objc func getAudioRecorderPermission(_ resolve: @escaping RCTPromiseResolveBlock, rejecter reject: RCTPromiseRejectBlock) -> Void {
+    audioRecorder.getAudioRecorderPermission(resolve)
   }
 
   @objc func startRecording(_ args: NSDictionary?, resolver resolve: RCTPromiseResolveBlock, rejecter reject: RCTPromiseRejectBlock) -> Void {

src/components/Waveform/Waveform.tsx

@@ -26,7 +26,7 @@ import {
 import {
   useAudioPlayer,
   useAudioRecorder,
-  useRecorderPermission,
+  useAudioPermission,
 } from '../../hooks';
 import type { IStartRecording } from '../../types';
 import { WaveformCandle } from '../WaveformCandle';
@@ -95,7 +95,7 @@ export const Waveform: <T extends StaticOrLive>(
     resumeRecording,
   } = useAudioRecorder();
 
-  const { checkHasRecorderPermission } = useRecorderPermission();
+  const { checkHasAudioRecorderPermission } = useAudioPermission();
 
   const preparePlayerForPath = async () => {
     if (!isNil(path) && !isEmpty(path)) {
@@ -230,7 +230,7 @@ export const Waveform: <T extends StaticOrLive>(
 
   const startRecordingAction = async (args?: Partial<IStartRecording>) => {
     try {
-      const hasPermission = await checkHasRecorderPermission();
+      const hasPermission = await checkHasAudioRecorderPermission();
 
       if (hasPermission === PermissionStatus.granted) {
         const start = await startRecording(args);
@@ -296,7 +296,7 @@ export const Waveform: <T extends StaticOrLive>(
 
   const resumeRecordingAction = async () => {
     try {
-      const hasPermission = await checkHasRecorderPermission();
+      const hasPermission = await checkHasAudioRecorderPermission();
       if (hasPermission === PermissionStatus.granted) {
         const resume = await resumeRecording();
         if (!isNil(resume)) {

src/hooks/index.ts

@@ -1,3 +1,3 @@
+export * from './useAudioPermission';
 export * from './useAudioPlayer';
 export * from './useAudioRecorder';
-export * from './useRecorderPermission';

src/hooks/useAudioPermission.ts

@@ -0,0 +1,26 @@
+import { AudioWaveform } from '../audioWaveform';
+
+export const useAudioPermission = () => {
+  const checkHasAudioRecorderPermission = () => {
+    return AudioWaveform.checkHasAudioRecorderPermission();
+  };
+
+  const getAudioRecorderPermission = () => {
+    return AudioWaveform.getAudioRecorderPermission();
+  };
+
+  const checkHasAudioReadPermission = () => {
+    return AudioWaveform.checkHasAudioRecorderPermission();
+  };
+
+  const getAudioReadPermission = () => {
+    return AudioWaveform.getAudioReadPermission();
+  };
+
+  return {
+    checkHasAudioRecorderPermission,
+    getAudioRecorderPermission,
+    checkHasAudioReadPermission,
+    getAudioReadPermission,
+  };
+};

src/hooks/useRecorderPermission.ts

@@ -10,4 +10,4 @@ export {
   RecorderState,
   UpdateFrequency,
 } from './constants';
-export { useRecorderPermission } from './hooks';
+export { useAudioPermission } from './hooks';