Merge branch 'master' of https://github.com/yingDev/Web-Rtmp

Author: 应元东

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+
+# Matches multiple files with brace expansion notation
+# Set default charset
+[*.*]
+charset = utf-8
+indent_style = tab
+indent_size = 4
+trim_trailing_whitespace = true

README.md

@@ -1,28 +1,34 @@
 # Web-Rtmp
 在网页上播放RTMP视频流，通过Websocket。
 
-# 基本原理
-- 服务端使用 [websockify](https://github.com/kanaka/websockify)  中转一个rtmp流。 ([yingDev的fork](https://github.com/yingDev/websockify) 去掉了base64子协议检查)
-    ```bash
-    ./websockify.py 1999 <rtmp_server>:1935
-    ```
-- 浏览器中使用 [node-rtmpapi](https://github.com/delian/node-rtmpapi) 解析 RTMP 协议，完成握手和通信。 ([yingDev的fork](https://github.com/yingDev/node-rtmpapi) 增加了浏览器支持、修正了几个错误)
-
-- 提取其中的 H264 视频流
-
-- 发送给 [Broadway](https://github.com/mbebenita/Broadway) 解码
-    ```js
+## 基本原理
+- 服务端
+	- 使用 [websockify](https://github.com/kanaka/websockify)  wrap 一个 rtmp 服务器地址。 ([yingDev的fork](https://github.com/yingDev/websockify) 去掉了base64子协议检查)
+	
+     ```bash
+     ./websockify.py 1999 <rtmp_server>:1935
+     ```
+- 浏览器
+	- 使用 [node-rtmpapi](https://github.com/delian/node-rtmpapi) 解析 RTMP 协议，完成握手和通信。 ([yingDev的fork](https://github.com/yingDev/node-rtmpapi) 增加了浏览器支持、修正了几个错误)
+
+	- 提取其中的 H264 视频流
+
+	- 喂给 [Broadway](https://github.com/mbebenita/Broadway) 解码
+	
+   	 ```js
     decoder.decode(frame);
-    ```
+   	 ```
 
-# 使用
+## 使用
 ```js
+//比如 rtmp://helloworld.com/live/abc ---> app='live', streamName='abc', rtmp_server='helloworld.com'
+// ./websockify.py 1999 helloworld.com:1935
 var player = new WebRtmpPlayer('ws://127.0.0.1:1999', '<app>', '<streamName>', 'rtmp://<rtmp_server>/<app>');
 player.canvas.style['height'] = '100%';
 document.getElementById("vidCont").appendChild(player.canvas);
 ```
 
-# 运行
+## 运行
 ```bash
 git clone https://github.com/yingDev/Web-Rtmp.git
 cd Web-Rtmp
@@ -42,12 +48,12 @@ webpack -w
 open index.html
 ```
 
-# 局限
+## 局限
 - Broadway: 
    <blockquote> The decoder ...does not support weighted prediction for P-frames and CABAC entropy encoding...</blockquote>
 
 
-# 参考资料
+## 参考资料
 - Real-Time Messaging Protocol (RTMP) specification <br>
 http://www.adobe.com/devnet/rtmp.html