Skip to content
This repository was archived by the owner on Oct 25, 2024. It is now read-only.

Commit 6a902dc

Browse files
authored
Merge pull request #76 from jianjunz/owt
Rename Open Media Streamer(OMS) to Open WebRTC Toolkit(OWT).
2 parents b052529 + 42cd018 commit 6a902dc

35 files changed

+405
-403
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Open Media Streamer JavaScript SDK
1+
# Open WebRTC Toolkit JavaScript SDK
22

3-
Open Media Streamer JavaScript SDK builds on top of the W3C standard WebRTC APIs to accelerate development of real-time communications (RTC) for web applications, including peer-to-peer, broadcasting, and conference mode communications.
3+
Open WebRTC Toolkit JavaScript SDK builds on top of the W3C standard WebRTC APIs to accelerate development of real-time communications (RTC) for web applications, including peer-to-peer, broadcasting, and conference mode communications.
44

55
## How to build release package
66
1. Run `npm install -g grunt-cli` to install grunt.
@@ -16,11 +16,11 @@ Run `grunt debug` in "scripts" folder and get files in "dist/sdk-debug".
1616
Run `grunt jsdoc` in "scripts" folder and get docs in "dist/docs".
1717

1818
## How to contribute
19-
We warmly welcome community contributions to Open Media Streamer JavaScript SDK repository. If you are willing to contribute your features and ideas to OMS, follow the process below:
19+
We warmly welcome community contributions to Open WebRTC Toolkit JavaScript SDK repository. If you are willing to contribute your features and ideas to OWT, follow the process below:
2020
- Make sure your patch will not break anything, including all the build and tests
21-
- Submit a pull request onto https://github.com/open-media-streamer/oms-client-javascript/pulls
21+
- Submit a pull request onto https://github.com/open-webrtc-toolkit/owt-client-javascript/pulls
2222
- Watch your patch for review comments if any, until it is accepted and merged
23-
OMS project is licensed under Apache License, Version 2.0. By contributing to the project, you agree to the license and copyright terms therein and release your contributions under these terms.
23+
OWT project is licensed under Apache License, Version 2.0. By contributing to the project, you agree to the license and copyright terms therein and release your contributions under these terms.
2424

2525
## How to report issues
2626
Use the "Issues" tab on Github.

docs/jsdoc/config.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
"dateFormat": "ddd MMM Do YYYY",
2727
"outputSourceFiles": false,
2828
"outputSourcePath": false,
29-
"systemName": "Open Media Streamer",
29+
"systemName": "Open WebRTC Toolkit",
3030
"footer": "",
3131
"copyright": "Copyright © 2018 Intel Corporation. All Rights Reserved. ",
3232
"navType": "vertical",

docs/jsdoc/template/tmpl/layout.tmpl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
</tr>
4747
<tr>
4848
<td colspan="3" style="font:115% Tahoma, Arial, sans-serif;padding-top:15px;padding-bottom:15px">
49-
<font color="white" style="padding-left: 10px;">Open Media Streamer Client SDK for JavaScript</font>
49+
<font color="white" style="padding-left: 10px;">Open WebRTC Toolkit Client SDK for JavaScript</font>
5050
</td>
5151
<td style="overflow:visible;rowspan:2">
5252
<div class="navbar-nameclass navbar-collapse collapse" id="topNavigation">

docs/mdfiles/index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
Open Media Streamer Client SDK for JavaScript
1+
Open WebRTC Toolkit Client SDK for JavaScript
22
------------------
33

44
# 1 Introduction
5-
The Open Media Streamer Client SDK for JavaScript provides tools to help you develop Web applications. The SDK is distributed in the `CS_WebRTC_Client_SDK_JavaScript.<ver>.zip` release package.
5+
The Open WebRTC Toolkit Client SDK for JavaScript provides tools to help you develop Web applications. The SDK is distributed in the `CS_WebRTC_Client_SDK_JavaScript.<ver>.zip` release package.
66

77
Refer to the SDK release notes for the latest information on the SDK release package, including features, supported browsers, bug fixes, and known issues.
88

