目前仅商米AI识客摄像机支持该模块。
1. 设置进门拌线坐标
描述
进门拌线是IPC设备用来判断某个人是否已经进来的基础,因此对于人脸识别和客流统计,需要通过此接口来设置这个拌线的坐标。
接口
public void setDoorLine(String deviceId, int resolution, int start_x, int start_y, int end_x, int end_y, RpcCallback‹RpcResponse› callback);
参数说明
参数名称 | 描述 | 示例 |
deviceId | IPC序列号 | C201D98T00094 |
resolution | 只能取值0和1,0表示1080P的分辨率,1表示720P的分辨率,目前仅支持1080P分辨率 | 0 |
start_x | 拌线的左边端点X坐标,1080p范围0<=x<=1920,720p范围0<=x<=1280 | 500 |
start_y | 拌线的左边端点Y坐标,1080p范围0<=y<=1080,720p范围0<=y<=720 | 500 |
end_x | 拌线的右边端点X坐标,1080p范围0<=x<=1920,720p范围0<=x<=1280 | 500 |
end_y | 拌线的右边端点Y坐标,1080p范围0<=y<=1080,720p范围0<=y<=720 | 500 |
callback | 调用结果 |
响应参数
字段名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果; 本接口返回码有:0、1、2、3、5、7、277,278,见错误码的描述 |
2. 获取进门拌线坐标
描述
获取进门拌线的坐标信息。
接口
public void getDoorLine(String deviceId, RpcCallback‹RpcResponse‹DoorLineConfig›› callback);
参数说明
参数名称 | 描述 | 示例 |
deviceId | IPC序列号 | C201D98T00094 |
callback | 调用结果 |
响应参数
字段名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果; 本接口返回码有:0、1、2、3、5、7、260、261、262、263、264、276、277、279,见错误码的描述 |
data | DoorLineConfig | 返回码成功才会有此字段,详见RpcResponse.DoorLineConfig |
3. 获取指定时间内的到访人流统计信息
描述
获取指定某一时间内的人流统计信息,如果设备不存在这个时间内的信息则会返回错误。
接口
public void getComeInPeopleStat(String deviceId, long start_time, long end_time, int period, RpcCallback‹RpcResponse‹PeopleStatCollection›› callback);
参数说明
参数名称 | 描述 | 示例 |
deviceId | IPC序列号 | C201D98T00094 |
start_time | Unix格式时间戳,精确至秒,开始时间,时间是整小时或者整天或者半小时的时间戳,譬如2019-07-01,2019-07-01 10:00,或者 2019-07-01 10:30这样的时间对应的时间戳 | 1578969264 |
end_time | Unix格式时间戳,精确至秒,结束时间。时间要求同上 | 1579055640 |
period | 人流统计信息的粒度,分为30min、hour和day三种统计粒度,取值分别为1,2和3 | 2 |
callback | 调用结果 |
响应参数
字段名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果; 本接口返回码有:0、1、2、3、5、7、211、220、265、266、267、277、280,见错误码的描述 |
data | PeopleStatCollection | 返回码成功才会有此字段,详见RpcResponse.PeopleStatCollection |
4. 获取指定时间内的路过人流统计信息
描述
获取指定某一时间内的经过人流统计信息,如果设备不存在这个时间内的信息则会返回错误。
接口
public void getPassByPeopleStat(String deviceId, long start_time, long end_time, int period, RpcCallback‹RpcResponse‹PeopleStatCollection›› callback);
参数说明
参数名称 | 描述 | 示例 |
deviceId | IPC序列号 | C201D98T00094 |
start_time | Unix格式时间戳,精确至秒,开始时间,时间是整小时或者整天或者半小时的时间戳,譬如2019-07-01,2019-07-01 10:00,或者 2019-07-01 10:30这样的时间对应的时间戳 | 1578969264 |
end_time | Unix格式时间戳,精确至秒,结束时间。时间要求同上 | 1579055640 |
period | 人流统计信息的粒度,分为30min、hour和day三种统计粒度,取值分别为1,2和3 | 2 |
callback | 调用结果 |
响应参数
字段名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果; 本接口返回码有:0、1、2、3、5、7、211、220、265、266、267、277、280,见错误码的描述 |
data | PeopleStatCollection | 返回码成功才会有此字段,详见RpcResponse.PeopleStatCollection |
5. 获取指定时间内的离开人流统计信息
描述
获取指定某一时间内的人流统计信息,如果设备不存在这个时间内的信息则会返回错误。
接口
public void getGoOutPeopleStat(String deviceId, long start_time, long end_time, int period, RpcCallback‹RpcResponse‹PeopleStatCollection›› callback);
参数说明
参数名称 | 描述 | 示例 |
deviceId | IPC序列号 | C201D98T00094 |
start_time | Unix格式时间戳,精确至秒,开始时间,时间是整小时或者整天或者半小时的时间戳,譬如2019-07-01,2019-07-01 10:00,或者 2019-07-01 10:30这样的时间对应的时间戳 | 1578969264 |
end_time | Unix格式时间戳,精确至秒,结束时间。时间要求同上 | 1579055640 |
period | 人流统计信息的粒度,分为30min、hour和day三种统计粒度,取值分别为1,2和3 | 2 |
callback | 调用结果 |
响应参数
字段名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果; 本接口返回码有:0、1、2、3、5、7、211、220、265、266、267、277、280,见错误码的描述 |
data | PeopleStatCollection | 返回码成功才会有此字段,详见RpcResponse.PeopleStatCollection |
6. 获取指定时间内的到访列表
描述
获取指定时间内,来过次数排名前N的人脸ID列表信息。
接口
public void getVisitorList(String deviceId, Map‹String, String› options, RpcCallback‹RpcResponse‹VisitorCollection›› callback);
参数说明
参数名称 | 描述 | 示例 |
deviceId | IPC序列号 | C201D98T00094 |
options | 限定获取来访记录的参数,option说明中的所有参数都需要转换成String类型传入。 | 见下表options说明 |
callback | 调用结果 |
options说明
参数名称 | 类型 | 描述 | 是否必须 | 示例 |
start_time | long | Unix时间戳 | Y | 1578969264 |
end_time | long | Unix时间戳 | Y | 1579055640 |
order | int | 表示抵达次数排名前order的人脸信息 | Y | 50 |
group_name | string | 指定某个人脸分组,默认为所有人脸分组 | N | vip |
gender | int | 性别,1表示男性,2表示女性,默认不分性别 | N | 1 |
age_range | int | 年龄段,1表示1~6岁,2表示7~12岁,3表示13~18岁,4表示19~28岁, 5表示29~35岁,6表示36~45岁,7表示45~55岁,8表示55岁~100 | N | 4 |
age | int | 年龄,与上面age_range是或的关系,不是与的关系。即查询age_range或 者age满足的人脸,只要有一个符合即可。 | N | 4 |
item1 | string | 可以根据自定义属性来匹配,自定义属性1的匹配。如果需要使用自定义属 性查询,请确保指定的人脸分组添加过对应的自定义属性,否则查询失败(生 人与熟人分组不能添加自定义属性) | N | value1 |
item2 | string | 自定义属性2的匹配 | N | value2 |
item3 | string | 自定义属性3的匹配 | N | value3 |
item4 | string | 自定义属性4的匹配 | N | value4 |
item5 | string | 自定义属性5的匹配 | N | value5 |
page_num | int | 当前页码,默认值和最小值为1 | N | 1 |
page_size | int | 当前页面条目数,默认为10,范围为[1, 100] | N | 10 |
响应参数
参数名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果; 本接口返回码有:0、1、2、3、5、7、211、220、265、266、267、277、280,见错误码的描述 |
data | VisitorCollection | 返回码成功才会有此字段,详见RpcResponse.VisitorCollection |
7. 获取指定人脸的到访记录
描述
查询指定某个人在指定时间内的到访记录。
接口
public void getFaceVisitDetail(String deviceId, long start_time, long end_time, String faceId, RpcCallback‹RpcResponse‹VisitDetails›› callback);
参数说明
参数名称 | 描述 | 示例 |
deviceId | IPC序列号 | C201D98T00094 |
start_time | Unix时间戳,开始时间 | 1578969264 |
end_time | Unix时间戳,结束时间 | 1579055640 |
faceId | 人脸ID | 000001 |
callback | 调用结果 |
响应参数
字段名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果; 本接口返回码有:0、1、2、3、5、7、211、220、265、266、267、277、280,见错误码的描述 |
data | VisitDetails | 返回码成功才会有此字段,详见RpcResponse.VisitDetails |