Skip to content

WebApi接口说明

Jump to bottom
chatop2020 edited this page Nov 27, 2020 · 1 revision

接口功能

  • StreamNode-GB28181项目是一个接口平台，采用WebApi接口形式提供功能
  • 由于平台接口功能的完善与修改可能与下面的说明并不完全一至，下面说明只做为基本参考，实际按Swagger调试文档为准。

DvrPlan 录制计划

  • /DvrPlan​/DeleteDvrPlanById 删除一个录制计划ById
  • ​/DvrPlan​/OnOrOffDvrPlanById 启用或停用一个录制计划
  • ​/DvrPlan​/SetDvrPlanById 修改录制计划ById
  • /DvrPlan​/CreateDvrPlan 创建录制计划
  • /DvrPlan​/GetDvrPlan 获取录制计划

MediaServer 流媒体控制

  • ​/MediaServer​/CutOrMergeVideoFile 添加一个裁剪合并任务
  • ​/MediaServer​/GetMergeTaskStatus 获取裁剪合并任务状态
  • /MediaServer​/GetBacklogTaskList 获取裁剪合并任务积压列表
  • /MediaServer​/UndoSoftDelete 恢复被软删除的录像文件
  • /MediaServer​/HardDeleteDvrVideoById 删除一个录像文件ById（硬删除，立即删除文件，数据库做delete标记）
  • /MediaServer​/HardDeleteDvrVideoByIdList 删除一批录像文件ById（硬删除，立即删除文件，数据库做delete标记）
  • /MediaServer​/SoftDeleteDvrVideoById 删除一个录像文件ById（软删除，只做标记，不删除文件，文件在24小时后删除）
  • /MediaServer​/GetDvrVideoById 根据id获取视频文件信息
  • /MediaServer​/GetDvrVideoList 获取录像文件列表
  • /MediaServer​/GetCameraInstanceListEx 扩展查询已注册摄像头列表
  • /MediaServer​/GetCameraInstanceList 获取摄像头实例列表
  • /MediaServer​/ModifyCameraInstance 修改一个注册摄像头实例
  • /MediaServer​/DeleteCameraInstance 删除一个摄像头实例
  • ​/MediaServer​/AddCameraInstance 注册添加一个摄像头实例
  • /MediaServer​/GetPlayerSessionList 获取在线播放器列表
  • /MediaServer​/GetCameraInstanceByCameraId 根据摄像头ID查询在线摄像头对象
  • /MediaServer​/GetCameraSessionList 获取在线摄像头列表
  • /MediaServer​/GetConfig 获取流媒体配置信息
  • /MediaServer​/AddFFmpegProxy 启动一个ffmpeg代理流
  • /MediaServer​/CloseStreams 关闭一个流
  • /MediaServer​/GetStreamList 获取流列表
  • /MediaServer​/StartRecord 启动流的录制
  • /MediaServer​/StopRecord 停止流的录制
  • /MediaServer​/GetRecordStatus 获取流的录制状态
  • /MediaServer​/OpenRtpPort 打开某个rtp端口
  • ​/MediaServer​/CloseRtpPort 关闭某个rtp端口
  • ​/MediaServer​/GetRtpPortList 获取流媒体已经开放的rtp端口列表
  • /MediaServer​/CheckMediaServerRunning 检查流媒体服务是否正在运行
  • /MediaServer​/RestartMediaServer 重启流媒体服务
  • /MediaServer​/StopMediaServer 关闭流媒体服务
  • /MediaServer​/StartMediaServer 启动流媒体服务
  • /MediaServer/ActivateSipCamera 对Sip网关自动写入的GB28181设备进行激活

Sip网关相关

  • /SipGate​/ActiveDeviceCatalogQuery 获取Sip设备的目录列表
  • /SipGate​/GetAutoPushStreamState 获取Sip网关自动推流状态
  • SipGate​/SetAutoPushStreamState 设置Sip网关自动推流状态
  • /SipGate​/LiveVideo 请求实时视频
  • /SipGate​/ByeLiveVideo 停止实时视频预览
  • /SipGate​/GetSipDeviceList 获取已注册的设备列表
  • /SipGate​/PtzControl ptz控制

系统相关

  • /System​/GetGlobleSystemInfo 获取全局的系统信息
  • /System​/GetMediaServerInstance 获取一个流媒体服务的实例
  • ​/System​/GetMediaServerList 获取流媒体服务器列表

Test

  • 一些测试接口，可以无视

WebHook

  • 用于ZLMediaKit回调的一些接口，可以无视
Clone this wiki locally