smart rtmpd web 接口说明

已于 2022-05-22 08:35:46 修改
阅读量1k 收藏 3
点赞数
分类专栏： RTMP 流媒体 h264 文章标签： 服务器 rtmp rtsp srt
于 2022-05-21 23:39:14 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/freeabc/article/details/124902724
版权
流媒体 同时被 3 个专栏收录
32 篇文章 10 订阅
订阅专栏
RTMP
27 篇文章 3 订阅
订阅专栏
h264
11 篇文章 2 订阅
订阅专栏

smart rtmpd web 接口分为下面几类

分类名称功能描述
live这个就是平常我们的直播播放接口
rec  这个就是平常我们的录像回放接口
vod  这个就是我们点播接口，支持字目录，对应服务器上的 vod 目录
api主要是为了 web 管理预留的接口，当然前端页面可能也有可能用到
web就是通用的 web 接口，比如：播放器页面和脚本通过这些接口下载和访问
ws_im通过 websocket 实现的 IM 会话接口

web live 接口说明

功能：

用于直播流播放

格式：

# 直播播放
# HTTP GET
http://<服务器地址或域名>:[服务器端口]/live/<流的名字>.<类型>

例子：

http://192.168.1.1:8080/live/stream.flv
参数说明
服务器地址192.168.1.1 支持域名，支持 NAT 映射
服务器端口8080
流的名字stream 
类型flv 也支持 m3u8, mpd 等

直播流推送成功后，WEB 服务端自动产生下面格式的流

类型说明
flv这个支持 http://192.168.1.1:8080/live/stream.flv 的播放， 同时也支持 ws://192.168.1.1:8080/live/stream.flv 的播放
hls这个支持 http://192.168.1.1:8080/live/stream.m3u8 的播放
dash这个支持 http://192.168.1.1:8080/live/stream.mpd 的播放

这些 URL 都是推流后，自动产生的，具体可以通过 http://192.168.1.1:8080/api/stream 进行查询所有的直播流

web rec 接口说明

功能：

用于录像查询和回放

smart rtmpd 的录像方式就是

# 推 rtmp 流进行直播并同时录像
rtmp://<服务器地址>:[服务器端口]/rec/<流的名字>

smart rtmpd 的录像都会自动存储到服务器的 rec 目录下，rec 目录下的一级子目录，就是上述 URL 中的服务器地址，比如：服务器有多个域名 www.qiyicc.com, www.smartrtmpd.com，那么 rec 目录下就会存在目录

编号一级子目录
1www.qiyicc.com
2www.smartrtmpd.com

   下面我们就这个 URL 展开说明

# 比如：推送下述两路流
rtmp://www.qiyicc.com/rec/music
rtmp://www.qiyicc.com/rec/class

那么上述两个录像 URL 会在服务器的目录 /rec/www.qiyicc.com/ 下产生二级子目录，一级子目录以服务器地址命名，二级字目录以流的名字命名

编号二级子目录
1music
2class

二级子目录下，会按日期精确到天命名产生三级子目录

编号三级子目录
12022-05-21
22022-05-22

三级子目录下会记录具体的录像文件，文件名字以时分秒进行命名，类型见文件后缀，目前只支持 m3u8 或 mpd ，建议用 m3u8 进行存储，具体参见 config.xml 里的说明

编号录像文件
108-56-33.m3u8
209-12-35.m3u8

格式：

# 获取录像信息或播放录像文件
# HTTP GET
http://<服务器地址或域名>:[服务器端口]/rec/<流的名称>?[day=年月日]&[time=时分秒]
参数说明
无参

查询录像日期列表，例子如下

请求：

http://192.168.1.1:8080/rec/stream

响应：

{
    "dirs" : 
    [
        "2022-05-21"
    ]
}
这表明此路录像只有 2022-05-21 那天有录像存在
day

查询指定日期录像文件列表表，例子如下

请求：

http://192.168.1.1:8080/rec/stream?day=2022-05-21

响应：

