接口规范 应用相关接口

Posted 2020-10-21

3.application相关接口

• 3.1.查询application

用途
查询服务器上的应用（application）。

请求
appMgr/?request=get&token=abce
token 是在登录认证接口中获得的token值。后续接口描述中将省略对token参数的描述，但是要记住token参数是必须的。

响应

{
    "code":0,
    "data":{
            "count":2,
            "items":[{"app_name":"show3",
                        "allow_live":"on",
                        "allow_publish":"on",
                        "allow_play":"on"
                        },
                        {"app_name":"show4",
                        "allow_live":"on",
                        "allow_publish":"on",
                        "allow_play":"on"}
                        ]}
}

返回一个或多个应用的信息。
app_name 应用名
allow_live 是否允许直播业务，on表示允许，off或省略不允许
allow_publish 是否允许推送直播流到该应用，on表示允许，off或省略不允许
allow_play 是否允许播出视频，on表示允许，off或省略不允许

---

• 3.2.查询应用的DVR配置
  用途
  查询应用的DVR配置参数。
  流媒体服务器的DVR功能可以将直播流在服务器上进行录制保存，DVR配置参数定义了保存的行为。
  系统有全局DVR配置参数，默认情况下会对每个应用生效。
  如果一个应用（application）没有DVR配置参数，则会使用全局配置参数。
  如果对一个应用配置了部分DVR参数，没有配置的参数依然会使用全局配置参数。
  请求
  appMgr/?request=get_dvr_paras&application=
  application 应用名，如果没有指定应用名，则会查询全局配置参数。
  响应

{
    "code":0,
    "data":{
        "count":1,
        "items":[
            {
                "is_dvr":"on",
                "dvr_method":"METHOD_A",
                "version_it":"on",
                "media_root":"/var/www/media",
                "keep_time":"0",
                "analyze_duration":"15",
                "segment_duration":"10",
                "chunk_type":"h",
                "chunk_size":"1",
                "chunk_ts":"off",
                "formats":"flv;hls",
                "probe_time":"20",
                "tv_streams":"tv",
                "application":"__Default"
            }
        ]
    }
}

返回应用的配置参数，items数组包含一个元素。
配置参数：
is_dvr on 表示DVR开启，off表示关闭。
media_root 归档数据保存的根路径
formats 归档的格式，多种格式用半角分号分开。flv 保存flv格式；hls保存hls切片格式；mp4保存mp4格式。
tv_streams 按照电视流格式归档的流名称，多个名称用半角分号分开。
application 应用名，"Default" 表示使用的是全局配置。

---

• 3.3.开启DVR功能
  用途
  开启DVR功能。
  系统暂不支持针对某个应用开启和关闭DVR功能，也不支持针对某个应用配置其他DVR参数。DVR的开启、关闭和修改配置参数会对所有应用生效。
  请求
  appMgr/?request=open_dvr
  响应

  {
  "code":0
  }

---

• 3.4.关闭DVR功能
  用途
  关闭DVR功能。
  请求
  appMgr/?request=close_dvr
  响应

  {
  "code":0
  }

---

• 3.5.设置DVR保存格式
  用途
  设置DVR保存格式，可以设置直播流在流媒体服务器上以一种或多种格式保存。
  请求
  appMgr/?request=set_dvr_format&formats=flv;hls;mp4
  format 设置的归档格式，多种格式用半角分号分开。flv 保存flv格式；hls保存hls切片格式；mp4保存mp4格式。
  响应

  {
  "code":0
  }