Skip to content

Commit 75e8dfa

Browse files
authored
Update README.md
1 parent 8d90985 commit 75e8dfa

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@ It's based on official WebRTC native library version **`1.0.27771`**
1212

1313
The [official](https://webrtc.org/) description
1414

15-
"WebRTC is a free, open project that provides browsers and mobile applications with Real-Time Communications (RTC) capabilities via simple APIs. The WebRTC components have been optimized to best serve this purpose."
15+
"WebRTC is a free, open project that provides browsers and mobile applications with Real-Time Communications (RTC) capabilities via simple APIs. The WebRTC components have been optimised to best serve this purpose."
1616

1717

1818
Simply, it's a cross-platform API that allows developers to implement peer-to-peer real-time communication.
1919

20-
Imagine an API that allows you to send voice, video and/or data (text,images...etc) across mobile apps and web apps.
20+
Imagine an API that allows you to send voice, video and/or data (text, images...etc) across mobile apps and web apps.
2121

2222
---
2323
## How does it work (The simple version)
@@ -32,7 +32,7 @@ You have a signalling server that coordinates the initiation of the communicatio
3232

3333
The signalling server then sends this "offer" to (B).
3434

35-
(B) recieves the offer and it will create an SDP of it's own and send it back to the signalling server. We will call it "answer".
35+
(B) receives the offer and it will create an SDP of its own and send it back to the signalling server. We will call it "answer".
3636

3737
The signalling server then send this "answer" to (A).
3838

@@ -54,9 +54,9 @@ Let's label the device we are working on as a "Peer". We need to setup its conne
5454

5555
WebRTC library has `PeerConnectionFactory` that creates the `PeerConnection` for you. However, we need to `initialize` and `configure` this factory first.
5656

57-
### Initializing `PeerConnectionFactory`
57+
### Initialising `PeerConnectionFactory`
5858

59-
First we need to say that we need to trace what's happening in th background then specify which features we want the Native library to turn on. In our case we want `H264` video format.
59+
First we need to say that we need to trace what's happening in the background then specify which features we want the Native library to turn on. In our case we want `H264` video format.
6060

6161
```java
6262
val options = PeerConnectionFactory.InitializationOptions.builder(context)
@@ -70,7 +70,7 @@ val options = PeerConnectionFactory.InitializationOptions.builder(context)
7070

7171
Now we can use `PeerConnectionFactory.Builder` to build an instance of `PeerConnectionFactory`.
7272

73-
When building `PeerConnectionFactory` it's crucial to specify the video codecs you are using. In this sample, we will be usingthe default video codecs. In addition, we will be disabling encryption.
73+
When building `PeerConnectionFactory` it's crucial to specify the video codecs you are using. In this sample, we will be using the default video codecs. In addition, we will be disabling encryption.
7474

7575
```java
7676
val rootEglBase: EglBase = EglBase.create()
@@ -87,7 +87,7 @@ PeerConnectionFactory
8787

8888
### Setting the video output
8989

90-
Native WebRTC library relies on `SurfaceViewRenderer` view to output the videp data. It's a `SurfaceView` that is setup to work will the callbacks of other WebRTC functionalities.
90+
Native WebRTC library relies on `SurfaceViewRenderer` view to output the video data. It's a `SurfaceView` that is setup to work will the callbacks of other WebRTC functionalities.
9191

9292
```xml
9393
<?xml version="1.0" encoding="utf-8"?>
@@ -110,7 +110,7 @@ Native WebRTC library relies on `SurfaceViewRenderer` view to output the videp d
110110
</androidx.constraintlayout.widget.ConstraintLayout>
111111
```
112112

113-
We will also need to mirror the video stream we are providing and enable hardware accelration.
113+
We will also need to mirror the video stream we are providing and enable hardware acceleration.
114114

115115
```java
116116
local_view.setMirror(true)
@@ -167,7 +167,7 @@ This should run the server on port `8080`. You can change the port from `applica
167167

168168
[Ktor](https://ktor.io/) is also used as a client in the mobile app to send/receive data from `WebSocket`.
169169

170-
Checkout this [file](https://github.com/amrfarid140/webrtc-android-codelab/blob/step/remote-video/mobile/app/src/main/java/me/amryousef/webrtc_demo/SignallingClient.kt) for implemenation details.
170+
Checkout this [file](https://github.com/amrfarid140/webrtc-android-codelab/blob/step/remote-video/mobile/app/src/main/java/me/amryousef/webrtc_demo/SignallingClient.kt) for implementation details.
171171

172172
**Note that you will beed to change `HOST_ADDRESS` to match your IP address for your laptop**
173173

@@ -330,7 +330,7 @@ First, You will need to checkout the [master branch](https://github.com/amrfarid
330330

331331
Second, Open `server` in IntelliJ Idea and run the server. Make sure it's running on port 8080.
332332

333-
Third, Open `mobile` in Android Studio then navigate to `SignallingClient`. You find `HOST_ADDRESS`, change it's value with your local IP address.
333+
Third, Open `mobile` in Android Studio then navigate to `SignallingClient`. You find `HOST_ADDRESS`, change its value with your local IP address.
334334

335335
Finally, use Android studio to install the application on two different devices then click the "call" button from one of them. If all goes well, a voice call should've started for you.
336336

0 commit comments

Comments
 (0)