# ZLMediaKit.HttpApi

**Repository Path**: cxs1992/ZLMediaKit.HttpApi

## Basic Information

- **Project Name**: ZLMediaKit.HttpApi
- **Description**: 基于NetCore 的ZLMediaKit Http Api 客户端
- **Primary Language**: C#
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 5
- **Forks**: 0
- **Created**: 2020-08-31
- **Last Updated**: 2024-04-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ZLMediaKit.HttpApi
基于优秀的开源项目 [ZLMediaKit](http://https://github.com/xia-chu/ZLMediaKit) 提供的[Restful Api](https://github.com/xia-chu/ZLMediaKit/wiki/MediaServer%E6%94%AF%E6%8C%81%E7%9A%84HTTP-API) 实现数据请求

## 实现功能
- [x] 封装 ZLMediaKit的Restful Api接口，提供快捷访问 
- [x] 支持配置多个MediaKit
- [x] 支持动态添加 MediaKit (比如通过Web Hook动态注册)

## 快速开始

1. 注入服务
```C#
    services.AddZLMediaKitHttpClient(option =>
    {
        //ZLMediaKit IP地址
        option.IpAddress = "127.0.0.1";
        //ZLMediaKit Http 端口
        option.ApiPort = 80;
        //ZLMediaKit 密钥
        option.ApiSecret = "035c73f7-bb6b-4889-a715-d9eb2d1925cc";
    });

    //  -------------------------------------------------------------------------------------
	//通过Web Hook 动态注册
    private void ZLMediaKitWebHookEvents_OnServerStarted(Dtos.ServerConfig obj)
    {
        ZLHttpClientRegister.Register(new ZLMediaKitSettings
        {
            ApiPort = obj.Http.Port,
            ApiSecret = obj.Api.Secret,
            HttpSchema = HttpSchema.http,
            IpAddress = obj.ServerIp.ToString(),
            MediaServerId = obj.General.MediaServerId
        });
    }
```
2. 使用
```C#
    public class Test
    {
        private readonly ZLHttpClient _zlhttpClient;
        public Test(ZLHttpClient zlhttpClient)
        {
            this._zlhttpClient = zlhttpClient
        }
		//如果您只有一个MediaKit交互，请直接使用此处的方式
        public CallTest()
        {
            _zlhttpClient.GetThreadsLoad();
            _zlhttpClient.GetWorkThreadsLoad();
            _zlhttpClient.GetServerConfig();
            _zlhttpClient.SetServerConfig();
            _zlhttpClient.RestartServer();
            _zlhttpClient.GetMediaList();
           .
           .
           .
        }
        
        //多个MediaKit 调用方式
        //就算您只有一个 MediaKit交互，也可以使用此方法，（但是在服务注册时必须填写 mediaServerId）
        public CallTest1()
        {
            _zlhttpClient.SetMediaServerId("ZLMediaKit配置文件中的，mediaServerId").GetThreadsLoad();
            _zlhttpClient.SetMediaServerId("ZLMediaKit配置文件中的，mediaServerId").GetWorkThreadsLoad();
            _zlhttpClient.SetMediaServerId("ZLMediaKit配置文件中的，mediaServerId").GetServerConfig();
            _zlhttpClient.SetMediaServerId("ZLMediaKit配置文件中的，mediaServerId").SetServerConfig();
            _zlhttpClient.SetMediaServerId("ZLMediaKit配置文件中的，mediaServerId").RestartServer();
            _zlhttpClient.SetMediaServerId("ZLMediaKit配置文件中的，mediaServerId").GetMediaList();
           .
           .
           .
        }

    }
```

---

# ZLMediaKit.WebHook
基于优秀的开源项目 [ZLMediaKit](http://https://github.com/xia-chu/ZLMediaKit) 提供的 [Web Hook](https://github.com/xia-chu/ZLMediaKit/wiki/MediaServer%E6%94%AF%E6%8C%81%E7%9A%84HTTP-HOOK-API)实现接收请求

## 实现功能
- [x] 接入 ZLMediaKit WebHook
- [x] 自定义路由路径
- [x] 以事件的形式访问

## 快速开始
1. 注入服务
```C#
    //routePrefix 参数设定路由前缀
    //实际接口路径为 routePrefix/action
    //ps : index/hook/on_flow_report
    //routePrefix = app/index/api/test
    //ps : app/index/api/test/on_flow_report
    services.AddMediaKitWebHook(new APIRouteOptions(routePrefix : "index/hook"); 
```
2. 绑定事件
```
   ZLMediaKitWebHookEvents.OnFlowReport += ZLMediaKitWebHookEvents_OnFlowReport;
   ZLMediaKitWebHookEvents.OnHttpAccess += ZLMediaKitWebHookEvents_OnHttpAccess;
   ZLMediaKitWebHookEvents.OnPlay += ZLMediaKitWebHookEvents_OnPlay;
   ZLMediaKitWebHookEvents.OnPublish += ZLMediaKitWebHookEvents_OnPublish;
   ZLMediaKitWebHookEvents.OnRecordMP4 += ZLMediaKitWebHookEvents_OnRecordMP4;
   ZLMediaKitWebHookEvents.OnRtspAuth += ZLMediaKitWebHookEvents_OnRtspAuth;
   ZLMediaKitWebHookEvents.OnRtspRealm += ZLMediaKitWebHookEvents_OnRtspRealm;
   ZLMediaKitWebHookEvents.OnServerStarted += ZLMediaKitWebHookEvents_OnServerStarted;
   ZLMediaKitWebHookEvents.OnShellLogin += ZLMediaKitWebHookEvents_OnShellLogin;
   ZLMediaKitWebHookEvents.OnStreamChanged += ZLMediaKitWebHookEvents_OnStreamChanged;
   ZLMediaKitWebHookEvents.OnStreamNoneReader += LMediaKitWebHookEvents_OnStreamNoneReader;
   ZLMediaKitWebHookEvents.OnStreamNotFound += LMediaKitWebHookEvents_OnStreamNotFound;
```


# 致敬

一个优秀而强大的流媒体服务器 [ZLMediaKit](https://github.com/xia-chu/ZLMediaKit)