WebRTC

https://webrtc.github.io/webrtc-org/
Admin
WebRTC is an open-source project that enables real-time communication capabilities in web browsers...
Tokens:12,491
Snippets:258
Trust Score:9.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install Linux build dependencies

Source: https://webrtc.github.io/webrtc-org/native-code/development/prerequisite-sw

Execute the provided script on Ubuntu to install necessary build tools after the initial gclient sync.

```bash
./build/install-build-deps.sh
```

--------------------------------

### Granting network interface access on Unix

Source: https://webrtc.github.io/webrtc-org/testing/wireshark

Command to provide necessary read permissions for network interfaces on Mac OS or Unix systems, required before starting Wireshark.

```bash
sudo chmod +r /dev/bpf*
```

--------------------------------

### Initialize WebRTC source checkout

Source: https://webrtc.github.io/webrtc-org/native-code/development

Commands to create a directory and fetch the WebRTC source code using depot_tools.

```bash
mkdir webrtc-checkout
cd webrtc-checkout
fetch --nohooks webrtc
gclient sync
```

--------------------------------

### Build WebRTC Framework

Source: https://webrtc.github.io/webrtc-org/native-code/ios

Build the WebRTC.framework using Ninja.

```bash
ninja -C out/ios framework_objc
```

--------------------------------

### Compile WebRTC using Ninja

Source: https://webrtc.github.io/webrtc-org/native-code/development

Execute the build process for a previously generated configuration.

```bash
ninja -C out/Default
```

--------------------------------

### Configure Android SDK/NDK environment

Source: https://webrtc.github.io/webrtc-org/native-code/android

Add the bundled Android tools to your system PATH.

```bash
. build/android/envsetup.sh
```

--------------------------------

### Fetch WebRTC source code

Source: https://webrtc.github.io/webrtc-org/native-code/android

Initialize the WebRTC repository for Android development.

```bash
fetch --nohooks webrtc_android
gclient sync
```

--------------------------------

### Fetch WebRTC Source Code

Source: https://webrtc.github.io/webrtc-org/native-code/ios

Initialize the working directory and sync the WebRTC repository for iOS development.

```bash
fetch --nohooks webrtc_ios
gclient sync

```

--------------------------------

### Build Framework with Bitcode

Source: https://webrtc.github.io/webrtc-org/native-code/ios

Build the iOS framework with bitcode support using the provided Python script.

```bash
python build_ios_libs.py --bitcode
```

--------------------------------

### Compile WebRTC for Android

Source: https://webrtc.github.io/webrtc-org/native-code/android

Generate build files and compile the project using GN and Ninja.

```bash
gn gen out/Debug --args='target_os="android" target_cpu="arm"'
```

```bash
ninja -C out/Debug
```

--------------------------------

### IceConnectionTest Algorithm

Source: https://webrtc.github.io/webrtc-org/testing/kite

The procedural steps for verifying WebRTC ICE connection establishment between two browser instances.

```text
1) Open the 2 browsers with https://appr.tc/r/xxx.

2) Click 'confirm-join-button' for both of the browsers in sequence.

3) Do the following every 1 second for 1 minute for both the browsers:

    a) Retreive iceConnectionState.

    b) Checks whether both the browsers'iceConnectionState is either 'completed' or 'connected'.

4) The test is considered as successful if all the browsers either returns 'completed' or 'connected' within 1 minute.
```

--------------------------------

### Create a local development branch

Source: https://webrtc.github.io/webrtc-org/native-code/development

Recommended workflow for creating a new local branch within the src directory.

```bash
cd src
git checkout master
git new-branch your-branch-name
```

--------------------------------

### Verify Git credentials

Source: https://webrtc.github.io/webrtc-org/contributing

Run this command to ensure your credentials are correctly configured for the review system.

```bash
git cl creds-check
```

--------------------------------

### Run Tryjobs

Source: https://webrtc.github.io/webrtc-org/contributing

Commands to trigger automated tryjobs for verifying changes before committing.

```bash
git cl try
```

```bash
git cl try -b mac -b mac_rel -B luci.webrtc.try
```

--------------------------------

### Update getUserMedia argument syntax

Source: https://webrtc.github.io/webrtc-org/blog/2012/05/02/changes-to-our-webrtc-api-implementation.html

Transition from string-based arguments to an object-based configuration for navigator.webkitGetUserMedia.

```javascript
navigator.webkitGetUserMedia("audio,video", gotStream, gotStreamFailed);
```

```javascript
navigator.webkitGetUserMedia({audio:true, video:true}, gotStream, gotStreamFailed);
```

--------------------------------

### Generate Ninja build files

Source: https://webrtc.github.io/webrtc-org/native-code/development

Commands to generate build configurations using GN for Debug or Release builds.

```bash
gn gen out/Default
```

```bash
gn gen out/Default --args='is_debug=false'
```

```bash
gn clean out/Default
```

