1 /* 2 * Copyright (c) 2016 The ZLMediaKit project authors. All Rights Reserved. 3 * 4 * This file is part of ZLMediaKit(https://github.com/xia-chu/ZLMediaKit). 5 * 6 * Use of this source code is governed by MIT license that can be found in the 7 * LICENSE file in the root of the source tree. All contributing project authors 8 * may be found in the AUTHORS file in the root of the source tree. 9 */ 10 11 #ifndef MK_EVENTS_H 12 #define MK_EVENTS_H 13 14 #include "mk_common.h" 15 #include "mk_events_objects.h" 16 17 #ifdef __cplusplus 18 extern "C" { 19 #endif 20 21 typedef struct { 22 /** 23 * 注册或反注册MediaSource事件广播 24 * @param regist 注册为1，注销为0 25 * @param sender 该MediaSource对象 26 */ 27 void (API_CALL *on_mk_media_changed)(int regist, 28 const mk_media_source sender); 29 30 /** 31 * 收到rtsp/rtmp推流事件广播，通过该事件控制推流鉴权 32 * @see mk_publish_auth_invoker_do 33 * @param url_info 推流url相关信息 34 * @param invoker 执行invoker返回鉴权结果 35 * @param sender 该tcp客户端相关信息 36 */ 37 void (API_CALL *on_mk_media_publish)(const mk_media_info url_info, 38 const mk_publish_auth_invoker invoker, 39 const mk_sock_info sender); 40 41 /** 42 * 播放rtsp/rtmp/http-flv/hls事件广播，通过该事件控制播放鉴权 43 * @see mk_auth_invoker_do 44 * @param url_info 播放url相关信息 45 * @param invoker 执行invoker返回鉴权结果 46 * @param sender 播放客户端相关信息 47 */ 48 void (API_CALL *on_mk_media_play)(const mk_media_info url_info, 49 const mk_auth_invoker invoker, 50 const mk_sock_info sender); 51 52 /** 53 * 未找到流后会广播该事件，请在监听该事件后去拉流或其他方式产生流，这样就能按需拉流了 54 * @param url_info 播放url相关信息 55 * @param sender 播放客户端相关信息 56 * @return 1 直接关闭 57 * 0 等待流注册 58 */ 59 int (API_CALL *on_mk_media_not_found)(const mk_media_info url_info, 60 const mk_sock_info sender); 61 62 /** 63 * 某个流无人消费时触发，目的为了实现无人观看时主动断开拉流等业务逻辑 64 * @param sender 该MediaSource对象 65 */ 66 void (API_CALL *on_mk_media_no_reader)(const mk_media_source sender); 67 68 /** 69 * 收到http api请求广播(包括GET/POST) 70 * @param parser http请求内容对象 71 * @param invoker 执行该invoker返回http回复 72 * @param consumed 置1则说明我们要处理该事件 73 * @param sender http客户端相关信息 74 */ 75 void (API_CALL *on_mk_http_request)(const mk_parser parser, 76 const mk_http_response_invoker invoker, 77 int *consumed, 78 const mk_sock_info sender); 79 80 /** 81 * 在http文件服务器中,收到http访问文件或目录的广播,通过该事件控制访问http目录的权限 82 * @param parser http请求内容对象 83 * @param path 文件绝对路径 84 * @param is_dir path是否为文件夹 85 * @param invoker 执行invoker返回本次访问文件的结果 86 * @param sender http客户端相关信息 87 */ 88 void (API_CALL *on_mk_http_access)(const mk_parser parser, 89 const char *path, 90 int is_dir, 91 const mk_http_access_path_invoker invoker, 92 const mk_sock_info sender); 93 94 /** 95 * 在http文件服务器中,收到http访问文件或目录前的广播,通过该事件可以控制http url到文件路径的映射 96 * 在该事件中通过自行覆盖path参数，可以做到譬如根据虚拟主机或者app选择不同http根目录的目的 97 * @param parser http请求内容对象 98 * @param path 文件绝对路径,覆盖之可以重定向到其他文件 99 * @param sender http客户端相关信息 100 */ 101 void (API_CALL *on_mk_http_before_access)(const mk_parser parser, 102 char *path, 103 const mk_sock_info sender); 104 105 /** 106 * 该rtsp流是否需要认证？是的话调用invoker并传入realm,否则传入空的realm 107 * @param url_info 请求rtsp url相关信息 108 * @param invoker 执行invoker返回是否需要rtsp专属认证 109 * @param sender rtsp客户端相关信息 110 */ 111 void (API_CALL *on_mk_rtsp_get_realm)(const mk_media_info url_info, 112 const mk_rtsp_get_realm_invoker invoker, 113 const mk_sock_info sender); 114 115 /** 116 * 请求认证用户密码事件，user_name为用户名，must_no_encrypt如果为true，则必须提供明文密码(因为此时是base64认证方式),否则会导致认证失败 117 * 获取到密码后请调用invoker并输入对应类型的密码和密码类型，invoker执行时会匹配密码 118 * @param url_info 请求rtsp url相关信息 119 * @param realm rtsp认证realm 120 * @param user_name rtsp认证用户名 121 * @param must_no_encrypt 如果为true，则必须提供明文密码(因为此时是base64认证方式),否则会导致认证失败 122 * @param invoker 执行invoker返回rtsp专属认证的密码 123 * @param sender rtsp客户端信息 124 */ 125 void (API_CALL *on_mk_rtsp_auth)(const mk_media_info url_info, 126 const char *realm, 127 const char *user_name, 128 int must_no_encrypt, 129 const mk_rtsp_auth_invoker invoker, 130 const mk_sock_info sender); 131 132 /** 133 * 录制mp4分片文件成功后广播 134 */ 135 void (API_CALL *on_mk_record_mp4)(const mk_mp4_info mp4); 136 137 /** 138 * shell登录鉴权 139 */ 140 void (API_CALL *on_mk_shell_login)(const char *user_name, 141 const char *passwd, 142 const mk_auth_invoker invoker, 143 const mk_sock_info sender); 144 145 /** 146 * 停止rtsp/rtmp/http-flv会话后流量汇报事件广播 147 * @param url_info 播放url相关信息 148 * @param total_bytes 耗费上下行总流量，单位字节数 149 * @param total_seconds 本次tcp会话时长，单位秒 150 * @param is_player 客户端是否为播放器 151 */ 152 void (API_CALL *on_mk_flow_report)(const mk_media_info url_info, 153 size_t total_bytes, 154 size_t total_seconds, 155 int is_player, 156 const mk_sock_info sender); 157 158 159 /** 160 * 日志输出广播 161 * @param level 日志级别 162 * @param file 源文件名 163 * @param line 源文件行 164 * @param function 源文件函数名 165 * @param message 日志内容 166 */ 167 void (API_CALL *on_mk_log)(int level, const char *file, int line, const char *function, const char *message); 168 169 } mk_events; 170 171 172 /** 173 * 监听ZLMediaKit里面的事件 174 * @param events 各个事件的结构体,这个对象在内部会再拷贝一次，可以设置为null以便取消监听 175 */ 176 API_EXPORT void API_CALL mk_events_listen(const mk_events *events); 177 178 179 #ifdef __cplusplus 180 } 181 #endif 182 #endif //MK_EVENTS_H 183