-
Notifications
You must be signed in to change notification settings - Fork 9
/
Copy pathmodule-rtc-dcstream.html
144 lines (132 loc) · 12.4 KB
/
module-rtc-dcstream.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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
<!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/rtc-dcstream"><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"><h1 id="rtc-dcstream">rtc-dcstream</h1>
<p>Node streams2 interface for working with WebRTC data channels. This stream
implementation will cater for current data size limits in the WebRTC
data channels.</p>
<p><a href="https://nodei.co/npm/rtc-dcstream/"><img src="https://nodei.co/npm/rtc-dcstream.png" alt="NPM"></a></p>
<p><a href="https://github.com/dominictarr/stability#unstable"><img src="https://img.shields.io/badge/stability-unstable-yellowgreen.svg" alt="unstable"></a> <a href="https://travis-ci.org/rtc-io/rtc-dcstream"><img src="https://img.shields.io/travis/rtc-io/rtc-dcstream.svg?branch=master" alt="Build Status"></a> <a href="https://www.bithound.io/github/rtc-io/rtc-dcstream"><img src="https://www.bithound.io/github/rtc-io/rtc-dcstream/badges/score.svg" alt="bitHound Score"></a> </p>
<h2 id="example-usage">Example Usage</h2>
<p>The example below shows how to use the <code>rtc-dcstream</code> module to stream data
via a datachannel to <em>n</em> remote participants. In this case we are using
the W3C FileReader API and streaming dropped data files over the data
channel:</p>
<div class="highlight"><pre><span class="kd">var</span> <span class="nx">crel</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'crel'</span><span class="p">);</span>
<span class="kd">var</span> <span class="nx">dropkick</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'dropkick'</span><span class="p">);</span>
<span class="kd">var</span> <span class="nx">quickconnect</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'rtc-quickconnect'</span><span class="p">);</span>
<span class="kd">var</span> <span class="nx">fileReader</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'filestream/read'</span><span class="p">);</span>
<span class="kd">var</span> <span class="nx">fileReceiver</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'filestream/write'</span><span class="p">);</span>
<span class="kd">var</span> <span class="nx">multiplex</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'multiplex'</span><span class="p">);</span>
<span class="kd">var</span> <span class="nx">createDataStream</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'rtc-dcstream'</span><span class="p">);</span>
<span class="kd">var</span> <span class="nx">channels</span> <span class="o">=</span> <span class="p">[];</span>
<span class="kd">var</span> <span class="nx">peers</span> <span class="o">=</span> <span class="p">[];</span>
<span class="kd">var</span> <span class="nx">inbound</span> <span class="o">=</span> <span class="p">{};</span>
<span class="kd">function</span> <span class="nx">prepStream</span><span class="p">(</span><span class="nx">dc</span><span class="p">,</span> <span class="nx">id</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">plex</span> <span class="o">=</span> <span class="nx">multiplex</span><span class="p">();</span>
<span class="nx">plex</span><span class="p">.</span><span class="nx">pipe</span><span class="p">(</span><span class="nx">createDataStream</span><span class="p">(</span><span class="nx">dc</span><span class="p">)).</span><span class="nx">pipe</span><span class="p">(</span><span class="nx">multiplex</span><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">stream</span><span class="p">,</span> <span class="nx">type</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">stream</span><span class="p">.</span><span class="nx">pipe</span><span class="p">(</span><span class="nx">fileReceiver</span><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">file</span><span class="p">)</span> <span class="p">{</span>
<span class="nb">document</span><span class="p">.</span><span class="nx">body</span><span class="p">.</span><span class="nx">appendChild</span><span class="p">(</span><span class="nx">crel</span><span class="p">(</span><span class="s1">'img'</span><span class="p">,</span> <span class="p">{</span> <span class="nx">src</span><span class="o">:</span> <span class="nx">URL</span><span class="p">.</span><span class="nx">createObjectURL</span><span class="p">(</span><span class="nx">file</span><span class="p">)</span> <span class="p">}));</span>
<span class="p">},</span> <span class="p">{</span> <span class="nx">type</span><span class="o">:</span> <span class="nx">type</span> <span class="p">}));</span>
<span class="p">}));</span>
<span class="k">return</span> <span class="nx">plex</span><span class="p">;</span>
<span class="p">}</span>
<span class="nx">quickconnect</span><span class="p">(</span><span class="s1">'http://rtc.io/switchboard'</span><span class="p">,</span> <span class="p">{</span> <span class="nx">room</span><span class="o">:</span> <span class="s1">'filetx-test'</span> <span class="p">})</span>
<span class="p">.</span><span class="nx">createDataChannel</span><span class="p">(</span><span class="s1">'files'</span><span class="p">)</span>
<span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="s1">'channel:opened:files'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">id</span><span class="p">,</span> <span class="nx">dc</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">peers</span><span class="p">.</span><span class="nx">push</span><span class="p">(</span><span class="nx">id</span><span class="p">);</span>
<span class="nx">channels</span><span class="p">.</span><span class="nx">push</span><span class="p">(</span><span class="nx">prepStream</span><span class="p">(</span><span class="nx">dc</span><span class="p">,</span> <span class="nx">id</span><span class="p">));</span>
<span class="p">})</span>
<span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="s1">'peer:leave'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">id</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">peerIdx</span> <span class="o">=</span> <span class="nx">peers</span><span class="p">.</span><span class="nx">indexOf</span><span class="p">(</span><span class="nx">id</span><span class="p">);</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">peerIdx</span> <span class="o">>=</span> <span class="mi">0</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">peers</span><span class="p">.</span><span class="nx">splice</span><span class="p">(</span><span class="nx">peerIdx</span><span class="p">,</span> <span class="mi">1</span><span class="p">);</span>
<span class="nx">channels</span><span class="p">.</span><span class="nx">splice</span><span class="p">(</span><span class="nx">peerIdx</span><span class="p">,</span> <span class="mi">1</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">})</span>
<span class="nx">dropkick</span><span class="p">(</span><span class="nb">document</span><span class="p">.</span><span class="nx">body</span><span class="p">).</span><span class="nx">on</span><span class="p">(</span><span class="s1">'file'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">file</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">channels</span><span class="p">.</span><span class="nx">forEach</span><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">plex</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">fileReader</span><span class="p">(</span><span class="nx">file</span><span class="p">).</span><span class="nx">pipe</span><span class="p">(</span><span class="nx">plex</span><span class="p">.</span><span class="nx">createStream</span><span class="p">(</span><span class="nx">file</span><span class="p">.</span><span class="nx">type</span><span class="p">));</span>
<span class="p">});</span>
<span class="p">});</span>
<span class="c1">// give the document some size so we can drag and drop stuff</span>
<span class="nb">document</span><span class="p">.</span><span class="nx">body</span><span class="p">.</span><span class="nx">style</span><span class="p">.</span><span class="nx">width</span> <span class="o">=</span> <span class="s1">'100vw'</span><span class="p">;</span>
<span class="nb">document</span><span class="p">.</span><span class="nx">body</span><span class="p">.</span><span class="nx">style</span><span class="p">.</span><span class="nx">height</span> <span class="o">=</span> <span class="s1">'100vw'</span><span class="p">;</span>
</pre></div>
<h2 id="alternative-implementations">Alternative Implementations</h2>
<p>In addition to this module, the following are other modules that wrap
WebRTC data channel communication via a node streaming interface:</p>
<ul>
<li><a href="https://github.com/kumavis/rtc-data-stream">rtc-data-stream</a></li>
</ul>
<h2 id="reference">Reference</h2>
<p>To be completed.</p>
<h2 id="license-s-">License(s)</h2>
<h3 id="apache-2-0">Apache 2.0</h3>
<p>Copyright 2015 National ICT Australia Limited (NICTA)</p>
<p> Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at</p>
<pre><code> http://www.apache.org/licenses/LICENSE-2.0</code></pre>
<p> Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.</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>