-
-
Notifications
You must be signed in to change notification settings - Fork 5.4k
v1_EN_RtmpUrlVhost
The url of RTMP is simple, and the vhost is not a new concept, although it's easy to confuse for the fresh. What is vhost? What is app? Why FMLE should input the app and stream?
The benifit of RTMP and HLS, see: HLS
The use scenario of vhost:
- Multiple customers cloud: For example, CDN(content delivery network) serves multiple customers. How does CDN to seperate customer and stat the data? Maybe stream path is duplicated, for example, live/livestream is the most frequently used app and stream. The vhost, similar to the virtual server, provides abstract for multiple customers.
- Different config: For example, FMLE publish h264+mp3, which should be transcoded to h264+aac. We can use vhost to use different config, h264+mp3 disabled hls while the h264+aac vhost enalbe hls.
In a word, vhost is the element of config, to seperate customer and apply different config.
Standard RTMP URL is the most compatible URL, for all servers and players can identify. The RTMP URL is similar to the HTTP URL:
| HTTP | Schema | Host | Port | Path | |
|---|---|---|---|---|---|
| http://192.168.1.10:80/players/srs_player.html | http | 192.168.1.10 | 80 | /players/srs_player.html | |
| rtmp://192.168.1.10:1935/live/livestream | rtmp | 192.168.1.10 | 1935 | live | livestream |
| RTMP | Schema | Host | Port | App | Stream |
It is:
- Schema：The protocol prefix, HTTP/HTTPS for HTTP protocol, and RTMP/RTMPS/RTMPE/RTMPT for RTMP protocol, while the RTMFP is adobe flash p2p protocol.
- Host：The server ip or dns name to connect to. It is dns name for CDN, and the dns name is used as the vhost for the specified customer.
- Port：The tcp port, default 80 for HTTP and 1935 for RTMP.
- Path：The http file path for HTTP.
- App：The application for RTMP, similar to the directory of resource(stream).
- Stream：The stream for RTMP, similar to the resource(file) in specified app.
However, most user donot need the vhost, and it's a little complex, so donot use it when you donot need it. Most user actually only need app and stream.
When to use vhost? When you serve 100+ customers and use the same delivery network, they use theire own vhost and can use the sample app and stream.
The common use scenario, for example, if you use SRS to build a video website. So you are the only customer, donot need vhost. Suppose you provides video chat, there are some categories which includes some chat rooms. For example, categories are military, reader, history. The military category has rooms rock, radar; the reader category has red_masion. The config of SRS is very simple:
listen 1935;
vhost __defaultVhost__ {
}When generate web pages, for instance, military category, all app is military. The url of chat room is rtmp://yourdomain.com/military/rock, while the encoder publish this stream, and all player play this stream.
The other pages of the military category use the same app name military, but use the different stream name, fr example, radar chat room use the stream url rtmp://yourdomain.com/military/radar.
When generate the pages, add new stream, the config of SRS no need to change. For example, when add a new chat room cannon, no need to change config of SRS. It is simple enough!
The reader category can use app reader, and the red_mansion chat room can use the url rtmp://yourdomain.com/reader/red_mansion.
The vhost of RTMP is same to HTTP virtual server. For example, the demo.srs.com is resolve to 192.168.1.10 by dns or hosts:
| HTTP | Host | Port | VHost |
|---|---|---|---|
| http://demo.srs.com:80/players/srs_player.html | 192.168.1.10 | 80 | demo.srs.com |
| rtmp://demo.srs.com:1935/live/livestream | 192.168.1.10 | 1935 | demo.srs.com |
| RTMP | Host | Port | VHost |
The use scenario of vhost:
- Multiple Customers: When need to serve multiple customers use the same network, for example, cctv and wasu delivery stream on the same CDN, how to seperate them, when they use the same app and stream?
- DNS scheduler: When CDN delivery content, the fast edge for the specified user is resolved for the dns name. We can use vhost as the dns name to scheduler user to different edge.
- Multiple Config sections: Sometimes we need different config, for example, to delivery RTMP for PC and transcode RTMP to HLS for android and IOS, we can use one vhost to delivery RTMP and another for HLS.
For example, we got two customers cctv and wasu, use the same edge server 192.168.1.10, when user access the stream of these two customers:
| RTMP | Host | Port | VHost | App | Stream |
|---|---|---|---|---|---|
| rtmp://show.cctv.cn/live/livestream | 192.168.1.10 | 1935 | show.cctv.cn | live | livestream |
| rtmp://show.wasu.cn/live/livestream | 192.168.1.10 | 1935 | show.wasu.cn | live | livestream |
The config on the edge 192.168.1.10, need to config the vhost:
listen 1935;
vhost show.cctv.cn {
enabled on;
}
vhost show.wasu.cn {
enabled on;
}Please refer to the tech for DNS and CDN.
以上面举的例子，若cctv需要延迟最低（意味着启动时只有声音，画面是黑屏），而wasu需要快速启动（打开就能看到视频，服务器cache了最后一个gop，延迟会较大）。
只需要对这两个Vhost进行不同的配置，例如：
listen 1935;
vhost show.cctv.cn {
enabled on;
gop_cache off;
}
vhost show.wasu.cn {
enabled on;
gop_cache on;
}总之，这两个Vhost的配置完全没有关系，不会相互影响。
FMS的__defaultVhost__是默认的vhost，当用户请求的vhost没有匹配成功时，若配置了defaultVhost，则使用它来提供服务。若匹配失败，也没有defaultVhost，则返回错误。
譬如，服务器192.168.1.10上的SRS配置如下：
listen 1935;
vhost demo.srs.com {
enabled on;
}那么，当用户访问以下vhost时：
- rtmp://demo.srs.com/live/livestream：成功，匹配vhost为demo.srs.com
- rtmp://192.168.1.10/live/livestream：失败，没有找到vhost，也没有defaultVhost。
defaultVhost和其他vhost的规则一样，只是用来匹配那些没有匹配成功的vhost的请求的。
如何访问某台服务器上的Vhost？有两个方法：
- 配置hosts：因为Vhost实际上就是DNS解析，所以可以配置客户端的hosts，将域名（Vhost）解析到指定的服务器，就可以访问这台服务器上的指定的vhost。
- 使用app的参数：需要服务器支持。在app后面带参数指定要访问的Vhost。SRS支持?vhost=VHOST和...vhost...VHOST这两种方式，后面的方式是避免一些播放器不识别？和=等特殊字符。
普通用户不用这么麻烦，直接访问RTMP地址就好了，有时候运维需要看某台机器上的Vhost的流是否有问题，就需要这种特殊的访问方式。考虑下面的例子：
RTMP URL: rtmp://demo.srs.com/live/livestream
边缘节点数目：50台
边缘节点IP：192.168.1.100 至 192.168.1.150
边缘节点SRS配置：
listen 1935;
vhost demo.srs.com {
enabled on;
}各种访问方式见下表：
| 用户 | RTMP URL | hosts设置 | 目标 |
|---|---|---|---|
| 普通用户 | rtmp://demo.srs.com/live/livestream | 无 | 正常观看直播流 |
| 运维 | rtmp://demo.srs.com/live/livestream | 192.168.1.100 demo.srs.com | 查看192.168.1.100上的流 |
| 运维 | rtmp://192.168.1.100/live?vhost=demo.srs.com/livestream | 无 | 查看192.168.1.100上的流 |
| 运维 | rtmp://192.168.1.100/live...vhost...demo.srs.com/livestream | 无 | 查看192.168.1.100上的流 |
访问其他服务器的流也类似。
FMLE推流时，URL那个地方，有三个可以输入的框，参考Adobe FMLE：
- FMS URL: 需要输入rtmp://host:port/app，例如：rtmp://demo.srs.com/live
- Backup URL: 备份的服务器，格式同FMS URL。若指定了备份服务器，FMLE会同时推送给这两个服务器。
- Stream: 流名称，例如：livestream
实际上是将RTMP URL分成了两部分，stream前面那部分和stream。为何要这么搞？我猜想有以下原因：
- 支持多级app和Stream：我们目前举的例子都是一级app和一级stream，实际上RTMP支持多级app和stream，就像子文件夹，实际上很少用得到。所以SRS的URL都是一个地址，默认最后一个/后面就是stream，前面是app。
- 支持流名称带参数：Adobe的鬼HLS/HDS非常之麻烦，那个地址是个恶心的完全不一致。参考FMS livepkgr，例如发布一个rtmp，并切片成HLS：
FMLE:
FMS URL: rtmp://demo.srs.com/livepkgr
Stream: livestream?adbe-live-event=liveevent
Client:
RTMP: rtmp://demo.srs.com/livepkgr/livestream
HLS: http://demo.srs.com/hls-live/livepkgr/_definst_/liveevent/livestream.m3u8
HDS: http://demo.srs.com/hds-live/livepkgr/_definst_/liveevent/livestream.f4m没有比这个更恶心的东西了。比较SRS的简洁方案：
FMLE:
FMS URL: rtmp://demo.srs.com/livepkgr
Stream: livestream
Client:
RTMP: rtmp://demo.srs.com/livepkgr/livestream
HLS: http://demo.srs.com/livepkgr/livestream.m3u8
HDS: not support yet.既然谈到了RTMP URL中的参数，下一章就说说这个。
RTMP URL一般是不带参数，类似于http的query，有时候为了特殊的要求，会在RTMP URL中带参数，譬如：
- Vhost：前面讲过，在app后面加参数，可以访问指定服务器的指定Vhost。这个SRS的特殊约定，方便排错。
- FMLE的Stream后面的参数，指定event之类的。SRS不需要这么麻烦，HLS是内置支持，无需这种复杂的配置。Callback也是http的，FMS为了支持服务器端脚本，需要很复杂的配置和复杂的参数，实在是很麻烦的设计。
- token认证：SRS还未实现。在连接服务器时，在app后面指定token（方式和vhost一样），例如rtmp://server/live?vhost=xxx&token=xxx/livestream，服务器可以取出token，进行验证，若验证失败则断开连接，这种是比Refer更高级的防盗链。
app和stream后面带参数，这两者有何区别，为何SRS把参数放在app后面？客户端播放流的as3代码大约是：
// how to play url: rtmp://demo.srs.com/live/livestream
conn = new NetConnection();
conn.connect("rtmp://demo.srs.com/live");
stream = new NetStream(conn);
stream.play("livestream");从RTMP协议的角度来看：
- NetConnection.connect(vhost+app)：这一步会完成握手，connect到vhost，切换到app。类似于登录到vhost后，cd到app这个目录。也就是vhost的验证，都可以在这一步做，也就是指定vhost也是在一步了，所以app后面跟的参数都是和vhost/app相关的。
- NetStream.play(stream)：这一步是播放指定的直播流。所以和stream相关的事件，都可以传递参数，譬如Adobe的event。SRS是没有这些事件的，流启动时，若配置了HLS会自动开始切片。
SRS只做简化的事情，绝对不把简单的事情搞复杂。
SRS的RTMP URL使用标准的RTMP URL，一般不需要对app和stream加参数，或者更改他们的意义。除了两个地方：
- vhost支持参数访问：为了方便运维访问某台服务器的vhost，不需要设置hosts。不影响普通用户。
- 支持token验证：为了支持token验证，在app后面带参数，这个是token验证必须的方式。
另外，SRS建议用户使用一级app和一级stream，不使用多级app和多级stream。譬如：
// 不推荐使用的多级app或stream
rtmp://demo.srs.com/show/live/livestream
rtmp://demo.srs.com/show/live/livestream/2013srs播放器(srs_player)和srs编码器(srs_publisher)不支持多级app和stream，他们认为最后一个斜杠（/）后面的就是stream，前面的是app。即：
// srs_player和srs_publisher的解析方式：
// play or publish the following rtmp URL:
rtmp://demo.srs.com/show/live/livestream/2013
schema: rtmp
host/vhost: demo.srs.com
app: show/live/livestream
stream: 2013做此简化的好处是，srs播放器和编码器，只需要指定一个url，而且两者的url是一样的。
SRS常见的三种RTMP URL，详细见下表：
| URL | 说明 |
|---|---|
| rtmp://demo.srs.com/live/livestream | 普通用户的标准访问方式，观看直播流 |
| rtmp://192.168.1.10/live?vhost=demo.srs.com/livestream | 运维对特定服务器排错 |
| rtmp://demo.srs.com/live?key=ER892ID839KD9D0A1D87D/livestream | token验证用户，或者带宽测试的key验证 |
SRS的full.conf配置文件中，有很多Vhost，主要是为了说明各个功能，每个功能都单独列出一个vhost。所有功能都放在demo.srs.com这个vhost中。
| Category | Vhost | 说明 |
|---|---|---|
| RTMP | __defaultVhost__ | 默认Vhost的配置，只支持RTMP功能 |
| RTMP | chunksize.vhost.com | 如何设置chunk size的实例。其他Vhost将此配置打开，即可设置chunk size。 |
| Forward | same.vhost.forward.vhost.com | Forward实例：将流转发到同一个vhost。 |
| Forward | change.vhost.forward.vhost.com | Forward实例：转发时，转发到服务器的不同vhost。 |
| HLS | with-hls.vhost.com | HLS实例：如何开启HLS，以及HLS的相关配置。 |
| HLS | no-hls.vhost.com | HLS实例：如何禁用HLS。 |
| RTMP | min.delay.com | RTMP最低延迟：如何配置最低延迟的RTMP流。 |
| RTMP | refer.anti_suck.com | Refer实例：如何配置Refer防盗链。 |
| RTMP | bandcheck.srs.com | 带宽测试用的vhost，srs测速默认连接到这个vhost。这个vhost配置了带宽测速的key，可测速间隔和最大测速带宽限制。其他Vhost也可以支持测速，只要把这个配置项打开，然后在测速播放器的参数中指明另外的vhost |
| RTMP | removed.vhost.com | 禁用vhost实例：如何禁用vhost。 |
| Callback | hooks.callback.vhost.com | 设置http callback的实例，当这些事件发生时，SRS会调用指定的http api。其他Vhost将这些配置打开，就可以支持http callback。 |
| Transcode | mirror.transcode.vhost.com | 转码实例：使用ffmpeg的实例filter，将视频做镜像翻转处理。其他Vhost添加这个配置，就可以对流进行转码。 注：所有转码的流都需要重新推送到SRS，使用不同的流名称（vhost和app也可以不一样）。 |
| Transcode | drawtext.transcode.vhost.com | 转码实例：在视频上加文字filter。其他Vhost添加此配置，就可以做文字水印。 注：所有转码的流都需要重新推送到SRS，使用不同的流名称（vhost和app也可以不一样）。 |
| Transcode | crop.transcode.vhost.com | 转码实例：剪裁视频filter。其他vhost添加此filter，即可对视频进行剪裁。 注：所有转码的流都需要重新推送到SRS，使用不同的流名称（vhost和app也可以不一样）。 |
| Transcode | logo.transcode.vhost.com | 转码实例：添加图片/视频水印。其他vhost添加这些配置，可以加图片/视频水印。 注：所有转码的流都需要重新推送到SRS，使用不同的流名称（vhost和app也可以不一样）。 |
| Transcode | audio.transcode.vhost.com | 转码实例：只对音频转码。其他vhost添加此配置，可只对音频转码。 注：所有转码的流都需要重新推送到SRS，使用不同的流名称（vhost和app也可以不一样）。 |
| Transcode | copy.transcode.vhost.com | 转码实例：只转封装。类似于forward功能。 |
| Transcode | all.transcode.vhost.com | 转码实例：对上面的实例的汇总。 |
| Transcode | ffempty.transcode.vhost.com | 调用ffempty程序转码，这个只是一个stub，打印出参数而已。用作调试用，看参数是否传递正确。 |
| Transcode | app.transcode.vhost.com | 转码实例：只对匹配的app的流进行转码。 |
| Transcode | stream.transcode.vhost.com | 转码实例：只对匹配的流进行转码。 |
SRS的demo.conf配置文件中，包含了demo用到的一些vhost，参考Usage: Demo。
| Category | Vhost | 说明 |
|---|---|---|
| DEMO | players | srs_player播放的演示流，按照Readme的Step会推流到这个vhost，demo页面打开后播放的流就是这个vhost中的流 |
| DEMO | players_pub | srs编码器推流到players这个vhost，然后转码后将流推送到这个vhost，并切片为hls，srs编码器播放的带字幕的流就是这个vhost的流 |
| DEMO | players_pub_rtmp | srs编码器演示页面中的低延时播放器，播放的就是这个vhost的流，这个vhost关闭了gop cache，关闭了hls，让延时最低（在1秒内） |
| DEMO | demo.srs.com | srs的演示vhost，Readme的step最后的12路流演示，以及播放器的12路流延时，都是访问的这个vhost。包含了SRS所有的功能。 |
| Others | dev | 开发用的，可忽略 |
Winlin 2014.10
Welcome to SRS wiki!
Please select your language:
Please select your language:
Please select your language:
Please select your language:
Please select your language: