Building.md

Building

Building Steps

An iOS Cordova application including the cordova-plugin-iosrtc plugin can be built using the cordova-cli or Xcode.

The plugin provides a "hook" to automate required modifications in both cordova-cli and Xcode generated projects. It is no longer necessary to add the "hook" manually or add and remove the platform again, it is executed before and after cordova is preparing your application.

* You have two options right now:
  * Open the Xcode project and compile your application.
  * Build the application as usual using the Cordova CLI:
```bash
$ cordova build ios

For more details about Cordova hook life cycle see: Hooks Guide - Apache Cordova

Bridging Header

The plugin is coded in Swift language but it makes use of the Cordova Objective-C headers and the Google's WebRTC Objective-C wrapper so a Bridging Header is required. When building (using the provided hook above) our Bridging Header file is automatically added into your Cordova project.

It may happen that your Cordova application uses more than a single plugin coded in Swift, each of them requiring its own Bridging Header file. Unfortunately just a single Bridging Header can be set in a Xcode project. The solution is to create a "Unified-Bridging-Header.h" file within your project and include all the Bridging Header files required by the plugins in there. For example:

Unified-Bridging-Header.h:

// cordova-plugin-apple-watch "Apple Watch"
#import "Watch-Bridge.h"

// cordova-plugin-iosrtc
#import "cordova-plugin-iosrtc-Bridging-Header.h"

And then set Unified-Bridging-Header.h as the value of the "Objective-C Bridging Header" build setting in your Xcode project. For more information check this issue.

Minimum Xcode Version

You need to use minimum Xcode version 10.2 otherwise the build will fail due Apple Xcode know Bugs that have been fixed only on version above Xcode 10.2.

See: Xcode 10.2 Release Notes

Configuring Xcode manually

If you still prefer to do it manually open it with Xcode and follow these steps:

• Set "iOS Deployment Target" to 10.2 or higher within your project settings.
• Set "Deployment Target" to 10.2 or higher within the project target settings.
• Within the project "Build Settings" add an entry to the "Runpath Search Paths" setting with value @executable_path/Frameworks.
• Within the project "Build Settings" set "Objective-C Bridging Header" to PROJECT_NAME/Plugins/cordova-plugin-iosrtc/cordova-plugin-iosrtc-Bridging-Header.h (read more about the "Bridging Header" above).
• Within the project "Build Settings" set "Enable Bitcode" to "No".

iOS 10 notes

On iOS 10 each permission requested must be accompanied by a description or the app will crash. Here is an example:

<platform name="ios">
    <config-file parent="NSCameraUsageDescription" target="*-Info.plist">
	<string>Blink uses your camera to make video calls.</string>
    </config-file>
    <config-file parent="NSContactsUsageDescription" target="*-Info.plist">
	<string>Blink needs access to your contacts in order to be able to call them.</string>
    </config-file>
    <config-file parent="NSMicrophoneUsageDescription" target="*-Info.plist">
	<string>Blink uses your microphone to make calls.</string>
    </config-file>
</platform>

CocoaPods

Using CocoaPods will lose the bitcode setting on pod install. Adding post_install step to the Podfile can help

# Example post install to disable bitcode for pods
post_install do |installer|
  installer.pods_project.targets.each do |target|
    target.build_configurations.each do |config|
      # Disable bitcode in order to support cordova-plugin-iosrtc
      config.build_settings['ENABLE_BITCODE'] = 'NO'
    end
  end
end

Capacitor

When adding ios support using npx cap add ios the bitcode setting mentioned above will need to be set to 'NO' for the App project. Also see above for CocoaPods concerns since pod install will run every time you do npx cap sync ios

Apple Store Submission

You should strip simulator (i386/x86_64) archs from WebRTC binary before submit to Apple Store.
We provide a handy script to do it easily. see below sections.

credit: The script is originally provided via react-native-webrtc by @besarthoxhaj in #141, thanks!

Strip Simulator Archs Usage

The script and example are here: https://github.com/cordova-rtc/cordova-plugin-iosrtc/blob/master/extra/ios_arch.js

1. go to plugins/cordova-plugin-iosrtc/extra folder
2. extract all archs first: node ios_arch.js --extract
3. re-package device related archs only: node ios_arch.js --device
4. delete files generated from step 2 under plugins/cordova-plugin-iosrtc/lib/WebRTC.framework/ (e.g. with a command node ios_arch.js --clean or manualy rm plugins/cordova-plugin-iosrtc/lib/WebRTC.framework/WebRTC-* from application root)
5. you can check current arch use this command node ios_arch.js --list or manualy file plugins/cordova-plugin-iosrtc/lib/WebRTC.framework/WebRTC
6. Remove ios cordova platform if already added and add ios platform again (e.g. with a command cordova platform remove ios && cordova platform add ios) or remove and add only the plugin at your own risk.

Capacitor

Using Capacitor; The plugins will be in the node_modules folder so ios_arch will be run in node_modules/cordova-plugin-iosrtc/extra

node node_modules/cordova-plugin-iosrtc/extraios_arch.js --list
node node_modules/cordova-plugin-iosrtc/extraios_arch.js --simulator

You will need to remove and add ios platform again.

Meteor

Using Meteor; The plugins will be in the node_modules folder so ios_arch.js will be run in .meteor/local/cordova-build/node_modules/cordova-plugin-iosrtc/extra/

node .meteor/local/cordova-build/node_modules/cordova-plugin-iosrtc/extra/ios_arch.js --list
node .meteor/local/cordova-build/node_modules/cordova-plugin-iosrtc/extra/ios_arch.js --simulator

You will need to copy manually the updated WebRTC file, since remove/add platform does not work like cordova:

cp .meteor/local/cordova-build/node_modules/cordova-plugin-iosrtc/lib/WebRTC.framework/WebRTC .meteor/local/cordova-build/platforms/ios/*/Plugins/cordova-plugin-iosrtc/WebRTC.framework/WebRTC