9-
Please include `adapter.js` before `oms.js` in HTML files. `adapter.js` is an open source project hosted on [Github](https://github.com/webrtc/adapter). The revision we depend on is `4.0.2`.
9+
Please include `adapter.js` before `owt.js` in HTML files. `adapter.js` is an open source project hosted on [Github](https://github.com/webrtc/adapter). The revision we depend on is `4.0.2`.
1010

11-
If you want to use conference SDK, please also include `socket.io.js` before `oms.js`.
11+
If you want to use conference SDK, please also include `socket.io.js` before `owt.js`.
1212

1313
# 2 Browser requirement
1414

15-
The Open Media Streamer Client SDK for JavaScript has been tested on the following browsers and operating systems:
15+
The Open WebRTC Toolkit Client SDK for JavaScript has been tested on the following browsers and operating systems:
1616

1717
Conference Mode:
1818

@@ -63,15 +63,15 @@ Developers can help end users to make these changes by Firefox extension.
6363
> **Note:** End users need to visit your site with https if they want to use screen sharing.
6464
6565
# 4 NAT and firewall traversal
66-
Open Media Streamer Client SDK for JavaScript fully supports NAT and firewall traversal with STUN / TURN / ICE. The Coturn TURN server from https://github.com/coturn/coturn can be one choice.
66+
Open WebRTC Toolkit Client SDK for JavaScript fully supports NAT and firewall traversal with STUN / TURN / ICE. The Coturn TURN server from https://github.com/coturn/coturn can be one choice.
6767

6868
# 5 Peer-to-peer (P2P) mode
6969
To enable P2P chat, copy and paste the following code into the head section of your HTML document:
7070
~~~~~~{.js}
7171
<script type="text/JavaScript" src="socket.io.js"></script>
7272
<script type="text/JavaScript" src="sc.websocket.js"></script>
7373
<script type="text/JavaScript" src="adapter.js"></script>
74-
<script type="text/JavaScript" src="oms.js"></script>
74+
<script type="text/JavaScript" src="owt.js"></script>
7575
~~~~~~
7676
If you're using customized signling channel, please replace `socket.io.js` and `sc.websocket.js` with your own signaling channel implementation.
7777

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "oms-javascript",
3-
"title": "Open Media Streamer JavaScript SDK",
4-
"description": "Open Media Streamer JavaScript SDK",
3+
"title": "Open WebRTC Toolkit JavaScript SDK",
4+
"description": "Open WebRTC Toolkit JavaScript SDK",
55
"version": "4.1.0",
66
"homepage": "https://webrtc.intel.com",
77
"author": "Intel WebRTC team",

scripts/Gruntfile.js

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
module.exports = function(grunt) {
33

44
const sdkEntry = 'src/sdk/export.js';
5-
const sdkOutput = 'dist/sdk/oms.js';
5+
const sdkOutput = 'dist/sdk/owt.js';
66

77
var srcFiles = [
88
'src/sdk/base/**',
@@ -47,7 +47,7 @@ window.L = L;\n\
4747
dest: sdkOutput,
4848
options: {
4949
browserifyOptions: {
50-
standalone: 'Oms',
50+
standalone: 'Owt',
5151
debug: false
5252
},
5353
transform: [
@@ -57,10 +57,10 @@ window.L = L;\n\
5757
},
5858
dev: {
5959
src: [sdkEntry],
60-
dest: 'dist/sdk-debug/oms.js',
60+
dest: 'dist/sdk-debug/owt.js',
6161
options: {
6262
browserifyOptions: {
63-
standalone: 'Oms',
63+
standalone: 'Owt',
6464
debug: true
6565
},
6666
transform: [
@@ -126,7 +126,7 @@ window.L = L;\n\
126126
src: restFiles,
127127
dest: 'dist/samples/conference/public/scripts/rest.js',
128128
options:{
129-
footer:'module.exports = OMS_REST;',
129+
footer:'module.exports = OWT_REST;',
130130
process: true
131131
},
132132
nonull: true
@@ -163,7 +163,7 @@ window.L = L;\n\
163163
uglify: {
164164
dist: {
165165
files: {
166-
'dist/sdk/oms.js': ['dist/sdk/oms.js']
166+
'dist/sdk/owt.js': ['dist/sdk/owt.js']
167167
},
168168
options: {
169169
banner: '<%= meta.banner %>',
@@ -180,9 +180,9 @@ window.L = L;\n\
180180
{expand: true,cwd:'src/samples/conference/',src:['initcert.js'],dest:'dist/samples/conference/',flatten:false,mode:true},
181181
{expand: true,cwd:'src/samples/conference/cert/',src:['.woogeen.keystore'],dest:'dist/samples/conference/cert/',flatten:false,mode:true},
182182
{expand: true,cwd:'src/extension/',src:['**'],dest:'dist/',flatten:false},
183-
{expand: true,cwd:'dist/sdk/',src:['oms.js'],dest:'dist/samples/conference/public/scripts/',flatten:false},
183+
{expand: true,cwd:'dist/sdk/',src:['owt.js'],dest:'dist/samples/conference/public/scripts/',flatten:false},
184184
{expand: true,cwd:'dist/samples/conference/public/scripts',src:['rest.js'],dest:'dist/samples/conference/',flatten:false},
185-
{expand: true,cwd:'dist/sdk/',src:['oms.js'],dest:'dist/samples/p2p/js/',flatten:false}
185+
{expand: true,cwd:'dist/sdk/',src:['owt.js'],dest:'dist/samples/p2p/js/',flatten:false}
186186
]
187187
}
188188
},
@@ -195,7 +195,7 @@ window.L = L;\n\
195195
replacements: [
196196
{
197197
pattern: /<!-- SDK Starts -->[\w\W]+<!-- SDK Stops -->/gm,
198-
replacement: '<script src="js/oms.js" type="text/javascript"></script>'
198+
replacement: '<script src="js/owt.js" type="text/javascript"></script>'
199199
},
200200
{
201201
pattern: /var serverAddress.*/g,
@@ -211,8 +211,8 @@ window.L = L;\n\
211211
options: {
212212
replacements: [
213213
{
214-
pattern: '<script src="../../../../dist/sdk-debug/oms.js" type="text/javascript"></script>',
215-
replacement: '<script src="scripts/oms.js" type="text/javascript"></script>'
214+
pattern: '<script src="../../../../dist/sdk-debug/owt.js" type="text/javascript"></script>',
215+
replacement: '<script src="scripts/owt.js" type="text/javascript"></script>'
216216
},
217217
]
218218
}

src/samples/conference/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "oms-sample-conference",
3-
"title": "Open Media Streamer Conference Sample",
4-
"description": "Open Media Streamer JavaScript Conference Sample",
3+
"title": "Open WebRTC Toolkit Conference Sample",
4+
"description": "Open WebRTC Toolkit JavaScript Conference Sample",
55
"version": "4.1.0",
66
"homepage": "http://webrtc.intel.com",
77
"author": "Intel WebRTC team",

src/samples/conference/public/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
<script src="https://code.jquery.com/jquery-3.2.1.min.js"></script>
4444
<script src="https://cdnjs.cloudflare.com/ajax/libs/socket.io/2.2.0/socket.io.js" type="text/javascript"></script>
4545
<script src="https://webrtchacks.github.io/adapter/adapter-7.0.0.js" type="text/javascript"></script>
46-
<script src="../../../../dist/sdk-debug/oms.js" type="text/javascript"></script>
46+
<script src="../../../../dist/sdk-debug/owt.js" type="text/javascript"></script>
4747
<script src="scripts/index.js" type="text/javascript"></script>
4848
<script src="scripts/rest-sample.js" type="text/javascript"></script>
4949
<script language="JavaScript">

src/samples/conference/public/scripts/index.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ const runSocketIOSample = function() {
4747

4848
var subscribeForward = getParameterByName('forward') === 'true'?true:false;
4949

50-
conference = new Oms.Conference.ConferenceClient();
50+
conference = new Owt.Conference.ConferenceClient();
5151
function renderVideo(stream){
5252
conference.subscribe(stream)
5353
.then((subscriptions)=>{
@@ -107,14 +107,14 @@ const runSocketIOSample = function() {
107107
startStreamingIn(myRoom, mediaUrl);
108108
}
109109
if (isPublish !== 'false') {
110-
const audioConstraintsForMic = new Oms.Base.AudioTrackConstraints(Oms.Base.AudioSourceInfo.MIC);
111-
const videoConstraintsForCamera = new Oms.Base.VideoTrackConstraints(Oms.Base.VideoSourceInfo.CAMERA);
110+
const audioConstraintsForMic = new Owt.Base.AudioTrackConstraints(Owt.Base.AudioSourceInfo.MIC);
111+
const videoConstraintsForCamera = new Owt.Base.VideoTrackConstraints(Owt.Base.VideoSourceInfo.CAMERA);
112112
let mediaStream;
113-
Oms.Base.MediaStreamFactory.createMediaStream(new Oms.Base.StreamConstraints(
113+
Owt.Base.MediaStreamFactory.createMediaStream(new Owt.Base.StreamConstraints(
114114
audioConstraintsForMic, videoConstraintsForCamera)).then(stream => {
115115
mediaStream = stream;
116-
localStream = new Oms.Base.LocalStream(
117-
mediaStream, new Oms.Base.StreamSourceInfo(
116+
localStream = new Owt.Base.LocalStream(
117+
mediaStream, new Owt.Base.StreamSourceInfo(
118118
'mic', 'camera'));
119119
$('.local video').get(0).srcObject = stream;
120120
conference.publish(localStream).then(publication => {

src/samples/p2p/js/sc.websocket.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
/**
66
* @class SignalingChannel
7-
* @classDesc Signaling module for Open Media Streamer P2P chat
7+
* @classDesc Signaling module for Open WebRTC Toolkit P2P chat
88
*/
99
function SignalingChannel() {
1010

0 commit comments

Comments
 (0)