{
    "files" : 
    [
        "18-22-11.m3u8",
        "18-24-33.m3u8",
        "18-34-02.m3u8"
    ]
}
这表明此路录像 2022-05-21 存在三个时间点的录像，分别是 18-22-11， 18-24-33，18-34-02 
time

播放录像

此参数必须包含 day 参数，否则无效，直接播放此路录像，例子如下

请求：

http://192.168.1.1:8080/rec/stream?day=2022-05-21&time=18-22-11.m3u8

响应：

录像数据流，播放器拿到数据流就可以播放了

web vod 接口说明

功能：

用于点播的功能，用户可以把自己的 mp4, mkv或其它类型的视频文件放到服务器上的 /vod 目录下或此目录的子目录下，子目录可以动态创建，支持多级，用户端只要访问对应的 URL 就能实现点播了，推荐用 fmp4 格式的文件

格式：

# 获取点播信息或播放点播文件
# HTTP GET
http://<服务器地址或域名>:[服务器端口]/vod/[一级字目录]/[二级子目录]/<文件名>

例子： 

http://192.168.1.1:8080/vod/sport/football/worldcup.mp4
参数说明
sport一级子目录
football二级子目录
worldcup.mp4视频文件

VOD 文件列表查询，参见下面的 web api 接口有关 vod 的说明 

web api 接口说明

功能：

为后台 WEB 管理或 WEB 前端业务的需求，提供的综合接口。

 格式：

# HTTP GET,PUT
http://<服务器地址>:[服务器端口]/api/<业务标识>
业务标识说明
live直播信息查询接口
rec录像信息查询接口
vod点播信息查询接口
status服务器状态查询接口
config配置文件获取与设置接口
policy服务器转发策略配置
statistics服务器统计信息接口
  • 业务标识 live 
    # 获取直播流相关信息
# HTTP GET
http://<服务器地址>:[服务器端口]/api/live
    参数说明
    无参

    返回当前所有在线流列表，例子如下

    请求：

    http://192.168.1.1:8080/api/live

    响应：

    {
    "stream" : 
    [
        "rtmp://192.168.1.1:1935/live/stream"
    ]
} 
每路直播流的 RTMP 的 URL 列表
    vhost直播流的 vhost 通常就是服务器地址
    app直播流的 app 标签
    name

    直播流的名字  vhost, app, name 必须同时附带，请求返回此路流的详细信息，参数信息以 rtmp url 为主，默认端口可以不带，例子如下

    请求：

    http://192.168.1.1:8080/api/live?vhost=192.168.1.1:1935&app=live&name=stream

    因为 rtmp 默认端口是 1935，也可以写成

    http://192.168.1.1:8080/api/live?vhost=192.168.1.1&app=live&name=stream

    响应：

    {
    "audio" : 
    {
        "channel" : "2",
        "codec" : "aac",
        "samplebit" : "16",
        "samplerate" : "44100"
    },
    "duration" : "PT7M50S",
    "from" : "rtmp",
    "rate" : "4.05 kb/s",
    "rec" : "none",
    "urls" : 
    [
        {
            "type" : "rtmp",
            "url" : "rtmp://192.168.1.1:1935/live/stream"
        },
        {
            "type" : "http-flv",
            "url" : "http://192.168.1.1:8080/live/stream.flv"
        },
        {
             "type" : "ws-flv",
             "url" : "ws://192.168.1.1:8080/live/stream.flv"
         },
         {
              "type" : "http-hls",
              "url" : "http://192.168.1.1:8080/live/stream.m3u8"
          },
          {
               "type" : "http-dash",
               "url" : "http://192.168.1.1:8080/live/stream.mpd"
            },
            {
                "type" : "rtsp",
		"url" : "rtsp://192.168.1.1:8554/live/stream"
            },
            {
                 "type" : "srt",
                 "url" : "srt://192.168.1.1:9000/live/stream"
             }
        ],
        "video" : 
	{
              "codec" : "h264",
              "fps" : "24",
              "gop" : "88",
              "height" : "562",
              "width" : "1000"
	}
}
    cmd

    目前只支持 cmd=count，查询此路视频当前播放端的个数，这个肯定不是精确的统计，请求例子

    请求：

    http://192.168.1.1:8080/api/live?vhost=192.168.1.1:1935&app=live&name=stream&cmd=count

    响应 ：

    rtmp:0
