Merge pull request #57 from zxcpoiu/convert-objc

iOS: rewrite using Obj-C

Author: zxcpoiu

README.md

@@ -7,13 +7,15 @@
 Handling media-routes/sensors/events during a audio/video chat on React Native
 
 ## Purpose:
+
 The purpose of this module is to handle actions/events during a phone call (audio/video) on `react-native`, ex:
-* manage devices events like wired-headset plugged in state, proximity sensors and expose functionalities to javascript.
-* automatically route audio to proper devices based on events and platform API.
-* toggle speaker or microphone on/off, toggle flash light on/off
-* play ringtone/ringback/dtmftone
 
-basically, it is a telecommunication module which handles most of requirements when making/receiving/talking with a call.
+* Manage devices events like wired-headset plugged in state, proximity sensors and expose functionalities to javascript.
+* Automatically route audio to proper devices based on events and platform API.
+* Toggle speaker or microphone on/off, toggle flash light on/off
+* Play ringtone/ringback/dtmftone
+
+Basically, it is a telecommunication module which handles most of requirements when making/receiving/talking with a call.
 
 This module is desinged to work with [react-native-webrtc](https://github.com/oney/react-native-webrtc)
 you can find demo here: https://github.com/oney/RCTWebRTCDemo
@@ -23,41 +25,40 @@ you can find demo here: https://github.com/oney/RCTWebRTCDemo
 
 #### BREAKING NOTE:
 
-* since `2.1.0`, you should use `RN 40+` and upgrade your xcode to support `swift 3`.  
+* Since `2.1.0`, you should use `RN 40+` and upgrade your xcode to support `swift 3`.  
   after upgrading xcode, `Edit -> Convert -> To Current Swift Syntax` to invoke `Swift Migration Assistant`  
   see [Migrating to Swift 2.3 or Swift 3 from Swift 2.2](https://swift.org/migration-guide/)
 
-* for old RN versions (RN < 0.40) please use version `1.5.4` ( Swift 2.2~2.3 )
+* For old RN versions (RN < 0.40) please use version `1.5.4` ( Swift 2.2~2.3 )
 
 
-**from npm package**: `npm install react-native-incall-manager`  
-**from git package**: `npm install git://github.com/zxcpoiu/react-native-incall-manager.git`  
+**From npm package**: `npm install react-native-incall-manager`  
+**From git package**: `npm install git://github.com/zxcpoiu/react-native-incall-manager.git`  
 
 ===================================================
-### android:
+### Android:
 
 After install, you can use `rnpm` (`npm install rnpm -g`) to link android.  
-use `rnpm link react-native-incall-manager` to link or manually if you like.
+use `react-native link react-native-incall-manager` to link or manually if you like.
 
 We use android support library v4 to check/request permissions.  
 You should add `compile "com.android.support:support-v4:23.0.1"` in `$your_project/android/app/build.gradle` dependencies on android.  
 
-#### Manually Link
+#### Manually Linking
 
-if rnpm link doesn't work. ( see: https://github.com/zxcpoiu/react-native-incall-manager/issues/21#issuecomment-279575516 )  
-please add it manually in your main project:
+If `react-native link` doesn't work, ( see: https://github.com/zxcpoiu/react-native-incall-manager/issues/21#issuecomment-279575516 ) please add it manually in your main project:
 
-1. in `android/app/build.gradle`
-    should have a line `compile(project(':react-native-incall-manager'))` in `dependencies {}` section
+1. In `android/app/build.gradle`  
+    Should have a line `compile(project(':react-native-incall-manager'))` in `dependencies {}` section
 
-2. in `android/settings.gradle`
-    should have: 
+2. In `android/settings.gradle`  
+    Should have: 
     ```
     include ':react-native-incall-manager'
 project(':react-native-incall-manager').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-incall-manager/android')
     ```
     
-3. in `MainApplication.java`
+3. In `MainApplication.java`
 
     ```java
     import com.zxcpoiu.incallmanager.InCallManagerPackage;
@@ -69,9 +70,9 @@ project(':react-native-incall-manager').projectDir = new File(rootProject.projec
         );
     }
     ```
-#### optional sound files on android
+#### Optional sound files on android
 
-if you want to use bundled ringtone/ringback/busytone sound instead of system sound,  
+If you want to use bundled ringtone/ringback/busytone sound instead of system sound,  
 put files in `android/app/src/main/res/raw`  
 and rename file correspond to sound type:  
 
@@ -81,61 +82,52 @@ incallmanager_ringback.mp3
 incallmanager_ringtone.mp3 
 ```
 
-on android, as long as your file extension supported by android, this module will load it.
+On android, as long as your file extension supported by android, this module will load it.
 
 ===================================================
 
 ### ios:
 
-since ios part written in swift and it doesn't support static library yet.  
-before that, you should add this project manually  
-please do it step by step carefully :pray: :  
+`react-native link react-native-incall-manager`
 
-#### Add files in to your project:
+#### Manually Linking
 
-  1. Open your project in xcode
-  2. find your_project directory under your project's xcodeproject root. ( it's a sub-directoory, not root xcodeproject itself )
-  3. you can do either:  
-    (recommended) directly drag your node_modules/react-native-incall-manager/ios/RNInCallManager/ into it.  
-    (may have some [path issue](https://github.com/zxcpoiu/react-native-incall-manager/issues/39)) right click on your_project directory, `add files` to your project and add `node_modules/react-native-incall-manager/ios/RNInCallManager/`  
-  4. on the pou-up window, uncheck `Copy items if needed` and select `Added folders: Create groups` then add it. you will see a new directory named `RNInCallmanager under your_project` directory.
-
-#### Setup Objective-C Bridging Header:
-  1. click your `project's xcodeproject root`, go to `build setting` and search `Objective-C Bridging Header`
-  2. set you header location, the default path is: `ReactNativeProjectRoot/ios/`,
-     in this case, you should set `../node_modules/react-native-incall-manager/ios/RNInCallManager/RNInCallManager-Bridging-Header.h`  
-     
-### Swift:     
-Make sure you set swift version to `3.2`: ![swift](https://i.imgur.com/lYubEVt.png)  
+In case `react-native link` doesn't work,
 
+- Drag `node_modules/react-native-incall-manager/ios/RNInCallManager.xcodeproj` under `<your_xcode_project>/Libraries`
+- Select `<your_xcode_project>` --> `Build Phases` --> `Link Binary With Libraries`
+  - Drag `Libraries/RNInCallManager.xcodeproj/Products/libRNInCallManager.a` to `Link Binary With Libraries`
+- Select `<your_xcode_project>` --> `Build Settings`
+  - In `Header Search Paths`, add `$(SRCROOT)/../node_modules/react-native-incall-manager/ios/RNInCallManager`
 
 #### Clean project if messed up:
+
   The installation steps are a bit complex, it might related your xcode version, xcode cache, converting swift version, and your own path configurations. if something messed up, please folow steps below to clean this project, then do it again steps by steps.
 
-  1. delete all project/directory in xcode related to incall-manager
-  2. delete `react-native-incall-manager` in node_modules ( rm -rf )
+  1. Delete all project/directory in xcode related to incall-manager
+  2. Delete `react-native-incall-manager` in node_modules ( rm -rf )
   3. Xcode -> Product -> clean
-  4. close xcode
-  5. npm install again
-  6. open xcode and try the install process again steps by steps
+  4. Close xcode
+  5. Run `npm install` again
+  6. Open xcode and try the install process again steps by steps
 
-  if someone knows a simpler way to set this project up, let me know plz.
+  If someone knows a simpler way to set this project up, let me know plz.
 
-#### optional sound files on android
+#### Optional sound files on iOS
 
-if you want to use bundled ringtone/ringback/busytone sound instead of system sound 
+If you want to use bundled ringtone/ringback/busytone sound instead of system sound 
 
-1. add files into your_project directory under your project's xcodeproject root. ( or drag into it as described above. )
-2. check `copy file if needed`
-3. make sure filename correspond to sound type:
+1. Add files into your_project directory under your project's xcodeproject root. ( or drag into it as described above. )
+2. Check `copy file if needed`
+3. Make sure filename correspond to sound type:
 
 ```
 incallmanager_busytone.mp3
 incallmanager_ringback.mp3 
 incallmanager_ringtone.mp3 
 ```
 
-on ios, we only support mp3 files currently.
+On ios, we only support mp3 files currently.
 
 ## Usage:
 
@@ -155,7 +147,7 @@ InCallManager.stop();
 // ... it will also remote event listeners ...
 ```
 
-if you want to use ringback:
+If you want to use ringback:
 
 ```javascript
 // ringback is basically for OUTGOING call. and is part of start().
@@ -165,7 +157,7 @@ InCallManager.start({media: 'audio', ringback: '_BUNDLE_'}); // or _DEFAULT_ or
 InCallManager.stopRingback();
 ```
 
-if you want to use busytone:
+If you want to use busytone:
 
 ```javascript
 // busytone is basically for OUTGOING call. and is part of stop()
@@ -174,7 +166,7 @@ if you want to use busytone:
 InCallManager.stop({busytone: '_DTMF_'}); // or _BUNDLE_ or _DEFAULT_
 ```
 
-if you want to use ringtone:
+If you want to use ringtone:
 
 ```javascript
 // ringtone is basically for INCOMING call. it's independent to start() and stop()
@@ -192,8 +184,8 @@ InCallManager.stop();
 
 ```
 
-also can interact with events if you want:
-see API section.
+Also can interact with events if you want:
+See API section.
 
 ```javascript
 import { DeviceEventEmitter } from 'react-native';
@@ -207,7 +199,7 @@ DeviceEventEmitter.addListener('Proximity', function (data) {
 ## About Permission:
 
 
-since version 1.2.0, two functions and a property were added:
+Since version 1.2.0, two functions and a property were added:
 
 ```javascript
 // --- function
@@ -255,7 +247,7 @@ Step 2: override `onRequestPermissionsResult` in your `MainActivity.java` like:
     }
 ```
 
-then you can test it on android 6 now.
+Then you can test it on android 6 now.
 
 **Another thing you should know is:**
 
@@ -264,29 +256,29 @@ So in **development mode**, you should manually grant permission in `app setting
 You don't have to do this in **release mode** since there are no red box.  
 
 
-checkout this awesome project: [react-native-android-permissions](https://github.com/lucasferreira/react-native-android-permissions) by @lucasferreira for more information.
+Checkout this awesome project: [react-native-android-permissions](https://github.com/lucasferreira/react-native-android-permissions) by @lucasferreira for more information.
 
 
 ## Automatic Basic Behavior:
 
-**on start:**  
-* store current settings, set KeepScreenOn flag = true, and register some event listeners.
-* if media type is `audio`, route voice to earpiece, otherwise route to speaker.
-* audio will enable proximity sensor which is disabled by default if media=video
-* when proximity detect user closed to screen, turn off screen to avoid accident touch and route voice to earpiece.
-* when newly external device plugged, such as wired-headset, route audio to external device.
-* optional play ringback
+**On start:**  
+* Store current settings, set KeepScreenOn flag = true, and register some event listeners.
+* If media type is `audio`, route voice to earpiece, otherwise route to speaker.
+* Audio will enable proximity sensor which is disabled by default if media=video
+* When proximity detect user closed to screen, turn off screen to avoid accident touch and route voice to earpiece.
+* When newly external device plugged, such as wired-headset, route audio to external device.
+* Optional play ringback
 
-**on stop:**  
+**On stop:**  
 
-* set KeepScreenOn flag = false, remote event listeners, restore original user settings.
-* optional play busytone
+* Set KeepScreenOn flag = false, remote event listeners, restore original user settings.
+* Optional play busytone
 
 ## Custom Behavior:  
 
-you can custom behavior use API/events exposed by this module. see `API` section.
+You can custom behavior use API/events exposed by this module. see `API` section.
 
-note: ios only supports `auto` currently.
+Note: ios only supports `auto` currently.
 
 ## API: