-
Notifications
You must be signed in to change notification settings - Fork 9
/
index.html
106 lines (96 loc) · 6.22 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="X-UA-Compatible" content="chrome=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="format-detection" content="telephone=no">
<meta name="viewport" content="user-scalable=no, initial-scale=1, maximum-scale=1, minimum-scale=1, width=device-width">
<title>rtc.io</title>
<link rel="stylesheet" type="text/css" href="css/reset.css">
<link rel="stylesheet" type="text/css" href="css/main.css">
<!-- responsive -->
<link rel="stylesheet" media="screen and (max-width: 960px)" href="css/tablet.css">
<link rel="stylesheet" media="screen and (max-width: 710px)" href="css/phone.css">
<link rel="stylesheet" type="text/css" href="fonts/source-sans/stylesheet.css">
<link rel="stylesheet" type="text/css" href="css/code.css">
</head>
<body>
<a class="scroll-point pt-top" name="top"></a>
<header>
<a href="https://github.com/rtc-io"><img class="fork" src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png" alt="Fork me on GitHub"></a>
<a class="scroll-point pt-top" name="top"></a>
<div class="site">
<div class="mascot">
<img src="images/artsio.png">
</div>
<div class="logo" data-subtext="OpenSource WebRTC">
<a href="index.html">rtc.io</a>
</div>
<nav>
<ul>
<li><a href="index.html">About</a></li>
<li><a href="tutorials.html">Tutorials</a></li>
<li><a href="demos.html">Demos</a></li>
<li><a href="modules.html">Modules</a></li>
</ul>
</nav>
</div>
<div class="shadow"></div>
</header>
<div class="main" role="content"><h2 id="introducing-rtc-io">Introducing rtc.io</h2>
<p>rtc.io is a collection of node.js modules that simplify WebRTC development.</p>
<p>rtc.io does not only target node.js developers. It also provides a JavaScript library in the rtc module that can be used by any frontend application. That library was created using browserify and lives in the dist directory of the <a href="https://github.com/rtc-io/rtc">rtc repository</a>.</p>
<p>Features supported by rtc.io:</p>
<ul>
<li>access to local camera(s) and microphone(s)</li>
<li>create audio and video calls between browsers</li>
<li>set up data channels between browsers</li>
<li>provide communication management</li>
<li>set up a signalling server</li>
</ul>
<h2 id="getting-started-with-rtc-io">Getting started with rtc.io</h2>
<p>The <a href="module-rtc.html">rtc</a> module is a pre-bundled collection of the essential rtc.io modules you need to get started building your own WebRTC application. You can load this module directly in your HTML page or include it as a require.js module.</p>
<p>Grab the latest build of <a href="module-rtc.html">rtc</a> from <a href="https://github.com/rtc-io/rtc/">https://github.com/rtc-io/rtc/</a>.</p>
<div class="highlight"><pre><span class="nt"><script </span><span class="na">src=</span><span class="s">"path/to/rtc.js"</span><span class="nt">></script></span>
</pre></div>
<div class="highlight"><pre><span class="kd">var</span> <span class="nx">rtcSession</span> <span class="o">=</span> <span class="nx">RTC</span><span class="p">({</span><span class="nx">room</span><span class="o">:</span> <span class="s1">'test-room'</span> <span class="p">});</span>
<span class="nx">rtcSession</span><span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="s1">'ready'</span><span class="p">,</span> <span class="nx">yourInitFunction</span><span class="p">);</span>
</pre></div>
<h2 id="using-commonjs-">Using CommonJS?</h2>
<p>The full suite of rtc.io modules, including <a href="module-rtc.html">rtc</a>, are available individually via npm and can be included using <code>require()</code>. You'll need Browserify (or a similar service) to prepare your CommonJS modules for the browser.</p>
<ul>
<li>Install <a href="https://www.npmjs.org/">Node and NPM</a></li>
<li>Install <a href="http://browserify.org/">Browserify</a></li>
<li><code>npm install rtc</code></li>
</ul>
<div class="highlight"><pre><span class="kd">var</span> <span class="nx">rtc</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'rtc'</span><span class="p">);</span>
<span class="kd">var</span> <span class="nx">rtcSession</span> <span class="o">=</span> <span class="nx">rtc</span><span class="p">({</span><span class="nx">room</span><span class="o">:</span> <span class="s1">'test-room'</span><span class="p">});</span>
<span class="nx">rtcSession</span><span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="s1">'ready'</span><span class="p">,</span> <span class="nx">yourInitFunction</span><span class="p">);</span>
</pre></div>
<ul>
<li><code>browserify yourjsfile.js -o bundle.js</code></li>
</ul>
<p>The <a href="tutorials.html">Tutorial</a> page has a step by step guide to introduce you to the basics of building WebRTC apps with rtc.io. If you already know what you're looking for, check out our complete <a href="modules.html">module list</a></p>
<h2 id="testing-and-webrtc">Testing and WebRTC</h2>
<p>All of the stable modules in the rtc.io suite (and some of the unstable ones too) are being tested using continuous integration (a big thanks to <a href="https://travis-ci.org/">Travis CI</a> for their excellent service). We have further information on <a href="testing-process.html">our testing process</a> if you are interested, and the current build status is displayed with each of our <a href="modules.html">modules</a>.</p>
</div>
<footer>
<p>
<a href="http://nicta.com.au">
<img src="images/nicta-logo.gif" alt="NICTA logo">
</a>© NICTA 2013 - 2014
</p>
<p class="license">Project source code is licensed under the <a href="https://github.com/rtc-io/rtc/blob/master/LICENSE">Apache 2.0</a>.</p>
<a class="closing" href="#top"></a>
</footer>
</body>
<script src="js/app.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-26567546-2', 'rtc.io');
ga('send', 'pageview');
</script>
</html>