--------------------------------

### Compile with Ninja

Source: https://webrtc.github.io/webrtc-org/native-code/ios

Build a specific target using the generated Ninja files.

```bash
ninja -C out/ios_64 AppRTCMobile

```

--------------------------------

### Enable WebRTC logging in Chrome

Source: https://webrtc.github.io/webrtc-org/native-code/logging

Use these command-line flags to enable INFO and VERBOSE logging, which outputs to chrome_debug.log.

```bash
chrome --enable-logging --vmodule=*/webrtc/*=1
```

--------------------------------

### Define SdpSemantics and RTCConfiguration

Source: https://webrtc.github.io/webrtc-org/web-apis/chrome/unified-plan

Use these definitions to configure the RTCPeerConnection to use specific SDP semantics.

```webidl
enum SdpSemantics {
  "plan-b",
  "unified-plan"
};


partial dictionary RTCConfiguration {
   SdpSemantics sdpSemantics;
}
```

--------------------------------

### Enable Native WebRTC Logging in Chrome

Source: https://webrtc.github.io/webrtc-org/web-apis/chrome

Use these command-line flags to enable verbose logging for WebRTC and libjingle components. The --no-sandbox flag is specific to Windows and should only be used for testing.

```bash
chrome.exe --enable-logging --vmodule=*/webrtc/*=2,*/libjingle/*=2,*=-2 --no-sandbox
```

--------------------------------

### Run WebRTC native tests on Android

Source: https://webrtc.github.io/webrtc-org/native-code/android

Execute native unit tests on a connected Android device.

```bash
out/Debug/bin/run_modules_unittests
```

```bash
out/Debug/bin/run_modules_unittests \
--gtest_filter=RtpRtcpAPITest.SSRC:RtpRtcpRtcpTest.*
```

--------------------------------

### Generate Xcode Project

Source: https://webrtc.github.io/webrtc-org/native-code/ios

Use GN to generate an Xcode workspace for iOS development.

```bash
gn gen out/ios --args='target_os="ios" target_cpu="arm64"' --ide=xcode
open -a Xcode.app out/ios/all.xcworkspace
```

--------------------------------

### Configure Git branch tracking

Source: https://webrtc.github.io/webrtc-org/native-code/development

Set up Git to automatically track and rebase branches.

```bash
git config branch.autosetupmerge always
git config branch.autosetuprebase always
```

--------------------------------

### Upload a new patch

Source: https://webrtc.github.io/webrtc-org/contributing

Commands to create a new branch, commit changes, and upload the patch for review.

```bash
# Assuming you're on the master branch:
git checkout -b my-work-branch
# Make changes, build locally, run tests locally
git commit -am "Changed x, and it is working"
git cl upload
```

--------------------------------

### Revert depot_tools for legacy branches

Source: https://webrtc.github.io/webrtc-org/native-code/development

Steps to use an older version of depot_tools if sync fails on old branches.

```bash
which gclient
# cd to depot_tools dir
# edit update_depot_tools; add an exit command at the top of the file
git log  # find a hash close to the date when the branch happened
git checkout <hash>
cd ~/dev/webrtc/src
gclient sync
# When done, go back to depot_tools, git reset --hard, run gclient again and
# verify the current branch becomes REMOTE:origin/master
```

--------------------------------

### Format and Lint Code

Source: https://webrtc.github.io/webrtc-org/contributing

Commands to format code and manually run the C++ lint checker.

```bash
git cl format
```

```bash
cpplint.py
```

--------------------------------

### Run WebRTC browser tests

Source: https://webrtc.github.io/webrtc-org/testing/continuous

Executes browser tests with a filter for WebRTC browser tests in manual mode.

```bash
out/Debug/browser_tests --gtest_filter="WebRtcBrowserTest*" --run-manual
```

--------------------------------

### Generate GN Build Files

Source: https://webrtc.github.io/webrtc-org/native-code/ios

Configure GN to generate Ninja build files for specific iOS architectures.

```bash
# debug build for 64-bit iOS
gn gen out/ios_64 --args='target_os="ios" target_cpu="arm64"'

# debug build for simulator
gn gen out/ios_sim --args='target_os="ios" target_cpu="x64"'

```

--------------------------------

### Generate Android Studio project files

Source: https://webrtc.github.io/webrtc-org/native-code/android

Build the AppRTCMobile target and generate Gradle project files for Android Studio.

```bash
ninja -C out/Debug AppRTCMobile
```

```bash
build/android/gradle/generate_gradle.py --output-directory $PWD/out/Debug \
--target "//examples:AppRTCMobile" --use-gradle-process-resources \
--split-projects --canary
```

--------------------------------

### Run WebRTC content browser tests

Source: https://webrtc.github.io/webrtc-org/testing/continuous

Executes content browser tests with a filter for WebRTC-related tests in manual mode.