flv:0
rtsp:0
后续可能修订为 json 格式
  • 业务标识 rec 
    # 获取录像列表信息
# HTTP GET
http://<服务器地址>:[服务器端口]/api/rec
    参数说明
    无参

    获取服务器上 /rec 目录下以服务器地址命名的目录下所有的录像名称列表，例子如下

    请求：

    http://192.168.1.1:8080/api/rec

    响应：

    {
    "dirs" : 
    [
        "stream"
    ]
} 
查询到一路录像，名字为 stream，不带参数，因此默认参数 vhost 为192.168.1.1
    vhos

    获取服务器上 /rec 目录下以 vhost 命名的目录下所有的录像名称列表，例子如下

    请求：

    http://192.168.1.1:8080/api/rec?vhost=www.qiyicc.com

    响应：

    {
    "dirs" : 
    [
        "music",
        "sport"
    ]
} 
查询到两路录像，名字为 music, sport

    对于整个录像流程建议如下：

    1. 利用 http://192.168.1.1:8080/api/rec 查询录像列表
获取所有的录像名称

2. 利用 http://192.168.1.1:8080/rec/<流名称> 查询录像日期

3. 利用 http://192.168.1.1:8080/rec/<流名称>?day=xxxx-yy-zz 查询录像文件列表

4. 利用 http://192.168.1.1:8080/rec/<流名称>?day=xxxx-yy-zz&time=iiiii.m3u8 播放录像

具体使用方法，参见上述的 rec 章节说明
  • 业务标识 vod 
    # HTTP GET
http://192.168.1.1:8080/api/vod
    请求：
http://192.168.1.1:8080/api/vod

响应：

{
    "dirs" : 
    [
        "discovery"
    ],
    "files" : 
    [
        "video.mp4"
    ]
}

    我们看到查询到一个子目录和一个文件

    查询子目录：

    请求：
http://192.168.1.1:8080/api/vod/discovery

响应：
{ 
    "dirs" :
    [ 
        "" 
    ], 
    "files" : 
    [ 
        "river.mkv"
    ] 
}
    我们播放 VOD

    http://192.168.1.1:8080/api/vod/discovery/river.mkv
    上传点播视频到服务器

    # HTTP POST
http://192.168.1.1:8080/vod/stream

支持多文件上传，可以利用 postman 进行实验

  • 业务标识 status 
    # 获取服务器状态
# HTTP GET
http://192.168.1.1:8080/api/status

请求：
http://192.168.1.1:8080/api/status

响应：
{
	"http" : 
	{
		"port" : 8080,
		"run" : true,
		"sport" : 8181,
		"ssl" : false
	},
	"rtmp" : 
	{
		"port" : 1935,
		"run" : true,
		"ssl" : false
	},
	"rtsp" : 
	{
		"port" : 8554,
		"run" : true,
		"ssl" : false
	},
	"srt" : 
	{
		"port" : 9000,
		"run" : true
	},
	"start_time" : "2022-05-21 22:18:31"
}
  • 业务标识 config 
    # 获取配置信息
# HTTP GET
http://127.0.0.1:8080/api/config

# 更新配置信息
# HTTP POST
http://127.0.0.1:8080/api/config

    获取配置信息和设置配置信息，需要一个复杂的逻辑，需要重启服务器，况且只能 127.0.0.1 地址访问，这里不多说了，大家可以参考我们 github 上的 WEB 管理后台的接口部分调用

  • 业务标识 policy
    这块同上，相对复杂，这里不做详细解释
     
  • 业务标识 statistics 
    # 获取服务器统计信息
