Skip to content

Commit e19ecfa

Browse files
committed
Mention that xcode NPM package is required.
1 parent 77b92a8 commit e19ecfa

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,21 @@ This project takes the [HTML5 version](https://github.com/webrtc/apprtc/tree/mas
1212

1313
- Get the source code:
1414
```bash
15-
git clone https://github.com/eface2face/iOSRTCApp
16-
cd iOSRTCApp
15+
$ git clone https://github.com/eface2face/iOSRTCApp
16+
$ cd iOSRTCApp
1717
```
18-
- Add both platforms, all needed plugins are installed automatically because of being included in the "config.xml" file:
18+
- Install [xcode](https://www.npmjs.com/package/xcode) NPM package:
1919
```bash
20-
cordova platform add ios android
20+
$ npm i xcode
21+
```
22+
- Add both platforms. All the needed plugins are installed automatically because of being included in the "config.xml" file:
23+
```bash
24+
$ cordova platform add ios android
2125
```
2226
- Run as usual:
2327
```bash
24-
cordova run android --device
28+
$ cordova run android --device
29+
$ cordova run ios --device
2530
```
2631
- Once running, enter the same room as one already created via web browser at https://apprtc.appspot.com/, and enjoy!
2732

@@ -30,13 +35,10 @@ cordova run android --device
3035

3136
There are minor changes in the original HTML, JavaScript and CSS in order to make it work as a Cordova application. Those changes are:
3237

33-
* `js/apprtc.debug.js` and `js/appwindow.js` are loaded once Cordova's `ondeviceready` event is fired. This is needed since `js/apprtc.debug.js` relies on existing `window.webkitRTCPeerConnection` and `navigator.webkitGetUserMedia` which are not set by the *cordova-plugin-iosrtc* until `ondeviceready` fires.
34-
35-
* `webrtcDetectedVersion` global variable is hardcoded to `43` (AppRTC JavaScript code expects browser to be Chrome or Chromium, and fails otherwise).
36-
37-
* In order to correctly place video views (iOS native `UIView` elements) the plugin `refreshVideos()` function is called when the local or remote video is set (this is because the CSS video elements use "transition" effects that modify their position and size during 1 second).
38-
39-
* A new CSS file `css/main_overrides.css` changes the properties of video elements. For example, it sets `opacity: 0.85` in `#local-video` and `#remote-video` so HTML call controls are shown even below the native `UIView` elements rendering the local and remote video.
38+
- `js/apprtc.debug.js` and `js/appwindow.js` are loaded once Cordova's `ondeviceready` event is fired. This is needed since `js/apprtc.debug.js` relies on existing `window.webkitRTCPeerConnection` and `navigator.webkitGetUserMedia` which are not set by the *cordova-plugin-iosrtc* until `ondeviceready` fires.
39+
- `webrtcDetectedVersion` global variable is hardcoded to `43` (AppRTC JavaScript code expects browser to be Chrome or Chromium, and fails otherwise).
40+
- In order to correctly place video views (iOS native `UIView` elements) the plugin `refreshVideos()` function is called when the local or remote video is set (this is because the CSS video elements use "transition" effects that modify their position and size during 1 second).
41+
- A new CSS file `css/main_overrides.css` changes the properties of video elements. For example, it sets `opacity: 0.85` in `#local-video` and `#remote-video` so HTML call controls are shown even below the native `UIView` elements rendering the local and remote video.
4042

4143

4244
## Author

0 commit comments

Comments
 (0)