```bash
out/Debug/content_browsertests --gtest_filter="WebRtc*" --run-manual
```

--------------------------------

### Enable native WebRTC logging programmatically

Source: https://webrtc.github.io/webrtc-org/native-code/logging

Call this method within your application to set the logging severity level.

```cpp
rtc::LogMessage::LogToDebug(rtc::LS_INFO)
```

--------------------------------

### Create Local Git Branch

Source: https://webrtc.github.io/webrtc-org/native-code/ios

Create a new local branch within the WebRTC source checkout.

```bash
git new-branch <branch name>

```

--------------------------------

### Verify peerconnection_server status

Source: https://webrtc.github.io/webrtc-org/native-code/development

Indicates the server is successfully listening for incoming connections.

```text
Server listening on port 8888
```

--------------------------------

### Integrate WebRTC via CocoaPods

Source: https://webrtc.github.io/webrtc-org/native-code/ios

Add these lines to your Podfile to include the GoogleWebRTC framework in your iOS project.

```ruby
source 'https://github.com/CocoaPods/Specs.git'
target 'YOUR_APPLICATION_TARGET_NAME_HERE' do
  platform :ios, '9.0'
  pod 'GoogleWebRTC'
end

```

--------------------------------

### Configure Git user email for WebRTC

Source: https://webrtc.github.io/webrtc-org/native-code/development

Sets the local Git email address for WebRTC repositories to ensure correct attribution.

```bash
cd /path/to/webrtc/src
git config user.email yourname@webrtc.org
```

--------------------------------

### Manage release branches

Source: https://webrtc.github.io/webrtc-org/native-code/development

Commands to list remote branches and track a specific release branch.

```bash
git branch -r
```

```bash
git checkout -b my_branch refs/remotes/branch-heads/3987
gclient sync
```

--------------------------------

### WebRTC API Prefix Mapping

Source: https://webrtc.github.io/webrtc-org/web-apis/interop

Comparison of W3C standard interface names against their prefixed implementations in Chrome and Firefox.

```text
W3C Standard           Chrome                   Firefox
--------------------------------------------------------------
getUserMedia           webkitGetUserMedia       mozGetUserMedia
RTCPeerConnection      webkitRTCPeerConnection  RTCPeerConnection
RTCSessionDescription  RTCSessionDescription    RTCSessionDescription
RTCIceCandidate        RTCIceCandidate          RTCIceCandidate
```

--------------------------------

### Define MediaHints dictionary properties

Source: https://webrtc.github.io/webrtc-org/blog/2012/05/02/changes-to-our-webrtc-api-implementation.html

Required properties for the MediaHints dictionary used in createOffer and createAnswer.

```javascript
has_audio: boolean
has_video: boolean
```

--------------------------------

### Add WebRTC dependencies to Android Studio

Source: https://webrtc.github.io/webrtc-org/native-code/android

Include the official prebuilt WebRTC libraries in your project dependencies.

```gradle
implementation 'org.webrtc:google-webrtc:1.0.+'
```

```gradle
compile 'org.webrtc:google-webrtc:1.0.+'
```

--------------------------------

### Reference Bugs in CL

Source: https://webrtc.github.io/webrtc-org/contributing

Format for referencing bug tracker issues in a CL description.

```text
Bug: webrtc:1234
```

```text
Bug: chromium:123456
```

--------------------------------

### Retrieve Android WebRTC logs

Source: https://webrtc.github.io/webrtc-org/native-code/logging

Use adb logcat to filter and view logs from the libjingle tag.

```bash
adb logcat -s "libjingle"
```

--------------------------------

### Define IceOptions dictionary property

Source: https://webrtc.github.io/webrtc-org/blog/2012/05/02/changes-to-our-webrtc-api-implementation.html

Required property for the IceOptions dictionary used in startIce.

```javascript
use_candidates: "all", "no_relay", "only_relay"
```

--------------------------------

### Enable Android logging in non-debug builds

Source: https://webrtc.github.io/webrtc-org/native-code/logging

Use this Java method to enable logging output when not using a debug build.

```java
Logging.enableLogToDebugOutput(Logging.Severity.LS_INFO)
```

--------------------------------

### Update an existing patch

Source: https://webrtc.github.io/webrtc-org/contributing

Commands to commit additional changes and update an existing CL.

```bash
# Make changes, build locally, run tests locally
git commit -am "Fixed X and Y"
git cl upload
```

--------------------------------

### Verify Signing Identity

Source: https://webrtc.github.io/webrtc-org/native-code/ios

Check for a valid signing identity required for deploying to physical iOS devices.

```bash
xcrun security find-identity -v -p codesigning
```

--------------------------------

### Update local branch with upstream changes

Source: https://webrtc.github.io/webrtc-org/native-code/development

Synchronize the current branch with the master branch.

```bash
git checkout master
git pull origin master
gclient sync
git checkout my-branch
git merge master
```
Tokens:
Raw