# HTTP GET
http://192.168.1.1:8080/api/statistics

这个是获取的统计信息，目前意义不大

WEB ( web ) 通用接口说明

这个接口对应的服务器上的 /html 目录，这个是个简单的 http 服务器，可以把播放器页面与脚本，聊天室页面与脚本到此目录，目录与文件名字禁止与上述 URL 中的重复，那样会导致优先访问上述 URL，把 index.html 放到 /html 目录下，直接输入 http://192.168.1.1:8080 就能直接显示了，这里不做过多介绍

例子，访问播放器 ：

http://192.168.1.1:8080/webrtc.html

效果如下

WEB IM 接口说明

这个对应服务器下 /html 目录下的 webrtc.html 以及脚本文件，有兴趣的朋友可以自行研究一下代码。

这个里面实现点对点聊天，群组聊天，利用浏览器自带的 webrtc 进行音视频聊天。这里就不做过多说明，具体实现就是上图 webrtc.html 

WEB 接口认证

参见服务器的配置文件 config.xml

<config>
    <authurl timeout="3000" router="/api">www.qiyicc.com<authurl/>
</config>

为了防止非法操作上述 web 接口，需要对每个 web 请求进行鉴权验证。就需要在服务器上配置类似的验证信息。服务器作为 web client，鉴权服务器作为 web server ，访问方式就是一个 HTTP GET 请求

参数说明
timeout连接鉴权服务器超时时间，毫秒
router

就是 HTTP GET 请求 URL 前面加的前缀，方便鉴权服务器编程方便，比如上述配置里，router="/api"，假设需要对获取服务器配置授权，web client 发往鉴权服务器的 HTTP 报文如下：

GET /api/api/config?type=http&role=api HTTP/1.1
User-Agent: smart_rtmpd
Host: www.qiyicc.com:80
Connection: close
 

/api/api/config?type=http&role=api

第一个 api 就是上述配置的 router="/api"

第二个 api 就是上述的 web api 接口部分的 api/config 

参数 type 表示这个鉴权请求来自于 http 业务

参数 role 表示这个鉴权请求是来自 api 这个业务标识

如果 router 配置为空那么请求就变成

GET /api/config?type=http&role=api HTTP/1.1
User-Agent: smart_rtmpd
Host: www.qiyicc.com:80
Connection: close

freeabc
关注
专栏目录
smart_rtmpd：RTMP服务器，智能，紧凑，高性能，高并发性，易于维护，易于部署（支持Windows和Linux多个操作系统...）
02-17
smart_rtmpd说明 您可以通过Google翻译将文档从中文翻译成英文！！！ smart_webrtc下载网址： see github directory smart_webrtc or download from below url url : https://pan.baidu.com/s/13RxwyJQtpD2iBssOdICfSQv , password : gq6m 构建ffmpeg支持rtmps，请参见以下链接： https://www.iiwnz.com/compile-ffmpeg-with-rtmps-for-facebook/ you can play rtmps with vlc. 聪明的rtmpd下载网址： http://www.qiyicc.com/download/rtmpd.zip 支持协议： p
smart rtmpd 服务器配置文件说明及优化方法介绍
freeabc的专栏
06-04 5236
---------------------------------------------------------------------------------------------------------------------------------------- 一分钟快速搭建 rtmpd 服务器:https://blog.csdn.net/freeabc/article/details/102880984 软件下载地址:http://www.qiyicc.com/download/rtm..
使用smart_rtmpd快速搭建rtmp服务器
最新发布
cipher1985的博客
08-14 340
下载smart_rtmpd软件包，解压rtmpd.rar，进一步解压smart_rtmpd_win.rar得到smart_rtmpd.exe文件。运行smart_rtmpd.exe文件，直接启动。（在smart_rtmpd.exe同级目录下的config.xml文件为配置文件）smart_rtmpd会在启动时获取本机所有网络的ip地址，自动生成rtmp服务器地址。具体样式：rtmp://127.0.0.1/live/stream。分别进入smart_rtmpd和ffmpeg官网下载资源。
smart_rtmpd 流媒体服务器 --- 简易，高效，稳定，强大的框架满足各种场景应用 (CDN, Live, VOD)
freeabc的专栏
06-03 850
如果您不理解，可以理解为和 nginx-rtmp, srs ，并与此功能类似，特点是性能卓越，跨平台，无依赖，部署和维护十分方便，解压既能运行。|web接口 ( web interface ) |https://github.com/superconvert/smart_rtmpd/blob/master/web_dev.md |* 灵活的布署模式，支持单服务器，集群，级联等多种模式，满足各种业务需求 ( rewrite )，也满足大规模布署的需要。谁说我们不为钱，任何软件的初衷都是为了钱，精确的说价值。
smart_rtmpd.rar 一款强悍的跨平台的直播服务器软件
11-03
非常精巧强悍的工具，功能强大，配置灵活，无任何依赖，解压既运行。性能高效，堪比 SRS
最强悍的流媒体服务器 smart rtmpd
08-25
支持 rtmp, rtsp, srt, webrtc 推流， 支持 rtmp, http-flv, ws-flv, hls(m3u8), dash, rtsp, srt, webrtc 拉流，支持 p2p 消息处理，支持 group 消息处理
smart rtmpd
05-22
Smart RTMPD支持RTMP协议，意味着它可以处理这些实时数据流，为用户提供低延迟的观看体验。 **RTSP (Real-Time Streaming Protocol)** RTSP是一种控制协议，用于管理和播放多媒体数据。它允许用户按需播放，可以...
smart_rtmpd.zip
04-01
《Smart_Rtmpd：强大的跨平台直播服务器详解》 在当今数字化时代，实时流媒体（RTMP）技术在音视频传播领域占据着重要的地位。Smart_Rtmpd是一款强大的跨平台直播服务器，它为内容创作者提供了高效、稳定的直播解决...
smart-rtmpd
12-19
5. 支持 web 开发接口 6. 支持集群，级联 支持的系统有： 1. Windows 2. Linux ( Ubuntu, CentOS ) 3. FreeBSD 4. ARM64 5.Embedded system 其中 Linux, FreeBSD 版本 支持多线程 ( multithread ) 和协程 ( ...
怎么使用 smart_rtmpd 的纯 webrtc 功能？
freeabc的专栏
08-19 2065
1. 为什么叫纯 webrtc ? 我们知道smart_rtmpd 的扩展版本叫 smart_webrtc ，已经支持 webrtc 功能；不过这里webrtc 的功能只是指的通过rtmp, rtsp, srt 协议进行推流，smart_webrtc 通过媒体层的转码把视频 video(h264 ---> vp8 ) 和音频 audio (aac ---> opus ) 实现的此功能，目前仅支持webrtc 方式的 H5 拉流。 这里的纯 webrtc 功能，就是单纯的 we...
smart_rtmpd 的 VOD 接口使用说明
freeabc的专栏
07-13 952
--------------------------------------------------------------------------------------------------------------------------------- 一分钟快速搭建 rtmpd 服务器: https://blog.csdn.net/freeabc/article/details/102880984 软件下载地址: http://www.qiyicc.com/download/rtmpd.zip
最高效的 rtmp & rtsp 服务器
04-27
期翼流服务器（ smart_rtmpd ），是一款用于直播，录播性能卓越的服务器。如果您不理解，可以理解为和 nginx-rtmp, srs ，功能类似，但是性能比 nginx-rtmp 高很多，甚至比 srs 还要高的直播（录播）服务器，特点是跨平台，无任何依赖，性能卓越，部署和维护十分方便，解压既能运行
悄摸直播（三）—— 搭建rtmp服务器（smart_rtmpd - rtmp服务器搭建）
weixin_44217612的博客
12-24 5616
搭建rtmp服务器 一、素材 rtmp服务器：smart_rtmpd ffmpeg工具：ffmpeg.exe 二、搭建 1.下载smart_rtmpd软件包，解压rtmpd.rar，进一步解压smart_rtmpd_win.rar得到smart_rtmpd.exe文件 2.运行smart_rtmpd.exe文件，直接启动。（如果对rtmp服务器有特殊配置需求，可以在smart_rtmpd.exe...
smart_rtmpd rtmp、rtsp 服务器
az44yao的专栏
10-08 870
smart_rtmpd 是一款 rtmp、rtsp 服务器，非常好用，解压既运行，支持跨平台，无任何依赖，性能和SRS 相比不分上下。支持级联和 url rewrite 以及 CDN 分发。 问：期翼流服务器名字叫什么？ 答：smart_rtmpd 问：smart_rtmpd 下载地址是？ 答：http://www.qiyicc.com/download/rtmpd.rar 问：smart_rtmpd 怎么使用？ 答：smart_rtmpd 无任何依赖，支持跨平台..
smart_rtmpd 轻松突破 C100K 测试
freeabc的专栏
07-17 2000
近日闲的无聊，对smart_rtmpd的网络模型进行一个简单的压力测试，轻轻松松突破C100K。
怎么给 smart_rtmpd 进行推流？
freeabc的专栏
07-10 2678
1. ffmpeg 2. obs
smart rtmpd 不能输出flv_“SMART原则”帮你顺利走出“假装努力”的怪圈
weixin_39887531的博客
12-08 94
阅读前请点击“关注”，一起成长遇见更好的自己~作者|静等花开 编辑|欣欣01你是不是陷入了这样的怪圈：在朋友圈，看到别人每天健身打卡，练瑜伽，举杠铃，做俯卧撑，一段时间后秀出肌肉、马甲线，保持好身材，气质提升了几个段位，然后你也开始活动筋骨，奈何运动计划总是被加班、聚餐、躺尸等等搁浅，索性放弃了。在朋友圈，看到别人每天英语打卡百词斩、流利说、可可英语，后来中英文切换自如，要么开启英语副业之旅，要么...
smart_rtmpd 的后台管理
freeabc的专栏
06-12 514
创建根目录 smart_rtmpd， 里面包含两个目录 bin, web. bin 就是 smart_rtmpd 服务器程序目录，web 就是 web 管理后台的目录.web 管理后台的整体说明，主要是 web 的一些使用方法，方便后续布署，主要是以 windows 系统为例，Linux 系统大部分都是雷同的，自行编译。web 里面的文件引用路径都需要改成 path 的 join 的形式，比如文件 config.json 的路径就是。web : 就是 web 网页编译后的运行文件所在的目录。
smart_rtmpd 并发
08-09
smart_rtmpd 是一个开源的实时媒体传输协议（RTMP）服务器程序，它具有高效并发的特性。 首先，smart_rtmpd 使用异步的事件驱动模型来处理并发连接。它采用了非阻塞的 I/O 操作，当一个新的客户端连接到服务器时，它会将连接加入到事件循环中，并立即返回处理其他连接。这种模型可以让服务器高效地处理大量并发连接，而无需为每个连接都分配一个线程。 其次，smart_rtmpd 还采用了连接池的策略来管理并发连接。连接池允许服务器在初始化时创建一定数量的连接，并将其保存在池中。当一个新的连接请求到来时，服务器会从连接池中获取一个可用的连接，并重用它来处理新的请求。这种方式可以避免频繁创建和销毁连接的开销，提高并发处理的效率。 此外，smart_rtmpd 还支持多线程处理并发请求。它可以通过配置多个工作线程来处理连接的读写操作，从而提高并发性能。每个工作线程都可以处理多个连接，与其他工作线程并行地处理请求，从而充分利用多核 CPU 的优势。 总的来说，smart_rtmpd 通过采用异步事件驱动模型、连接池和多线程处理等技术，实现了高效并发的能力。这使得它成为一个可靠的选择，用于实时媒体传输场景下需要处理大量连接的服务器环境。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值