5. Android PPVIEW SDK接口说明

5.1. 概述

本节主要用于详细描述ANDROID PPVIEW SDK各接口的作用、参数、返回值。如何使用这些接口来开发客户端,请参见Android客户端开发指南

在本文档中没有描述的接口和类,是已废弃或内部保留接口,开发者不必关心。

5.2. 基本数据结构类

5.2.1. item_alarm_cfg(设备端安防配置信息类)

所属包:vv.tool.gsonclass

public class item_alarm_cfg extends java.lang.Object
  • 构造器
public item_alarm_cfg() 
  • 字段
字段 类型 描述
time_arm_enabled int 配置是否生效,1=是,0=否
timing_arm String 一周内各天是否开启录像,从周日开始每天用0或1表示关闭和开启,组成共七个字节的字符串,如周一至周五开启,周未不开启,用字符串”0111110“表示
sun String 周日的布防时段,如00:00-12:00;14:00-24:00,多个时间段用;分隔,下同,不在时间段内的时间,表示撤防。允许跨天,如23:00~01:00表示周日的23:00到周一的01:00布防。跨天时,timing_arm中的开关以前一天的开关为准。
mon String 周一的布防时间段
tue String 周二的布防时间段
wed String 周三的布防时间段
thu String 周四的布防时间段
fri String 周五的布防时间段
sat String 周六的布防时间段
motion_enabled int 是否触发移动侦测报警,0=否,1=是,默认1
alert_sound int 事件触发时,是否播放报警音,0=否,1=是(注:存在即使开启这个开关时仍不会播放报警音的情况,需要看设备端的具体情况而定)
arm_snap int 布防状态下触发事件时的抓图张数,默认3
disarm_snap int 撤防状态下触发事件时的抓图张数,默认0
alert_time int 同一事件两次触发最短时间间隔(单位秒),同时也是报警录像时长,默认60秒
alert_act int 报警联动方式,0=无,1=上下巡航,2=左右巡航,3=预置点巡航,4=转动到预置位,默认0
preset int 当alert_act=4时的预置位

注:当timing_arm中的某一天定时布撤防处于关闭状态时,后面表示时间段的信息无意义,但仍会被保存在设备端,以便下次需要打开该天的定时布撤防开关时,可以不需要重新设置时间段。

5.2.2. item_cams(摄像头信息类)

所属包:vv.tool.gsonclass

public class item_cams extends java.lang.Object
  • 构造器
public item_cams()
  • 字段
字段 类型 描述
cam_id String 摄像头编号
dev_id String 设备编号

5.2.3. item_sharelist(共享摄像头信息类)

所属包:vv.tool.gsonclass

public class item_sharelist extends java.lang.Object
  • 构造器
public item_sharelist()
  • 字段
字段 类型 描述
cam_id String 摄像头编号
dev_id String 设备编号
chl_id int 通道号

5.2.4. user(用户信息类)

所属包:vv.tool.gsonclass

public class user extends java.lang.Object
  • 构造器
public user()
  • 字段
字段 类型 描述
group_id String 添加在用户的哪个分组下,空表示根分组
user String 摄像头被分享的用户名

5.2.5. item_netif(网卡配置信息类)

所属包:vv.tool.gsonclass

public class item_netif
extends java.lang.Object
implements java.io.Serializable
  • 构造器
public item_netif() 
  • 字段
字段 类型 描述
token String 网卡名称
net_type int 网络类型:1=有线静态ip, 2=有线DHCP, 3=无线静态ip, 4=无线DHCP
ip String ip地址, DHCP或不需要修改时不要
mask String 子网掩码,DHCP或不需要修改时不要
gate String 网关,DHCP或不需要修改时不要
dns1 String 主dns地址,DHCP或不需要修改不要
dns2 String 辅dns地址,DHCP或不需要修改不要
ssid String wifi的ssid,有线时不要
secu_psk_pass String wifi密码, 有线时不要

5.2.6. c2d_rec_schedules(录像配置类)

所属包:vv.tool.gsonclass

public class c2d_rec_schedules
extends java.lang.Object
  • 构造器
public c2d_rec_schedules()
  • 字段
字段 类型 描述
timing_schedule item_rec_schedule 定时录像计划配置信息
alert_schedule item_rec_schedule 报警录像计划配置信息,已废弃

5.2.7. item_rec_schedule(定时录像配置类)

所属包:vv.tool.gsonclass

public class item_rec_schedule
extends java.lang.Object
  • 构造器
public item_rec_schedule()
  • 字段
字段 类型 描述
enabled int 是否开启定时录像,0=否,1=是
day_of_week_enabled String 字符串,7个字节,分别表示一周内7天(从星期日开始)是否生效,1=生效,0=无效
sun String 周日的定时录像时间段,如00:00-12:00;14:00-24:00,多个时间段用;分隔"
mon String 周一的定时录像时间段,如00:00-12:00;14:00-24:00,多个时间段用;分隔"
tue String 周二的定时录像时间段,如00:00-12:00;14:00-24:00,多个时间段用;分隔"
wed String 周三的定时录像时间段,如00:00-12:00;14:00-24:00,多个时间段用;分隔"
thu String 周四的定时录像时间段,如00:00-12:00;14:00-24:00,多个时间段用;分隔"
fri String 周五的定时录像时间段,如00:00-12:00;14:00-24:00,多个时间段用;分隔"
sat String 周六的定时录像时间段,如00:00-12:00;14:00-24:00,多个时间段用;分隔"

5.2.8. item_alarm_cfg(安防配置信息类)

所属包:vv.tool.gsonclass

public class item_alarm_cfg
extends java.lang.Object
  • 构造器
public item_alarm_cfg()
  • 字段
字段 类型 描述
timing_arm_enabled int 配置是否生效,0=否,1=是
timing_arm String 字符串,7个字节,分别表示周日至周六是否开启定时布撤防,1=开启,0=关闭
sun String 周日的定时布撤防时间段,如00:00-12:00;14:00-24:00,多个时间段用;分隔"
mon String 周一的定时布撤防时间段,如00:00-12:00;14:00-24:00,多个时间段用;分隔"
tue String 周二的定时布撤防时间段,如00:00-12:00;14:00-24:00,多个时间段用;分隔"
wed String 周三的定时布撤防时间段,如00:00-12:00;14:00-24:00,多个时间段用;分隔"
thu String 周四的定时布撤防时间段,如00:00-12:00;14:00-24:00,多个时间段用;分隔"
fri String 周五的定时布撤防时间段,如00:00-12:00;14:00-24:00,多个时间段用;分隔"
sat String 周六的定时布撤防时间段,如00:00-12:00;14:00-24:00,多个时间段用;分隔"
arm_snap int 布防状态下报警抓图数量
disarm_snap int 撤防状态下报警抓图数量
alert_time int 报警持续时间(秒)
alert_act int 报警时联动动作,(0=无,1=上下巡航,2=左右巡航,3=预置点巡航,4=转动到预置点)
preset int 报警联动时,转到到哪个预置点,仅在alert_act==4时有效
is_push int 是否推送,1=推送 0=不推送
motion_enabled int 是否开启移动侦测,1=开启 0=关闭
alert_sound int 报警时设备是否播放报警音,0、1=是,2=否(注:存在即使开启这个开关时仍不会播放报警音的情况,需要看设备端的具体情况而定),开启播放报警音同时取值0和1是为了兼容老型号,可任选一个值

5.2.9. item_relations(关系[好友或黑名单]信息类)

所属包:vv.tool.gsonclass

public class item_relations
extends java.lang.Object
implements java.io.Serializable
  • 构造器
public item_relations()
  • 字段
字段 类型 描述
user String 对方的账号
status int 关系类型,0=待审核好友申请 1=好友 2=黑名单
memo String 备注

5.2.10. item_share_reqs(分享请求信息类)

所属包:vv.tool.gsonclass

public class item_share_reqs
extends java.lang.Object
  • 构造器
public item_share_reqs()
  • 字段
字段 类型 描述
from_user String 请求者的用户名
from_nick String 请求者的昵称
cam_id String 请求的摄像头ID
cam_name String 请求的摄像头名称
memo String 备注
reqid String 请求ID

5.2.11. item_firmware_info(设备固件信息类)

所属包:vv.tool.gsonclass

public class item_firmware_info
extends java.lang.Object
implements java.io.Serializable
  • 构造器
public item_firmware_info()
  • 字段
字段 类型 描述
dev_id String 设备ID
model String 设备型号
firmware_ver String 当前固件版本
new_firmware_ver String 最新固件版本
firmware_url String 最新固件文件下载地址
firmware_hash String 最新固件文件md5校验值

5.2.12. c2d_netif_info(网卡信息列表类)

所属包:vv.tool.gsonclass

public class c2d_netif_info
extends java.lang.Object
implements java.io.Serializable
  • 构造器
public c2d_netif_info()
  • 字段
字段 类型 描述
netifs java.util.ArrayList 多个网卡信息的数组,参见item_netif

5.2.13. item_wifi(wifi列表类)

所属包:vv.tool.gsonclass

public class item_wifi
extends java.lang.Object

  • 构造器
public item_wifi()
  • 字段
字段 类型 描述
wifi_list java.util.ArrayList 多个wifi信息组成的数组,元素参见item_wifi_info

5.2.14. item_wifi_info(wifi信息类)

所属包:vv.tool.gsonclass

public class item_wifi_info
extends java.lang.Object

  • 构造器
public item_wifi_info()
  • 字段
字段 类型 描述
ssid String WIFI的SSID
is_conn int 是否是当前已连接的WIFI,1=是 0=否
is_secu int 是否加密,1=是 0=否
signel int 信号强度,1~100

5.2.15. item_sdcard_info(SD卡信息类)

所属包:vv.tool.gsonclass

public class item_sdcard_info
extends java.lang.Object
  • 构造器
public item_sdcard_info()
  • 字段
字段 类型 描述
status int SD卡状态,(0=未格式化 1=正常 2=出错)
total_space int MByte,总空间大小
free_space int MByte,空闲空间大小

5.2.16. FishEyeInfo(鱼眼摄像头参数信息)

所属包:vv.playlib

public class FishEyeInfo
extends java.lang.Object
implements java.io.Serializable
  • 构造器
public FishEyeInfo()
  • 字段
字段 类型 描述
fishType int 鱼眼摄像机类型,1=180度壁装 2=360度顶装
main_x1_offsize float 主码流的左偏移
main_x2_offsize float 主码流的右偏移
main_y1_offsize float 主码流的上偏移
main_y2_offsize float 主码流的下偏移
sub_x1_offsize float 子码流的左偏移
sub_x2_offsize float 子码流的右偏移
sub_y1_offsize float 子码流的上偏移
sub_y2_offsize float 子码流的下偏移

5.2.17. CCommonParams(二进制数据信息)

所属包:vv.android.params

public class CCommonParams
extends java.lang.Object
  • 构造器
public CCommonParams()
  • 字段
字段 类型 描述
data byte[] 二进制数据缓存
len int 数据长度,字节数

5.2.18. EventListItem(事件信息类)

所属包:vv.tool.gsonclass

public class EventListItem
extends java.lang.Object
  • 构造器
public EventListItem()
  • 字段
字段 类型 描述
event_id String 事件ID
time long 事件时间戳(UTC时间)
event_type int 事件类型,参见事件类型表
readed boolean 是否已读 false未读 true已读
cam_id String 事件所发生的摄像头ID
cam_name String 事件所发生的摄像头名称
event_pic_id String 事件图片缩略图id(用于获取缩略图)
title String 事件标题
memo String 事件摘要
sensor_id String 触发事件的传感器ID
sensor_name String 触发事件的传感器名称
sensor_status String 触发事件的传感器状态0-关 1-开
sensor_info String 传感器附加信息
event_important int 触发的是否为紧急事件 0否 1是,紧急事件时,不管是否布防,建议都播放报警音
rec_duration int 报警录像时长


事件类型表:

event_type 说明
1 通知消息
10001 移动侦测
10002 人体红外感应
10003 视频遮挡
10004 烟感报警
10005 煤气泄漏
10006 门磁报警
10007 紧急呼救
10008 玻璃破碎
10009 输入线路报警
10010 浸水报警
10011 外部供电中断报警
10012 外部供电恢复报警
10013 视频输入中断报警
10014 设备有异常
10015 视频丢失
10016 硬盘错误
10017 无硬盘
10018 硬盘满
10019 低电压
10020 门铃
10021 震动传感器
10022 幕帘报警
10023 开关触发
10024 插座触发

5.2.19. item_sensorinfo(传感器信息)

所属包:vv.tool.gsonclass

public class item_sensorinfo
extends java.lang.Object
implements java.io.Serializable
  • 构造器
public item_sensorinfo()
  • 字段
字段 类型 描述
index int 传感器序号
chl_id int 对应的通道号(数字,-1表示没有对应关系)
name String 传感器名称
type int 传感器类型,参见传感器类型表
sensor_id string 传感器ID
preset int 对应的预置点位置(数字,0表示没有对应)
is_alarm int 是否报警(数字,0=否 1=是)
status int 传感器状态,0=关 1=开
low_power int 是否低电压,0=否,1=是
sub_chl_count int 子通道路数(数字,如开关控制器的路数,如没有,为0)
sub_chls java.util.ArrayList 子通道信息,参见item_sub_chls


传感器类型表:

数值 类型
0x01 门磁
0x02 红外
0x03 烟感
0x04 煤气
0x05 水浸
0x06 振动
0x07 遥控器
0x08 红外幕帘
0xF1 开关
0xF2 插座
0xF9 遥控窗帘

5.2.20. item_sub_chls(传感器子通道信息)

所属包:vv.tool.gsonclass

public class item_sub_chls
extends java.lang.Object
implements java.io.Serializable

记录传感器的子通道信息。某些传感器具有多个通道,称为子通道,如含有多个开关的传感器,每个开关就是一个子通道。

  • 构造器
public item_sub_chls()
  • 字段
字段 类型 描述
name String 子通道名称
status int 状态,0=关 1=开 2=停
alarm_linkage int 是否报警联动,0=否,1=是

5.3. vv.ppview.PpviewClientInterface(基本交互类)

所属包:vv.ppview

public class PpviewClientInterface extends java.lang.Object
  • 构造器
private PpviewClientInterface()

注:采用单件模式,使用时,调用静态函数getInstance()来得到类实例。

5.3.1. 基础接口

5.3.1.1. getInstance(得到类实例)

public static PpviewClientInterface getInstance()
  • 说明
    以单件模式得到基础交互类PpviewClientInterface的实例。

  • 返回
    类实例

5.3.1.2. SetAppInfo(配置应用信息)

public boolean SetAppInfo(java.lang.String svraddress,
                          java.lang.String appid,
                          java.lang.String pass,
                          java.lang.String boundaddress,
                          java.lang.String p2p_svr,
                          int p2p_port,
                          java.lang.String p2p_secret,
                          java.lang.String event_url)
  • 说明
    配置应用信息,初始时调用

  • 参数说明

  • 返回
    true = 成功
    false = 失败

5.3.2. 与平台服务器间的交互接口

5.3.2.1. c2s_get_sms_vcode_fun(获得短信验证码)

public int c2s_get_sms_vcode_fun(boolean ischeck, java.lang.String mobile)

5.3.2.2. c2s_get_email_vcode_fun(获得邮箱验证码)

public int c2s_get_email_vcode_fun(boolean ischeck, java.lang.String email)

5.3.2.3. c2s_user_regist_fun(用户注册)

public int c2s_user_regist_fun(java.lang.String user,
                               java.lang.String pass,
                               java.lang.String nick,
                               java.lang.String email,
                               java.lang.String mobile,
                               java.lang.String sess,
                               java.lang.String vcode)

5.3.2.4. c2s_user_resetpass_sms_fun(通过手机短信验证码重置密码)

public int c2s_user_resetpass_sms_fun(java.lang.String mobile,
                                      java.lang.String vcode,
                                      java.lang.String newpass)

5.3.2.5. c2s_user_resetpass_emailv2_fun(通过邮件重置密码)

public int c2s_user_resetpass_emailv2_fun(java.lang.String email)

5.3.2.6. c2s_login_fun(登录)

public int c2s_login_fun(java.lang.String user,
                         java.lang.String pass)

5.3.2.7. c2s_user_modify_nick_fun(修改用户昵称)

public int c2s_user_modify_nick_fun(java.lang.String user,
                                    java.lang.String pass,
                                    java.lang.String newnick)

5.3.2.8. c2s_get_dev_list_fun(获取设备列表)

public int c2s_get_dev_list_fun(java.lang.String user,
                                java.lang.String pass,
                                java.lang.Object usertag)

5.3.2.9. c2s_get_cam_list_fun(获得摄像头列表)

public int c2s_get_cam_list_fun(java.lang.String user,
                                java.lang.String pass)

5.3.2.10. c2s_get_cam_pic(获取摄像头缩略图)

public Bitmap c2s_get_cam_pic(java.lang.String user,
                              java.lang.String pass,
                              java.lang.String piccid)

5.3.2.11. c2s_delete_dev_fun(删除/解除绑定设备)

public int c2s_delete_dev_fun(java.lang.String user,
                              java.lang.String pass,
                              java.lang.String devid,
                              java.lang.Object usrtag)

5.3.2.12. c2s_share_DisableShareCam_fun(删除别人分享给自己的摄像头)

public int c2s_share_DisableShareCam_fun(java.lang.String user,
                                         java.lang.String pass,
                                         java.lang.String devid,
                                         java.lang.String camid)

5.3.2.13. c2s_set_cam_alert_status_fun(单摄像头布撤防)

public int c2s_set_cam_alert_status_fun(java.lang.String user,
                                        java.lang.String pass,
                                        java.lang.String devId,
                                        java.lang.String camId,
                                        int status)

5.3.2.14. c2s_set_cams_alert_status_fun(多摄像头布撤防)

public int c2s_set_cams_alert_status_fun(java.lang.String user,
                                         java.lang.String pass,
                                         java.util.ArrayList<item_cams> cams,
                                         int status)

5.3.2.15. c2s_get_unread_event_count(获取所有自己账号下的设备的未读事件数量)

public int c2s_get_unread_event_count(java.lang.String user, java.lang.String pass)

5.3.2.16. c2s_get_event_list(获取所有自己账号下的设备的事件列表)

public int c2s_get_event_list(java.lang.String user,
                              java.lang.String pass,
                              java.lang.String eventId,
                              int getCount)

5.3.2.17. c2s_get_cam_event_list(获取单个摄像头的事件列表)

public int c2s_get_cam_event_list(java.lang.String user,
                                  java.lang.String pass,
                                  java.lang.String camId,
                                  java.lang.String eventId,
                                  int getCount)

5.3.2.18. c2s_get_event_pic(获取事件缩略图)

public Bitmap c2s_get_event_pic(java.lang.String user,
                                java.lang.String pass,
                                java.lang.String eventid)

5.3.2.19. c2s_get_page_event_url(获取事件图片网址)

public java.lang.String c2s_get_page_event_url(java.lang.String eventid,
                                               java.lang.String user,
                                               java.lang.String pass)

5.3.2.20. c2s_set_all_events_readed(将所有事件设置为已读状态)

public int c2s_set_all_events_readed(java.lang.String user,
                                     java.lang.String pass)

5.3.2.21. c2s_get_camlist_sn_fun(获取摄像头列表流水号)

public int c2s_get_camlist_sn_fun(java.lang.String user,
                                  java.lang.String pass)

5.3.2.22. c2s_new_group_fun(添加分组)

public int c2s_new_group_fun(java.lang.String user,
                             java.lang.String pass,
                             short cur_sn,
                             java.lang.String groupname,
                             java.lang.String to_group,
                             java.lang.String usrtag)

5.3.2.23. c2s_rename_group_fun(修改分组名称)

public int c2s_rename_group_fun(java.lang.String user,
                                java.lang.String pass,
                                short cur_sn,
                                java.lang.String groupname,
                                java.lang.String groupid,
                                java.lang.String usertag)

5.3.2.24. c2s_move_group_fun(移动分组)

public int c2s_move_group_fun(java.lang.String user,
                              java.lang.String pass,
                              short cur_sn,
                              java.lang.String groupid,
                              java.lang.String to_groupid,
                              java.lang.String old_groupid,
                              java.lang.String usertag)

5.3.2.25. c2s_move_group_new_group_fun(移动分组到新建分组)

public int c2s_move_group_new_group_fun(java.lang.String user,
                                        java.lang.String pass,
                                        short cur_sn,
                                        java.lang.String new_group_name,
                                        java.lang.String new_group_parent,
                                        java.lang.String old_group_parent,
                                        java.lang.String move_group_id)

5.3.2.26. c2s_rename_cam_fun(修改摄像头名称)

public int c2s_rename_cam_fun(java.lang.String user,
                              java.lang.String pass,
                              short cur_sn,
                              java.lang.String camname,
                              java.lang.String camid,
                              java.lang.String usrtag)

5.3.2.27. c2s_move_cam_fun(移动摄像头)

public int c2s_move_cam_fun(java.lang.String user,
                            java.lang.String pass,
                            short cur_sn,
                            java.lang.String camid,
                            java.lang.String to_groupid,
                            java.lang.String usrtag,
                            int type)

5.3.2.28. c2s_move_cam_new_group_fun(移动摄像头到新分组)

public int c2s_move_cam_new_group_fun(java.lang.String user,
                                      java.lang.String pass,
                                      short cur_sn,
                                      java.lang.String new_group_name,
                                      java.lang.String new_group_parent,
                                      java.lang.String move_cam_id)

5.3.2.29. c2s_delete_group_fun(删除分组)

public int c2s_delete_group_fun(java.lang.String user,
                                java.lang.String pass,
                                short cur_sn,
                                java.lang.String groupid,
                                java.lang.String parid,
                                java.lang.String usrtag)

5.3.2.30. c2s_get_user_relations_fun(获取关系(好友和黑名单)列表)

public int c2s_get_user_relations_fun(java.lang.String user,
                                      java.lang.String pass)

5.3.2.31. c2s_add_user_relation_fun(添加关系(好友或黑名单))

public int c2s_add_user_relation_fun(java.lang.String user,
                                     java.lang.String pass,
                                     java.lang.String relation_user,
                                     int relation_type)

5.3.2.32. c2s_modify_user_relation_fun(修改关系(好友或黑名单))

public int c2s_modify_user_relation_fun(java.lang.String user,
                                        java.lang.String pass,
                                        java.lang.String relation_user,
                                        int relation_type,
                                        java.lang.String memo)

5.3.2.33. c2s_remove_user_relation_fun(删除关系(好友或黑名单))

public int c2s_remove_user_relation_fun(java.lang.String user,
                                        java.lang.String pass,
                                        java.lang.String relation_user)

5.3.2.34. c2s_share_reqDevShare_fun(请求别人将设备分享给自己)

public int c2s_share_reqDevShare_fun(java.lang.String user,
                                     java.lang.String pass,
                                     java.lang.String devid,
                                     java.lang.String memo)

5.3.2.35. c2s_share_getDevOwner_fun(获取设备的归属用户)

public int c2s_share_getDevOwner_fun(java.lang.String user,
                                     java.lang.String pass,
                                     java.lang.String devid)

5.3.2.36. c2s_share_ResponseCamShare_fun(响应其它用户的分享请求)

public int c2s_share_ResponseCamShare_fun(java.lang.String user,
                                          java.lang.String pass,
                                          java.lang.String req_id,
                                          int cmd)

5.3.2.37. c2s_share_getCamShareReqCount_fun(获取其它用户发来的分享请求条数)

public int c2s_share_getCamShareReqCount_fun(java.lang.String user,
                                             java.lang.String pass)

5.3.2.38. c2s_share_getRequestShareCamList_fun(获取其它用户发来的分享请求列表)

public int c2s_share_getRequestShareCamList_fun(java.lang.String user,
                                                java.lang.String pass)

5.3.2.39. c2s_share_getShareCamList_fun(获取分享给某用户的摄像头列表)

public int c2s_share_getShareCamList_fun(java.lang.String user,
                                         java.lang.String pass,
                                         java.lang.String relation_user)

5.3.2.40. c2s_share_setShareCamList_fun(设置新的分享给某用户的摄像头列表)

public int c2s_share_setShareCamList_fun(java.lang.String user,
                                         java.lang.String pass,
                                         java.lang.String relation_user,
                                         java.util.ArrayList<item_sharelist> sharelist)

5.3.2.41. c2s_share_getCamSharedUserList_fun(获取某摄像头的分享用户列表)

public int c2s_share_getCamSharedUserList_fun(java.lang.String user,
                                              java.lang.String pass,
                                              java.lang.String devid,
                                              java.lang.String camid)

5.3.2.42. c2s_share_setCamSharedUserList_fun(上传新的摄像头分享用户列表)

public int c2s_share_setCamSharedUserList_fun(java.lang.String user,
                                              java.lang.String pass,
                                              java.lang.String devid,
                                              java.lang.String camid,
                                              java.util.ArrayList<user> users)

5.3.2.43. c2s_disable_cam_low_power_fun(取消外部传感器低电压状态)

public int c2s_disable_cam_low_power_fun(java.lang.String user,
                                         java.lang.String pass,
                                         java.lang.String devid,
                                         java.lang.String camid)

5.3.2.44. c2s_set_cam_private_status_fun(设置摄像头隐私模式)

public int c2s_set_cam_private_status_fun(java.lang.String user,
                                          java.lang.String pass,
                                          java.lang.String devid,
                                          java.lang.String camid,
                                          int status)

5.3.2.45. c2s_get_dev_firmware_info_fun(获取设备最新固件版本信息)

public int c2s_get_dev_firmware_info_fun(java.lang.String user,
                                         java.lang.String pass,
                                         java.lang.String devid)

5.3.2.46. c2s_user_modify_pass_fun(修改用户密码)

public int c2s_user_modify_pass_fun(java.lang.String user,
                                    java.lang.String oldpass,
                                    java.lang.String newpass)

5.3.3. 与设备间的交互接口

5.3.3.1. setPreConnectUUIDs(设置需要预连接的uuid列表)

public int setPreConnectUUIDs(c2d_setPreConnectUUID uuidArray)

5.3.3.2. vv_startsearch(开始搜索局域网中的设备)

public int vv_startsearch(Context context)

5.3.3.3. vv_stopsearch(停止搜索局域网中的设备)

public int vv_stopsearch()

5.3.3.4. wifistartconfig(开启一键WIFI配置)

public int wifistartconfig(Context context,
                           java.lang.String ssid,
                           java.lang.String pass)

5.3.4.5. wifistopconfig(停止一键WIFI配置)

public void wifistopconfig()

5.3.3.6. createConnect(创建与设备端的P2P连接)

public long createConnect(java.lang.String devid,
                          java.lang.String user,
                          java.lang.String pass)

5.3.3.7. releaseConnect(释放P2P连接回调)

public long releaseConnect(long connector)

5.3.3.8. Bind_Lang(添加/绑定设备)

public int Bind_Lang(long hconnector,
                     java.lang.String svraddr,
                     java.lang.String devname,
                     java.lang.String devuser,
                     java.lang.String devpass,
                     java.lang.String binduser,
                     java.lang.String bindpass,
                     java.lang.String dev_lang)

5.3.3.9. getSetupQrcode(生成二维码字符串)

public int getSetupQrcode(java.lang.String svr_addr,
                                        java.lang.String lang,
                                        java.lang.String bind_user,
                                        java.lang.String bind_pass,
                                        java.lang.String ssid,
                                        java.lang.String wifi_pass,
                                        byte[] out)
  • 说明
    获取用于配置和添加设备的二维码字符串

  • 参数说明

    • svr_addr - 服务url,如: http://ppview.vveye.com:3000/webapi/device
    • lang - 客户端语言,中文=zh, 英文=en
    • bind_user - 绑定用户,可以为NULL,如果设备已绑定过,设备会忽略这个值
    • bind_pass - 绑定用户的密码,可以为NULL
    • ssid - wifi的ssid, 如果不需要设置,为NULL
    • wifi_pass - wifi的密码,允许为NULL
    • out - 输出字符串的缓冲区,需要512个字节的空间
  • 返回
    0=成功
    -1=失败

  • 相关接口

5.3.3.10. c2d_set_pass_fun(修改设备端密码)

public int c2d_set_pass_fun(long hconnector,
                            java.lang.String dev_user,
                            java.lang.String dev_pass,
                            java.lang.String new_pass,
                            java.lang.Object usrtag)

5.3.3.11. c2d_getImageMirror_fun(获取摄像头图像镜像/吊装模式)

public int c2d_getImageMirror_fun(long hconnector,
                                  int chlid)

5.3.3.12. c2d_setImageMirror_fun(设置摄像头图像镜像/吊装模式)

public int c2d_setImageMirror_fun(long hconnector,
                                  int chlid,
                                  int mode)

5.3.3.13. reboot(远程重启设备)

public int reboot(long hconnector)

5.3.3.14. c2d_getNetif_fun(获取设备网络配置信息)

public int c2d_getNetif_fun(long hconnector)

5.3.3.15. c2d_setNetif_fun(设置设备网络配置信息)

public int c2d_setNetif_fun(long hconnector,
                            item_netif netif)

5.3.3.16. c2d_scanWifiList_fun(获取设备端扫描到的WIFI列表)

public int c2d_scanWifiList_fun(long hconnector)

5.3.3.17. c2d_getSDInfo_fun(获取设备端SD卡信息)

public int c2d_getSDInfo_fun(long hconnector)
public int c2d_formatSdcard_fun(long hconnector)

5.3.3.19. c2d_getRectrlSchedule_fun(获取设备当前的录像配置)

public int c2d_getRectrlSchedule_fun(long hconnector,
                                     int chl_id)

5.3.3.20. c2d_setRectrlSchedule_fun(设置设备当前的录像配置)

public int c2d_setRectrlSchedule_fun(long hconnector,
                                     int chl_id,
                                     c2d_rec_schedules schedule)

5.3.3.21. c2d_getAlarmCfg_fun(获取安防配置信息)

public int c2d_getAlarmCfg_fun(long hconnector,
                               int chl_id)

5.3.3.22. c2d_setAlarmCfg_fun(设置安防配置信息)

public int c2d_setAlarmCfg_fun(long hconnector,
                               int chl_id,
                               item_alarm_cfg cfg)

5.3.3.23. c2d_getTimeZone_fun(获取设备端时区)

public int c2d_getTimeZone_fun(long hconnector)

5.3.3.24. c2d_setTimeZone_fun(设置设备端时区)

public int c2d_setTimeZone_fun(long hconnector,
                               int time_zone)

5.3.3.25. c2d_UpgradeFirmware_fun(启动设备端固件升级过程)

public int c2d_UpgradeFirmware_fun(long hconnector,
                                   java.lang.String url,
                                   java.lang.String hash)

5.3.3.26. trchlOpen(创建透明传输通道)

public int trchlOpen(long hconnector)
  • 说明 打开透明传输通道。透明通道是为开发者预留的,可以在设备端和客户端之间P2P传输任意格式数据的接口。因此需要设备端与客户端协同才可正常工作。SDK中的DEMO仅示例了这些接口的用法,在真实环境中测试时,需要设备端也实现了相应的接口,并与客户端使用相同的自定义协议。

注:必须与设备端配套使用。所传输的内容是开发者自定义的。

此接口是阻塞模式。如果需要异步执行,开发者需要自己创建线程。

需要先使用createConnect创建P2P连接,并设备P2P连接回调。流程结束后如不再使用P2P连接,需移除P2P连接回调。

public int trchlSend(long trchl_handle,
                     byte[] buffer,
                     int len)

5.3.3.28. trchlClose(关闭透明传输通道)

public int trchlClose(long trchl_handle)

5.3.3.29. c2d_extSensorMatch_fun(开始设备与传感器对码)

public int c2d_extSensorMatch_fun(long hconnector,
                                  int chl_id)

5.3.3.30. c2d_extSensorGetList_fun(获得传感器列表)

public int c2d_extSensorGetList_fun(long hconnector,
                                    int chl_id,
                                    int sensor_type)

5.3.3.31. c2d_extSensorSetInfo_fun(设置传感器信息)

public int c2d_extSensorSetInfo_fun(long hconnector,
                                    item_sensorinfo sensorinfo)

5.3.3.32. c2d_extSensorRemove_fun(移除传感器)

public int c2d_extSensorRemove_fun(long hconnector,
                                   int chl_id,
                                   java.lang.String sensor_id)

5.3.3.33. c2d_extSensorSetSubChlInfo_fun(设置传感器子通道信息)

public int c2d_extSensorSetSubChlInfo_fun(long hconnector,
                                          int chl_id,
                                          java.lang.String sensor_id,
                                          int sub_chl_id,
                                          java.lang.String name,
                                          int alarm_linkage)

5.3.3.34. c2d_extSensorRemoteControlSwitch_fun(传感器远程控制开关)

public int c2d_extSensorRemoteControlSwitch_fun(long hconnector,
                                                int chl_id,
                                                java.lang.String sensor_id,
                                                int sub_chl_id,
                                                int status)

5.3.4. 回调相关接口(平台交互部分)

5.3.4.1. setOnRegisterCallback(设置与注册相关的接口的回调)

public void setOnRegisterCallback(PpviewClientInterface.OnRegisterCallbackListener cb)
public static interface PpviewClientInterface.OnRegisterCallbackListener

5.3.4.2.1. on_get_sms_vcode_callback(获取短信验证码回调)
void on_get_sms_vcode_callback(int nResult)
  • 说明
    获取短信验证码回调

  • 参数说明

    • nResult - 回复值。
说明
200 获取短信验证码成功
203 认证失败(APP_KEY和APP_PASS有问题)
400 服务器错误(数据库访问)
418 手机号已在平台中存在(PpviewClientInterface.c2s_get_sms_vcode_funischeck参数为1时)

5.3.4.2.2. on_get_email_vcode_callback(获取邮箱验证码回调)
void on_get_email_vcode_callback(int nResult)
  • 说明
    获取邮箱验证码回调

  • 参数说明

    • nResult - 回复值。
说明
200 获取邮箱验证码成功
203 认证失败(APP_KEY和APP_PASS有问题)
400 服务器错误(数据库访问或发送邮件失败)
418 邮箱号已在平台中存在(PpviewClientInterface.c2s_get_email_vcode_funischeck参数为1时)

5.3.4.2.3. on_user_regist_callback(用户注册回调)
void on_user_regist_callback(int nResult)
  • 说明
    用户注册回调

  • 参数说明

    • nResult - 回复值。
说明
200 注册成功
203 认证失败(APP_KEY和APP_PASS有问题)
400 服务器错误(数据库访问)
403 没有先获取验证码或验证码已过期
405 验证码不正确
418 手机号或邮箱号已存在

5.3.4.3. setOnUserCallback(设置与用户信息相关的接口的回调)

public void setOnUserCallback(PpviewClientInterface.OnUserCallbackListener cb)
public static interface PpviewClientInterface.OnUserCallbackListener

5.3.4.4.1. on_reset_pass_callback(重置密码的回调)
void on_reset_pass_callback(int nResult,
                            int type,
                            java.lang.String tag)
说明
200 重置成功
203 认证失败(APP_KEY和APP_PASS有问题)
400 服务器错误(数据库访问)
402 用户不存在
403 没有先获取验证码或验证码已过期
405 验证码不正确

5.3.4.4.2. on_get_email_vcode_callback(修改用户昵称的回调)
void on_modify_nick_callback(int nResult,
                             java.lang.String newnick)
  • 说明
    修改用户昵称的回调

  • 参数说明

    • nResult - 回复值。
    • newnick - 新昵称
  • 回复值说明:

说明
200 成功
203 认证失败(APP_KEY、APP_PASS、用户名、密码中有一个或多个有错误)
400 服务器错误(数据库访问)
412 用户不存在

5.3.4.4.3. on_modify_pass_callback(修改用户密码的回调)
void on_modify_pass_callback(int nResult,
                             java.lang.String newpass)
  • 说明
    修改用户密码的回调

  • 参数说明

    • nResult - 回复值。
    • newpass - 新密码
  • 回复值说明:

说明
200 成功
203 认证失败(APP_KEY、APP_PASS、用户名、密码中有一个或多个有错误)
400 服务器错误(数据库访问)
412 用户不存在

5.3.4.5. SetOnC2sLoginCallback(设置登录结果回调)

public void SetOnC2sLoginCallback(PpviewClientInterface.OnC2sLoginCallback cb)
public static interface PpviewClientInterface.OnC2sLoginCallback

5.3.4.6.1. on_c2s_login(登录结果回调)
void on_c2s_login(int nResult)
  • 说明
    登录结果回调

  • 参数说明

    • nResult - 回复值。
  • 回复值说明:

说明
200 成功
203 认证失败(APP_KEY、APP_PASS、用户名、密码中有一个或多个有错误)
400 服务器错误(数据库访问)
411 用户被禁用(即被管理员设置为禁止访问服务器)
412 用户不存在

5.3.4.7. setOnDevListCallback(设置取设备列表结果回调)

public void setOnDevListCallback(PpviewClientInterface.OnDevListCallbackListener cb)
public static interface PpviewClientInterface.OnDevListCallbackListener

5.3.4.8.1. on_devlist_callback(获取设备列表的回调)
void    on_devlist_callback(int nResult, java.lang.String devlist, java.lang.Object usertag)
  • 说明
    获取设备列表的回调

  • 参数说明

  • 回复值说明:

说明
200 成功
203 认证失败(APP_KEY、APP_PASS、用户名、密码中有一个或多个有错误)
400 服务器错误(数据库访问)
500 请求消息内部错误
  • devlist格式说明(JSON)
名称 类型 必需 描述
devs json array 设备列表

devs格式说明:

名称 类型 必需 描述
id string 设备编号
name string 设备名称
vendor string 厂家名称
model string 设备型号
status int 状态,0-离线 1-在线 2-绑定时设备密码设置错误或密码被修改了
dev_user string 设备账号
dev_pass string 设备密码
firmware string 固件版本号

5.3.4.9. setOnCamListExCallback(设置取摄像头列表回调侦听器)

public void setOnCamListExCallback(PpviewClientInterface.OnCamListExCallbackListener cb)
public static interface PpviewClientInterface.OnCamListExCallbackListener

5.3.4.10.1. on_camlist_callback(获取摄像头列表的回调)
void on_camlist_callback(int nResult,
                         java.lang.String camlist)
  • 说明
    获取摄像头列表的回调

  • 参数说明

    • nResult - 回复值。
    • camlist - 返回的摄像头列表json
  • 回复值说明:

说明
200 成功
203 认证失败(APP_KEY、APP_PASS、用户名、密码中有一个或多个有错误)
400 服务器错误(数据库访问)
411 用户被禁用(即被管理员设置为禁止访问服务器)
412 用户不存在
500 请求消息内部错误


* camlist格式说明(JSON)

名称 类型 必需 描述
sn int 列表流水号,用于标识列表内容是否已改变。可用无符号短整型,变化后加1来表示。
id string 列表根节点编号
shared bool 是否已被共享,true或false
groups list 直属分组列表
cams list 直属摄像头列表


groups格式说明:

名称 类型 必需 描述
id string 分组编号
shared bool 是否已被共享,true或false
name string 分组名称
type int 分组类型 0=自建分组 1=共享分组
groups list 直属分组列表
cams list 直属摄像头列表


cams格式说明:

名称 类型 必需 描述
id string 摄像头编号uuid
shared bool 是否已被共享,true或false
name string 摄像头名称
type int 摄像头类型,0=自属摄像头,1=别人共享给自己的摄像头
devid string 所属设备编号
chlid int 通道号
dev_user string 设备用户名(AES加密)
dev_pass string 设备密码(AES加密)
onvif_port int onvif端口,默认为80
state int 0=不在线 1=在线 2-设备密码不正确 默认0
pic_sn string 摄像头图片序列号,图片变化时序列号随机变化
ptz int 0或无表示无云台,1表示有云台
voicetalk_type int 对讲方式,0=无对讲,2=全双工对讲,4=半双工对讲
alert_status int 0=撤防 1=布防(默认为0)
alert_event Int 0=不在报警 1=正在报警
sensor_num int 所挂载的外部传感器数量,默认为0
sensor_low_power int 所挂载的外部传感器是否在低电压状态,0=正常 1=低电压(默认0)
private_status int 隐私模式,0=关闭 1=开启(默认0)
fisheyetype Int 镜头类型:0=正常 1:360度鱼眼 2:180度鱼眼
streams list 码流信息


streams格式说明:

名称 类型 必需 描述
stream_id int 码流号(从0开始)
width int 视频宽度
height int 视频高度
stream_url string 视频流地址
frame_rate int 帧率
fisheye_params list 鱼眼参数


fisheye_params格式说明:

名称 类型 必需 描述
l int 鱼眼图像圆弧左边缘离整个画面左边缘的像素数,如果圆弧左边缘在画面外部,则为负值
r int 鱼眼图像圆弧右边缘离整个画面右边缘的像素数,如果圆弧右边缘在画面外部,则为负值
t int 鱼眼图像圆弧上边缘离整个画面上边缘的像素数,如果圆弧上边缘在画面外部,则为负值
b int 鱼眼图像圆弧下边缘离整个画面下边缘的像素数,如果圆弧下边缘在画面外部,则为负值

5.3.4.11. setOnDevDeleteCallback(设置删除设备回调侦听器)

public void setOnDevDeleteCallback(PpviewClientInterface.OnDeleteDevCallbackListener cb)
public static interface PpviewClientInterface.OnDeleteDevCallbackListener

5.3.4.12.1. on_delete_dev_callback(删除设备回调)
void on_delete_dev_callback(int nResult,
                            java.lang.String devid,
                            java.lang.Object m_usrtag)
  • 说明
    删除设备回调

  • 参数说明

  • 回复值说明:

说明
200 成功
203 认证失败(APP_KEY、APP_PASS、用户名、密码中有一个或多个有错误)
400 服务器错误(数据库访问)

5.3.4.13. setOnCamListChangeCallback(设置摄像头列表相关回调侦听器)

public void setOnCamListChangeCallback(PpviewClientInterface.OnCamListChangeCallbackListener cb)
public static interface PpviewClientInterface.OnCamListChangeCallbackListener

5.3.4.14.1. on_camlist_sn_callback(获取当前摄像头列表的流水号回调)
void on_camlist_sn_callback(int nResult,
                            short sn)
  • 说明
    获取当前摄像头列表的流水号回调

  • 参数说明

    • nResult - 回复值。
    • sn - 摄像头列表的流水号
  • 回复值说明:

说明
200 成功
203 认证失败(APP_KEY、APP_PASS、用户名、密码中有一个或多个有错误)
400 服务器错误(数据库访问)

5.3.4.14.2. on_new_group_callback(新建分组回调)
void on_new_group_callback(int nResult,
                           java.lang.String group_id,
                           java.lang.String parentid,
                           short pre_sn,
                           java.lang.String usrtag)
  • 说明
    新建分组回调

  • 参数说明

    • nResult - 回复值。
    • group_id - 新建的分组id
    • parentid - 新建分组的父类id
    • pre_sn - 摄像头列表的流水号
    • usrtag - 标记,与在调用PpviewClientInterface.c2s_new_group_fun时传入的参数相同。
  • 回复值说明:

说明
200 成功
203 认证失败(APP_KEY、APP_PASS、用户名、密码中有一个或多个有错误)
400 服务器错误(数据库访问失败)
403 服务器错误(更新数据库失败)
410 当前所用的摄像头列表不是最新的,需要重新获取摄像头列表后,再添加。(也就是说在此期间,可能有其它APP修改了摄像头列表,当前所用的列表是旧的,如果基于旧的列表添加分组,可能会引起列表的混乱)
411 找不到指定的父分组

5.3.4.14.3. on_new_group_callback(修改分组名回调)
void on_rename_group_callback(int nResult,
                              java.lang.String groupid,
                              short pre_sn,
                              java.lang.String usertag)
  • 说明
    修改分组名回调

  • 参数说明

  • 回复值说明:

说明
200 成功
203 认证失败(APP_KEY、APP_PASS、用户名、密码中有一个或多个有错误)
400 服务器错误(数据库访问失败)
403 服务器错误(更新数据库失败)
410 当前所用的摄像头列表不是最新的,需要重新获取摄像头列表后,再添加。(也就是说在此期间,可能有其它APP修改了摄像头列表,当前所用的列表是旧的,如果基于旧的列表添加分组,可能会引起列表的混乱)
411 找不到指定的分组

5.3.4.14.4. on_rename_camera_callback(修改摄像头名称回调)
void on_rename_camera_callback(int nResult,
                               java.lang.String cameraid,
                               short pre_sn,
                               java.lang.String usertag)
  • 说明
    修改摄像头名称回调

  • 参数说明

  • 回复值说明:

说明
200 成功
203 认证失败(APP_KEY、APP_PASS、用户名、密码中有一个或多个有错误)
400 服务器错误(数据库访问)
410 所修改的摄像头不属于当前账号

5.3.4.14.5. on_delete_group_callback(删除分组回调)

void on_delete_group_callback(int nResult,
                              java.lang.String groupid,
                              java.lang.String parid,
                              short pre_sn,
                              java.lang.String usertag)
  • 说明
    删除分组回调

  • 参数说明

  • 回复值说明:

说明
200 成功
203 认证失败(APP_KEY、APP_PASS、用户名、密码中有一个或多个有错误)
400 服务器错误(数据库访问失败)
403 服务器错误(更新数据库失败)
410 当前所用的摄像头列表不是最新的,需要重新获取摄像头列表后,再添加。(也就是说在此期间,可能有其它APP修改了摄像头列表,当前所用的列表是旧的,如果基于旧的列表添加分组,可能会引起列表的混乱)
411 找不到指定的分组

5.3.4.14.6. on_move_camera_callback(移动摄像头回调)
void on_move_camera_callback(int nResult,
                             java.lang.String cameraid,
                             java.lang.String newgroupid,
                             short pre_sn,
                             java.lang.String usertag)
  • 说明
    移动摄像头回调

  • 参数说明

    • nResult - 回复值。
    • cameraid - 摄像头id
    • newgroupid - 移动到的分组id
    • pre_sn - 摄像头列表的流水号
    • usrtag - 标记,与在调用PpviewClientInterface.c2s_move_cam_fun时传入的参数相同。
  • 回复值说明:

说明
200 成功
203 认证失败(APP_KEY、APP_PASS、用户名、密码中有一个或多个有错误)
400 服务器错误(数据库访问失败)
403 服务器错误(更新数据库失败)
406 摄像头是其它用户分享过来的,无移动权限。
410 当前所用的摄像头列表不是最新的,需要重新获取摄像头列表后,再添加。(也就是说在此期间,可能有其它APP修改了摄像头列表,当前所用的列表是旧的,如果基于旧的列表添加分组,可能会引起列表的混乱)
411 找不到指定的摄像头
412 目标分组不存在

5.3.4.14.7. on_move_cam_new_group_callback(移动摄像头到新分组回调)
void on_move_cam_new_group_callback(int nResult,
                                    java.lang.String new_group_id,
                                    java.lang.String new_group_name,
                                    java.lang.String new_group_parent,
                                    java.lang.String move_cam_id,
                                    short pre_sn)
  • 说明
    移动摄像头到新分组回调

  • 参数说明

    • nResult - 回复值。
    • new_group_id - 新分组id
    • new_group_name - 新分组的名称
    • new_group_parent - 新建分组的父类id
    • move_cam_id - 被移动的摄像头ID
    • pre_sn - 流水号
  • 回复值说明:

说明
200 成功
203 认证失败(APP_KEY、APP_PASS、用户名、密码中有一个或多个有错误)
400 服务器错误(数据库访问失败)
403 服务器错误(更新数据库失败)
410 当前所用的摄像头列表不是最新的,需要重新获取摄像头列表后,再添加。(也就是说在此期间,可能有其它APP修改了摄像头列表,当前所用的列表是旧的,如果基于旧的列表添加分组,可能会引起列表的混乱)
411 找不到指定的分组

5.3.4.14.8. on_move_group_callback(移动分组回调)
void on_move_group_callback(int nResult,
                            java.lang.String groupid,
                            java.lang.String newgroupid,
                            java.lang.String oldgroupid,
                            short pre_sn,
                            java.lang.String usertag)
  • 说明
    移动分组回调

  • 参数说明

    • nResult - 回复值。
    • groupid - 分组id
    • newgroupid - 移动到的分组id
    • oldgroupid - 移动后的父类分组id
    • pre_sn - 摄像头列表的流水号
    • usrtag - 标记,与在调用PpviewClientInterface.c2s_move_group_fun时传入的参数相同。
  • 回复值说明:

说明
200 成功
203 认证失败(APP_KEY、APP_PASS、用户名、密码中有一个或多个有错误)
400 服务器错误(数据库访问失败)
403 服务器错误(更新数据库失败)
410 当前所用的摄像头列表不是最新的,需要重新获取摄像头列表后,再添加。(也就是说在此期间,可能有其它APP修改了摄像头列表,当前所用的列表是旧的,如果基于旧的列表添加分组,可能会引起列表的混乱)
411 找不到指定的分组
412 目标分组不存在

5.3.4.14.9. on_move_group_new_group_callback(移动分组到新建分组回调)
void on_move_group_new_group_callback(int nResult,
                                      java.lang.String new_group_id,
                                      java.lang.String new_group_name,
                                      java.lang.String new_group_parent,
                                      java.lang.String old_group_parent,
                                      java.lang.String move_group_id,
                                      short pre_sn)
  • 说明
    移动分组到新建分组回调

  • 参数说明

    • nResult - 回复值。
    • new_group_id - 新建分组ID
    • new_group_name - 新建分组名称
    • new_group_parent - 新建分组的父类ID
    • old_group_parent - 被移动分组的父类ID
    • move_group_id - 被移动分组的ID
    • pre_sn - 流水号
  • 回复值说明:

说明
200 成功
203 认证失败(APP_KEY、APP_PASS、用户名、密码中有一个或多个有错误)
400 服务器错误(数据库访问失败)
403 服务器错误(更新数据库失败)
410 当前所用的摄像头列表不是最新的,需要重新获取摄像头列表后,再添加。(也就是说在此期间,可能有其它APP修改了摄像头列表,当前所用的列表是旧的,如果基于旧的列表添加分组,可能会引起列表的混乱)
411 找不到指定的分组

5.3.4.15. SetOnC2sSetCamAlertStatusCallback(设置摄像头布撤防回调侦听器)

public void SetOnC2sSetCamAlertStatusCallback(PpviewClientInterface.OnC2sSetCamAlertStatusCallback cb)
public static interface PpviewClientInterface.OnDeleteDevCallbackListener

5.3.4.16.1. on_c2s_set_cam_alert_status(单个摄像头布撤防状态回调)
void on_c2s_set_cam_alert_status(int nResult,
                                 java.lang.String camId,
                                 int alert_status)
  • 说明
    单个摄像头布撤防状态回调

  • 参数说明

    • nResult - 回复值。
    • camId - 摄像头id
    • alert_status - 布撤防状态: 0=撤防 1=设防
  • 回复值说明:

说明
200 成功
203 认证失败(APP_KEY、APP_PASS、用户名、密码中有一个或多个有错误)
400 服务器错误(数据库访问失败)
404 无权限

5.3.4.16.2. on_c2s_set_cams_alert_status(多个摄像头布撤防状态回调)
void on_c2s_set_cams_alert_status(int nResult,
                                  java.util.ArrayList<item_cams> cams,
                                  int status)
  • 说明
    多个摄像头布撤防状态回调

  • 参数说明

    • nResult - 回复值。
    • cams - 多个摄像头的集合,参见item_cams
    • status - 布撤防状态: 0=撤防 1=设防
  • 回复值说明:

说明
200 成功
203 认证失败(APP_KEY、APP_PASS、用户名、密码中有一个或多个有错误)
400 服务器错误(数据库访问失败)
404 无权限

5.3.4.17. SetOnC2sGetUnreadEventCountCallback(设置未读事件数量回调侦听器)

public void SetOnC2sGetUnreadEventCountCallback(PpviewClientInterface.OnC2sGetUnreadEventCountCallback cb)
public static interface PpviewClientInterface.OnC2sGetUnreadEventCountCallback

5.3.4.18.1. on_c2s_get_unread_event_count_callback(获得未读事件数量的回调)
void on_c2s_get_unread_event_count_callback(int nResult,
                                            int unread_count)
  • 说明
    单个摄像头布撤防状态回调

  • 参数说明

    • nResult - 回复值。
    • unread_count - 未读事件数量
  • 回复值说明:

说明
200 成功
203 认证失败
400 平台服务器内部错误
500 请求格式错误

5.3.4.19. SetOnC2sGetEventListCallback(设置获取事件列表回调侦听器)

public void SetOnC2sGetEventListCallback(PpviewClientInterface.OnC2sGetEventListCallback cb)
public static interface PpviewClientInterface.OnC2sGetEventListCallback

5.3.4.20.1. on_c2s_get_event_list(获得事件列表的回调)
void on_c2s_get_event_list(int nResult,
                           java.lang.String json,
                           java.lang.String eventId)
说明
200 成功
203 认证失败
400 平台服务器内部错误
500 请求格式错误


事件列表格式说明(JSON)

名称 类型 是否必需 说明
events list 事件列表

events说明:

名称 类型 是否必需 说明
event_id string 事件编号
time int 事件发生时的时间(UTC)
event_type int 事件类型,参见事件类型表
readed bool 是否已读
cam_id string 事件对应通道编号
cam_nam string 事件对应通道名
event_pic_id string 事件对应缩略图编号(如没有事件抓图,则没有这一项)
rec_duration int 如果有事件录像,表示事件录像时长,单位秒。
event_important int 是否是紧急报警(1=是,0=否)
sensor_id string 外部传感器编号
sensor_name string 外部传感器名称
sensor_status int 外部传感器状态(0=关闭 1=报警 2=触发)
sensor_sub_chl_id int 外部传感器子通道编号(从0开始)
sensor_sub_chl_name string 外部传感器子通道名称
sensor_sub_chl_status int 外部传感器子通道状态
title string 标题
memo string 摘要
fisheyetype int 鱼眼类型,0=非鱼眼,1=顶装360度鱼眼,2=壁装180度鱼眼
fisheye_params json 鱼眼图像校准参数

fishtye_params说明:

名称 类型 必需 描述
l float 鱼眼图像圆弧左边缘离整个画面左边缘的像素数,如果圆弧左边缘在画面外部,则为负值
r float 鱼眼图像圆弧右边缘离整个画面右边缘的像素数,如果圆弧右边缘在画面外部,则为负值
t float 鱼眼图像圆弧上边缘离整个画面上边缘的像素数,如果圆弧上边缘在画面外部,则为负值
b float 鱼眼图像圆弧下边缘离整个画面下边缘的像素数,如果圆弧下边缘在画面外部,则为负值

5.3.4.21. SetOnC2sGetCamEventListCallback(设置获取指定摄像头事件列表的回调侦听器)

public void SetOnC2sGetCamEventListCallback(PpviewClientInterface.OnC2sGetCamEventListCallback cb)
public static interface PpviewClientInterface.OnC2sGetCamEventListCallback

5.3.4.22.1. on_c2s_get_cam_event_list(获取指定摄像头事件列表的回调)
void on_c2s_get_cam_event_list(int nResult,
                               java.lang.String json,
                               java.lang.String eventId)
说明
200 成功
203 认证失败
400 平台服务器内部错误
500 请求格式错误

5.3.4.23. SetOnC2sSetAllEventsReadedCallback(设置将所有事件设置为已读回调侦听器)

public void SetOnC2sSetAllEventsReadedCallback(PpviewClientInterface.OnC2sSetAllEventsReadedCallback cb)
public static interface PpviewClientInterface.OnC2sSetAllEventsReadedCallback

5.3.4.24.1. on_c2s_set_all_events_readed(将所有事件设置为已读状态的回调)
void on_c2s_set_all_events_readed(int nREsult)
  • 说明
    将所有事件设置为已读状态的回调

  • 参数说明

    • nResult - 回复值。
  • 回复值说明:

说明
200 成功
203 认证失败
400 平台服务器内部错误
500 请求格式错误

5.3.4.25. setOnC2sFriendCallback(设置关系管理回调侦听器)

public void setOnC2sFriendCallback(PpviewClientInterface.OnC2sFriendCallback cb)

5.3.4.26. OnC2sFriendCallback(关系管理回调侦听器)

public static interface PpviewClientInterface.OnC2sFriendCallback

5.3.4.26.1. on_c2s_getfriendList(获取关系列表回调)
void on_c2s_getfriendList(int nResult,
                          java.util.ArrayList<item_relations> relations)
  • 说明
    获取关系列表回调

  • 参数说明

    • nResult - 回复值。
    • relations - 关系列表,参见item_relations
  • 回复值说明:

说明
200 成功
203 认证失败
400 平台服务器内部错误
500 请求格式错误

5.3.4.26.2. on_c2s_addfriendRelation(添加关系回调)
void on_c2s_addfriendRelation(int nResult,
                              java.lang.String relation_user,
                              int relation_type)
  • 说明
    添加关系回调

  • 参数说明

    • nResult - 回复值。
    • relation_user - 好友或黑名单账号
    • relation_type - 1=好友(向对方请求) 2=黑名单(直接添加) (注:添加好友需要对方审核,黑名单直接加入列表)
  • 回复值说明:

说明
200 成功
203 认证失败
400 平台服务器内部错误
405 我在对方黑名单中,无法请求添加好友
406 对方在我黑名单中,不能添加为好友,需要先移除,或直接使用PpviewClientInterface.c2s_modify_user_relation_fun函数。
411 已是好友,不需要再请求
412 对方账号不存在
500 请求格式错误

5.3.4.26.3. on_c2s_modifyfriendRelation(修改关系回调)
void on_c2s_modifyfriendRelation(int nResult,
                                 java.lang.String relation_user,
                                 int relation_type,
                                 java.lang.String memo)
说明
200 成功
203 认证失败
400 平台服务器内部错误
412 对方不在我的关系列表中
500 请求格式错误

5.3.4.26.4. on_c2s_removefriendRelation(删除关系回调)
void on_c2s_removefriendRelation(int nResult,
                                 java.lang.String relation_user)
说明
200 成功
203 认证失败
400 平台服务器内部错误
412 对方不在我的关系列表中
500 请求格式错误

5.3.4.27. setOnC2sShareCallback(设置分享管理相关回调侦听器)

public void setOnC2sShareCallback(PpviewClientInterface.OnC2sShareCallback cb)

5.3.4.28. OnC2sShareCallback(分享管理相关回调侦听器)

public static interface PpviewClientInterface.OnC2sShareCallback

5.3.4.28.1. on_c2s_set_cam_share_list(上传分享给某用户的摄像头列表回调)
void on_c2s_set_cam_share_list(int nResult)
  • 说明
    上传分享给某用户的摄像头列表回调

  • 参数说明

    • nResult - 回复值。
  • 回复值说明:

说明
200 成功
203 认证失败
400 平台服务器内部错误
405 我在对方黑名单中
412 对方非好友
500 请求格式错误

5.3.4.28.2. on_c2s_set_cam_share_list(获得分享给某用户的摄像头列表回调)
void on_c2s_get_cam_share_list(int nResult,
                               java.util.ArrayList<item_sharelist> shareList)
  • 说明
    获得分享给某用户的摄像头列表回调

  • 参数说明

    • nResult - 回复值。
    • shareList - 分享的摄像头列表,参见item_sharelist
  • 回复值说明:

说明
200 成功
203 认证失败
400 平台服务器内部错误
412 对方非好友
500 请求格式错误

5.3.4.28.3. on_c2s_get_cam_requestshare_list(获取其它用户发来的分享请求列表回调)
void on_c2s_get_cam_requestshare_list(int nResult,
                                      java.util.ArrayList<item_share_reqs> requestShareList)
  • 说明
    获取其它用户发来的分享请求列表回调

  • 参数说明

    • nResult - 回复值。
    • requestShareList - 分享请求列表,参见item_share_reqs
  • 回复值说明:

说明
200 成功
203 认证失败
400 平台服务器内部错误
412 对方非好友
500 请求格式错误

5.3.4.28.4. on_c2s_response_cam_share(同意或拒绝分享请求回调)
void on_c2s_response_cam_share(int nResult,
                               java.lang.String req_id)
说明
200 成功
203 认证失败
400 平台服务器内部错误
405 我在对方黑名单中
406 对方在我黑名单中
412 设备已不归属于我
500 请求格式错误

5.3.4.28.5. on_c2s_disable_share_cam(删除分享给自己的摄像头回调)
void on_c2s_disable_share_cam(int nResult,
                              java.lang.String dev_id,
                              java.lang.String cam_id)
说明
200 成功
203 认证失败(APP_KEY、APP_PASS、用户名、密码中有一个或多个有错误)
400 服务器错误(数据库访问)

5.3.4.29. setOnC2sRequestShareCallback(设置分享请求相关回调侦听器)

public void setOnC2sRequestShareCallback(PpviewClientInterface.OnC2sRequestShareCallback cb)

5.3.4.30. OnC2sRequestShareCallback(分享请求相关回调侦听器)

public static interface PpviewClientInterface.OnC2sRequestShareCallback

5.3.4.30.1. on_c2s_get_dev_owner(获取设备的归属用户回调)
void on_c2s_get_dev_owner(int nResult,
                          java.lang.String devid,
                          java.lang.String ownerid,
                          java.lang.String ownernick)
  • 说明
    获取设备的归属用户回调

  • 参数说明

    • nResult - 回复值。
    • devid - 设备ID
    • ownerid - 属主用户名
    • ownernick - 属主昵称
  • 回复值说明:

说明
200 成功
203 认证失败
400 平台服务器内部错误
500 请求格式错误

5.3.4.30.2. on_c2s_req_dev_share(请求其它用户分享摄像头回调)
void on_c2s_req_dev_share(int nResult,
                          java.lang.String devid)
  • 说明
    请求其它用户分享摄像头回调

  • 参数说明

    • nResult - 回复值。
    • devid - 设备ID
  • 回复值说明:

说明
200 成功
203 认证失败
400 平台服务器内部错误
500 请求格式错误

5.3.4.30.3. on_c2s_get_cam_shared_userlist(获取某摄像头的分享用户列表回调)
void on_c2s_get_cam_shared_userlist(int nResult,
                                    java.util.ArrayList<user> user_list)
  • 说明
    获取某摄像头的分享用户列表回调

  • 参数说明

    • nResult - 回复值。
    • user_list - 用户列表,数组元素参见user
  • 回复值说明:

说明
200 成功
203 认证失败
400 平台服务器内部错误
500 请求格式错误

5.3.4.30.4. on_c2s_set_cam_shared_userlist(设置某摄像头的分享用户列表回调)
void on_c2s_set_cam_shared_userlist(int nResult,
                                    java.util.ArrayList<user> user_list)
说明
200 成功
203 认证失败
400 平台服务器内部错误
500 请求格式错误

5.3.4.31. setOnC2sDisableCamLowPowerCallback(设置取消外部传感器低电压状态回调侦听器)

public void setOnC2sDisableCamLowPowerCallback(PpviewClientInterface.OnC2sDisableCamLowPowerCallback cb)

5.3.4.32. OnC2sDisableCamLowPowerCallback(取消外部传感器低电压状态回调侦听器)

public static interface PpviewClientInterface.OnC2sDisableCamLowPowerCallback

5.3.4.32.1. c2s_disable_cam_low_power(取消外部传感器低电压状态回调)
void c2s_disable_cam_low_power(int nResult,
                               java.lang.String devid,
                               java.lang.String camid)
  • 说明
    取消外部传感器低电压状态回调

  • 参数说明

    • nResult - 回复值
    • devid - 设备ID
    • camid - 摄像头ID
  • 回复值说明:

说明
200 成功
203 认证失败
400 平台服务器内部错误
500 请求格式错误

5.3.4.33. setOnC2sSetCamPrivateStatusCallback(设置"设置摄像头隐私模式回调"侦听器)

public void setOnC2sSetCamPrivateStatusCallback(PpviewClientInterface.OnC2sSetCamPrivateStatusCallback cb)

5.3.4.34. OnC2sSetCamPrivateStatusCallback("设置摄像头隐私模式回调"侦听器)

public static interface PpviewClientInterface.OnC2sSetCamPrivateStatusCallback

5.3.4.34.1. c2s_set_cam_privateStatus(设置摄像头隐私模式回调)
void c2s_set_cam_privateStatus(int nResult,
                               java.lang.String camid,
                               int status)
  • 说明
    设置摄像头隐私模式回调

  • 参数说明

    • nResult - 回复值
    • camid - 摄像头ID
    • status - 是否开启,0=关闭 1=开启
  • 回复值说明:

说明
200 成功
203 认证失败(APP_KEY、APP_PASS、用户名、密码中有一个或多个有错误)
400 服务器错误(数据库访问)

5.3.4.35. setOnC2sGetDevFirmwareInfoCallback(设置"获取设备最新固件版本信息回调"侦听器)

public void setOnC2sGetDevFirmwareInfoCallback(PpviewClientInterface.OnC2sGetDevFirmwareInfoCallback cb)

5.3.4.36. OnC2sGetDevFirmwareInfoCallback("获取设备最新固件版本信息回调"侦听器)

public static interface PpviewClientInterface.OnC2sGetDevFirmwareInfoCallback

5.3.4.36.1. c2s_get_dev_firmwareInfo(获取设备最新固件版本信息回调)
void c2s_get_dev_firmwareInfo(int nResult,
                              java.lang.String devid,
                              item_firmware_info info)
  • 说明
    设置摄像头隐私模式回调

  • 参数说明

    • nResult - 回复值
    • devid - 设备ID
    • info - 固件的版本信息,参见item_firmware_info
  • 回复值说明:

说明
200 成功
203 认证失败
400 平台端错误或设备还未被绑定

5.3.5. 回调相关接口(与设备交互部分)

5.3.5.1. setOnC2DCallback(设置设备绑定相关回调接口侦听器)

public void setOnC2DCallback(PpviewClientInterface.OnC2DCallbackListener cb)

5.3.5.2. OnC2DCallbackListener(设备绑定相关回调接口侦听器)

public static interface PpviewClientInterface.OnC2DCallbackListener

5.3.5.2.1. on_vv_search_dev_callback(搜索设备回调)
void on_vv_search_dev_callback(java.lang.String json)
  • 说明
    搜索设备回调

  • 参数说明

    • json - 搜索到的设备,JSON格式
  • json说明:

名称 类型 是否必需 说明
devices list 设备列表

devices说明:
名称|类型|是否必需|说明
---|---|---|---
dev_id|String|是|设备编号
ip|String|是|设备IP地址

5.3.5.2.2. on_bind_ip(绑定设备回调)
void on_bind_ip(int nResult,
                long connectHandler)
  • 说明
    设置摄像头隐私模式回调

  • 参数说明

    • nResult - 回复值
    • connectHandler - 连接句柄
  • 回复值 说明:

说明
-1 客户端句柄不存在
-2 库未初始化
-3 连接句柄不存在
-4 发送数据失败
-5 接收数据失败
-6 超时
-7 设备端返回的结果有错误
200 成功
203 认证失败(APP_KEY、APP_PASS、用户名、密码中有一个或多个有错误)
400 服务器错误(数据库访问)
408 设备已被其它用户绑定
412 用户密码错误或用户不存在
500 请求消息参数错误
504 鉴权失败



5.3.5.3. setOndevConnectCallback/removeOndevConnectCallback(设置和取消P2P连接回调)

public void setOndevConnectCallback(PpviewClientInterface.OnDevConnectCallbackListener cb)
public void removeOndevConnectCallback(PpviewClientInterface.OnDevConnectCallbackListener cb)

5.3.5.4. OnDevConnectCallbackListener(P2P连接回调接口侦听器)

public static interface PpviewClientInterface.OnDevConnectCallbackListener

5.3.5.4.1. on_connect_callback(P2P连接回调接口)
void on_connect_callback(int msgid,
                         long connector,
                         int result)
  • 说明
    P2P连接回调接口

  • 参数说明

    • msgid - 已废弃,忽略
    • connector - 连接句柄
    • result - 状态值。连接成功:1 p2p连接超时:0 p2p未初始化:-1 p2p连接失败:-2 连接中断:-3 设备不在线:-4
  • 状态值说明:

说明
1 连接成功
0 p2p连接超时
-1 p2p未初始化
-2 p2p连接失败
-3 连接中断
-4 设备不在线

5.3.5.5. setOnDevSetCallback(设置修改设备密码回调侦听器)

public void setOnDevSetCallback(PpviewClientInterface.OnDevSetCallbackListener cb)

5.3.5.6. OnDevSetCallbackListener(修改设备密码回调侦听器)

public static interface PpviewClientInterface.OnDevSetCallbackListener

5.3.5.6.1. on_setpass_callback(修改设备密码回调)
void on_setpass_callback(int nResult,
                         java.lang.Object usertag)

回复值说明:

回复值 说明
-1 客户端句柄不存在
-2 库未初始化
-3 连接句柄不存在
-4 发送数据失败
-5 接收数据失败
-6 超时
-7 设备端返回的结果有错误
200 成功
203 老密码认证错误
500 参数错误
501 设备端不支持获取用户信息
502 设备端不支持修改密码

5.3.5.7. setOnC2dImageMirrorCallback(设置”获取/设置镜像模式结果回调“侦听器)

public void setOnC2dImageMirrorCallback(PpviewClientInterface.OnC2dImageMirrorCallback cb)

5.3.5.8. OnDevSetCallbackListener(”获取/设置镜像模式结果回调“侦听器)

public static interface PpviewClientInterface.OnC2dImageMirrorCallback

5.3.5.8.1. on_c2d_getImageMirrorCallBack(获取镜像模式设置回调)
void on_c2d_getImageMirrorCallBack(int nResult,
                                   int mode)
  • 说明
    获取镜像模式设置回调

  • 参数说明

    • nResult - 回复值
    • mode - 镜像模式:0=正常 1=上下翻转 2=左右翻转 3=上下且左右翻转

回复值说明:

回复值 说明
-1 客户端句柄不存在
-2 库未初始化
-3 连接句柄不存在
-4 发送数据失败
-5 接收数据失败
-6 超时
-7 设备端返回的结果有错误
200 成功
203 设备端认证失败
205 设备端不支持
500 请求参数错误

5.3.5.8.2. on_c2d_setImageMirrorCallBack(设置镜像模式设置回调)
void on_c2d_setImageMirrorCallBack(int nResult,
                                   int mode)
  • 说明
    设置镜像模式设置回调

  • 参数说明

    • nResult - 回复值
    • mode - 镜像模式:0=正常 1=上下翻转 2=左右翻转 3=上下且左右翻转

回复值说明:

回复值 说明
-1 客户端句柄不存在
-2 库未初始化
-3 连接句柄不存在
-4 发送数据失败
-5 接收数据失败
-6 超时
-7 设备端返回的结果有错误
200 成功
203 设备端认证失败
205 设备端不支持
500 请求参数错误

5.3.5.9. setOnC2dGetNetifCallback(设置”获取设备网络配置信息结果回调“侦听器)

public void setOnC2dGetNetifCallback(PpviewClientInterface.OnC2dGetNetifCallback cb)

5.3.5.10. OnC2dGetNetifCallback(”获取设备网络配置信息结果回调“侦听器)

public static interface PpviewClientInterface.OnC2dImageMirrorCallback

5.3.5.10.1. on_c2d_getNetifCallBack(获取设备网络配置信息结果回调)
void on_c2d_getNetifCallBack(int nResult,
                             c2d_netif_info info)
  • 说明
    获取设备网络配置信息结果回调

  • 参数说明

    • nResult - 回复值
    • info - 查询到的网络信息,参见c2d_netif_info

回复值说明:

回复值 说明
-1 客户端句柄不存在
-2 库未初始化
-3 连接句柄不存在
-4 发送数据失败
-5 接收数据失败
-6 超时
-7 设备端返回的结果有错误
200 成功
203 非法请求
205 设备端不支持
414 设备账号或密码错误
500 请求参数错误
501 设备端查询网络配置时出错

5.3.5.11. setOnC2dScanWifiCallback(设置”获取设备端扫描到的WIFI列表的回调“侦听器)

public void setOnC2dScanWifiCallback(PpviewClientInterface.OnC2dScanWifiCallback cb)

5.3.5.12. OnC2dScanNetifCallback(”获取设备端扫描到的WIFI列表的回调“侦听器)

public static interface PpviewClientInterface.OnC2dScanWifiCallback

5.3.5.12.1. on_c2d_scanWifiListCallBack(获取设备端扫描到的WIFI列表的回调)
void on_c2d_scanWifiListCallBack(int nResult,
                                 item_wifi wifi_info)
  • 说明
    获取设备端扫描到的WIFI列表的回调

  • 参数说明

    • nResult - 回复值
    • wifi_info - WIFI信息列表,参见item_wifi

回复值说明:

回复值 说明
-1 客户端句柄不存在
-2 库未初始化
-3 连接句柄不存在
-4 发送数据失败
-5 接收数据失败
-6 超时
-7 设备端返回的结果有错误
200 成功
203 非法请求
205 设备端不支持
413 设备扫描WIFI列表时出错
500 请求参数错误

5.3.5.13. setOnC2dSDCardCallback(设置”SD卡信息相关回调“侦听器)

public void setOnC2dSDCardCallback(PpviewClientInterface.OnC2dSDCardCallback cb)

5.3.5.14. OnC2dSDCardCallback(”SD卡信息相关回调“侦听器)

public static interface PpviewClientInterface.OnC2dSDCardCallback

5.3.5.14.1. on_c2d_getSdcardInfoCallBack(获取SD卡信息的回调)
void on_c2d_getSdcardInfoCallBack(int nResult,
                                  item_sdcard_info info)
  • 说明
    获取SD卡信息的回调

  • 参数说明

回复值说明:

回复值 说明
-1 客户端句柄不存在
-2 库未初始化
-3 连接句柄不存在
-4 发送数据失败
-5 接收数据失败
-6 超时
-7 设备端返回的结果有错误
200 成功
203 非法请求
205 设备端不支持
404 设备端没有SD卡

5.3.5.14.2. on_c2d_formatSdcardProCallBack(格式化SD卡进度的回调)
void on_c2d_formatSdcardProCallBack(int count)

5.3.5.14.3. on_c2d_formatSdcardCallBack(格式化SD卡结果的回调)
void on_c2d_formatSdcardCallBack(int nResult)
  • 说明
    格式化SD卡结果的回调

  • 参数说明

    • nResult - 回复值

回复值说明:

回复值 说明
-1 客户端句柄不存在
-2 库未初始化
-3 连接句柄不存在
-4 发送数据失败
-5 接收数据失败
-6 超时
-7 设备端返回的结果有错误
200 成功
203 非法请求
205 设备端不支持
404 设备端没有SD卡
501 格式化失败
502 SD卡太小,无法创建保留分区(>=2G)

5.3.5.15. setOnC2dRectrlScheduleCallback(设置”录像计划相关回调“侦听器)

public void setOnC2dRectrlScheduleCallback(PpviewClientInterface.OnC2dRectrlScheduleCallback cb)

5.3.5.16. OnC2dRectrlScheduleCallback(”录像计划相关回调“侦听器)

public static interface PpviewClientInterface.OnC2dRectrlScheduleCallback

5.3.5.16.1. on_c2d_getRectrlScheduleCallBack(获取录像计划回调)
void on_c2d_getRectrlScheduleCallBack(int nResult,
                                      c2d_rec_schedules schedule)
  • 说明
    获取录像计划回调

  • 参数说明

回复值说明:

回复值 说明
-1 客户端句柄不存在
-2 库未初始化
-3 连接句柄不存在
-4 发送数据失败
-5 接收数据失败
-6 超时
-7 设备端返回的结果有错误
200 成功
203 非法请求
205 设备端不支持
500 请求命令格式错误

5.3.5.16.2. on_c2d_setRectrlScheduleCallBack(设置录像计划回调)
void on_c2d_setRectrlScheduleCallBack(int nResult,
                                      c2d_rec_schedules schedule)
  • 说明
    设置录像计划回调

  • 参数说明

回复值说明:

回复值 说明
-1 客户端句柄不存在
-2 库未初始化
-3 连接句柄不存在
-4 发送数据失败
-5 接收数据失败
-6 超时
-7 设备端返回的结果有错误
200 成功
203 非法请求
205 设备端不支持
500 请求命令格式错误

5.3.5.17. setOnC2dAlarmCfgCallback(设置”安防配置相关回调“侦听器)

public void setOnC2dAlarmCfgCallback(PpviewClientInterface.OnC2dAlarmCfgCallback cb)

5.3.5.18. OnC2dAlarmCfgCallback(”安防配置相关回调“侦听器)

public static interface PpviewClientInterface.OnC2dAlarmCfgCallback

5.3.5.18.1. on_c2d_getAlarmCfgCallBack(获取安防配置回调)
void on_c2d_getAlarmCfgCallBack(int nResult,
                                item_alarm_cfg cfg)
  • 说明
    获取安防配置回调

  • 参数说明

回复值说明:

回复值 说明
-1 客户端句柄不存在
-2 库未初始化
-3 连接句柄不存在
-4 发送数据失败
-5 接收数据失败
-6 超时
-7 设备端返回的结果有错误
200 成功
203 非法请求
205 设备端不支持
500 请求命令格式错误

5.3.5.18.2. on_c2d_setAlarmCfgCallBack(设置安防配置回调)
void on_c2d_setAlarmCfgCallBack(int nResult,
                                item_alarm_cfg cfg)
  • 说明
    设置安防配置回调

  • 参数说明

    • nResult - 回复值
    • cfg - 所设置的安防配置,参见item_alarm_cfg

回复值说明:

回复值 说明
-1 客户端句柄不存在
-2 库未初始化
-3 连接句柄不存在
-4 发送数据失败
-5 接收数据失败
-6 超时
-7 设备端返回的结果有错误
200 成功
203 非法请求
205 设备端不支持
500 请求命令格式错误

5.3.5.19. setOnC2dTimeZoneCallback(设置”时区配置相关回调“侦听器)

public void setOnC2dTimeZoneCallback(PpviewClientInterface.OnC2dTimeZoneCallback cb)

5.3.5.20. OnC2dTimeZoneCallback(”时区配置相关回调“侦听器)

public static interface PpviewClientInterface.OnC2dTimeZoneCallback

5.3.5.20.1. on_c2d_getTimeZoneCallBack(获取设备端时区回调)
void on_c2d_getTimeZoneCallBack(int nResult)
  • 说明
    获取设备端时区回调

  • 参数说明

    • nResult - 回复值

回复值说明:

回复值 说明
-101 客户端句柄不存在
-102 库未初始化
-103 连接句柄不存在
-104 发送数据失败
-105 接收数据失败
-106 超时
-107 设备端返回的结果有错误
-11~12 时区值,东区为正值,西区为负值。

5.3.5.20.2. on_c2d_setTimeZoneCallBack(设置设备端时区回调)
void on_c2d_setTimeZoneCallBack(int nResult,
                                int time_zone)

回复值说明:

回复值 说明
-1 客户端句柄不存在
-2 库未初始化
-3 连接句柄不存在
-4 发送数据失败
-5 接收数据失败
-6 超时
-7 设备端返回的结果有错误
200 成功
203 认证失败
500 请求格式错误

5.3.5.21. setOnC2dUpgradeFirmwareCallback(设置”固件升级相关回调“侦听器)

public void setOnC2dUpgradeFirmwareCallback(PpviewClientInterface.OnC2dUpgradeFirmwareCallback cb)

5.3.5.22. OnC2dTimeZoneCallback(”固件升级相关回调“侦听器)

public static interface PpviewClientInterface.OnC2dUpgradeFirmwareCallback

5.3.5.22.1. on_c2d_DownloadProgressCallBack(下载固件进度回调)
void on_c2d_DownloadProgressCallBack(int Progress)

5.3.5.22.2. on_c2d_DownloadResultCallBack(下载固件结果回调)
void on_c2d_DownloadResultCallBack(int Result)
  • 说明
    下载固件结果回调

  • 参数说明

    • nResult - 回复值

回复值说明:

回复值 说明
-1 客户端句柄不存在
-2 库未初始化
-3 连接句柄不存在
-4 发送数据失败
-5 接收数据失败
-6 超时
-7 设备端返回的结果有错误
200 成功
203 认证失败
204 设备未就绪
205 设备不支持
404 下载固件失败
405 下载的固件文件校验失败
417 设备正处于升级状态,无法完成本次升级请求

5.3.5.22.3. on_c2d_UpgradeProgressCallBack(升级固件进度回调)
void on_c2d_UpgradeProgressCallBack(int Progress)

5.3.5.22.4. on_c2d_UpgradeProgressCallBack(升级固件结果回调)
void on_c2d_UpgradeProgressCallBack(int Progress)
  • 说明
    升级固件结果回调

  • 参数说明

    • nResult - 回复值

回复值说明:

回复值 说明
-1 客户端句柄不存在
-2 库未初始化
-3 连接句柄不存在
-4 发送数据失败
-5 接收数据失败
-6 超时
-7 设备端返回的结果有错误
200 成功
203 认证失败
204 设备未就绪
205 设备不支持
406 升级失败
417 设备正处于升级状态,无法完成本次升级请求

5.3.5.23. setTransparentCallbackListener(设置“通过透明通道接收数据回调”侦听器)

public void setTransparentCallbackListener(PpviewClientInterface.OnTransparentCallbackListener cb)

5.3.5.24. OnTransparentCallbackListener(“通过透明通道接收数据回调”侦听器)

public static interface PpviewClientInterface.OnTransparentCallbackListener

5.3.5.24.1. on_transparent_chl_callback(通过透明通道接收数据回调)
void on_transparent_chl_callback(long trchl_handle,
                                 byte[] info,
                                 int info_len)

5.3.5.25. setOnC2dSensorCallback(设置“传感器相关回调”侦听器)

public void setOnC2dSensorCallback(PpviewClientInterface.OnC2dSensorCallback cb)

5.3.5.26. OnC2dSensorCallback(“传感器相关回调”侦听器)

public static interface PpviewClientInterface.OnC2dSensorCallback

5.3.5.26.1. on_c2d_extSensorMatch(通过透明通道接收数据回调)
void on_c2d_extSensorMatch(int nResult,
                           java.util.ArrayList<item_sensorinfo> sensors)
  • 说明
    传感器对码结果回调

  • 参数说明

    • nResult - 回复值
    • sensors - 配对成功的传感器列表(通常只有一个),参见item_sensorinfo类。

回复值说明:

回复值 说明
-1 客户端句柄不存在
-2 库未初始化
-3 连接句柄不存在
-4 发送数据失败
-5 接收数据失败
-6 超时
-7 设备端返回的结果有错误
200 成功
203 认证失败
205 设备不支持
409 正在对码中
500 参数错误
501 对码超时或失败

5.3.5.26.2. on_c2d_extSensorGetList(获得传感器列表回调)
void on_c2d_extSensorGetList(int nResult,
                             java.util.ArrayList<item_sensorinfo> sensors)
  • 说明
    传感器对码结果回调

  • 参数说明

    • nResult - 回复值
    • sensors - 传感器列表,参见item_sensorinfo类。

回复值说明:

回复值 说明
-1 客户端句柄不存在
-2 库未初始化
-3 连接句柄不存在
-4 发送数据失败
-5 接收数据失败
-6 超时
-7 设备端返回的结果有错误
200 成功
203 认证失败
205 设备不支持
409 超时
500 参数错误
501 内部错误

5.3.5.26.3. on_c2d_extSensorRemove(删除传感器回调)
void on_c2d_extSensorRemove(int nResult,
                            int chl_id,
                            java.lang.String sensor_id)
  • 说明
    删除传感器回调

  • 参数说明

    • nResult - 回复值
    • chl_id - 通道号
    • sensor_id - 传感器ID

回复值说明:

回复值 说明
-1 客户端句柄不存在
-2 库未初始化
-3 连接句柄不存在
-4 发送数据失败
-5 接收数据失败
-6 超时
-7 设备端返回的结果有错误
200 成功
203 认证失败
205 设备不支持
409 超时
500 参数错误
501 内部错误

5.3.5.26.4. on_c2d_extSensorSetInfo(设置传感器信息回调)
void on_c2d_extSensorSetInfo(int nResult,
                             item_sensorinfo info)
  • 说明
    设置传感器信息回调

  • 参数说明

回复值说明:

回复值 说明
-1 客户端句柄不存在
-2 库未初始化
-3 连接句柄不存在
-4 发送数据失败
-5 接收数据失败
-6 超时
-7 设备端返回的结果有错误
200 成功
203 认证失败
205 设备不支持
409 超时
500 参数错误
501 内部错误

5.3.5.26.5. on_c2d_extSensorSetSubChlInfo(设置传感器子通道参数回调)
void on_c2d_extSensorSetSubChlInfo(int nResult,
                                   int chl_id,
                                   java.lang.String sensor_id,
                                   int sub_chl_id,
                                   java.lang.String name,
                                   int alarm_linkage)
  • 说明
    设置传感器信息回调

  • 参数说明

    • nResult - 回复值
    • chl_id - 通道号
    • sensor_id - 传感器id
    • sub_chl_id - 子通道编号(从0开始)
    • name - 子通道名称
    • alarm_linkage - 是否报警联动,0=否,1=是

回复值说明:

回复值 说明
-1 客户端句柄不存在
-2 库未初始化
-3 连接句柄不存在
-4 发送数据失败
-5 接收数据失败
-6 超时
-7 设备端返回的结果有错误
200 成功
203 认证失败
205 设备不支持
409 超时
500 参数错误
501 内部错误

5.3.5.26.6. on_c2d_extSensorRemoteControlSwitch(远程控制开关回调)
void on_c2d_extSensorRemoteControlSwitch(int nResult,
                                         int chl_id,
                                         java.lang.String sensor_id,
                                         int sub_chl_id,
                                         int status)
  • 说明
    设置传感器信息回调

  • 参数说明

    • nResult - 回复值
    • chl_id - 通道号
    • sensor_id - 传感器id
    • sub_chl_id - 子通道编号(从0开始),如果指定传感器无子通道,则此参数无意义
    • status - 状态(0=关 1=开 2=停)

回复值说明:

回复值 说明
-1 客户端句柄不存在
-2 库未初始化
-3 连接句柄不存在
-4 发送数据失败
-5 接收数据失败
-6 超时
-7 设备端返回的结果有错误
200 成功
203 认证失败
205 设备不支持
409 超时
500 参数错误
501 内部错误

5.3.6. 推送相关接口

5.3.6.1. push_init(初始化推送)

public int push_init(Context context,
                     java.lang.String svr_ip,
                     int svr_port,
                     java.lang.String user,
                     java.lang.String push_key,
                     java.lang.String push_pass)

5.3.6.2. push_TouchHb(触发一次推送心跳)

public void push_TouchHb()

5.3.6.3. push_uninit(从推送服务器上注销)

public int push_uninit(Context context)

5.3.6.4. setOnC2sVVPushCallback(设置“推送注册/注销回调”侦听器)

public void setOnC2sVVPushCallback(PpviewClientInterface.OnC2sVVPushCallback cb)

5.3.6.5. OnC2sVVPushCallback(“推送注册/注销回调”侦听器)

public static interface PpviewClientInterface.OnC2sVVPushCallback

5.3.6.5.1. on_c2s_pushInitCallBack(初始化推送回调)
void on_c2s_pushInitCallBack(int nResult)
  • 说明
    初始化推送回调

  • 参数说明

    • nResult - 回复值
回复值 说明
-1 客户端句柄不存在
-2 库未初始化
-3 连接句柄不存在
-4 发送数据失败
-5 接收数据失败
-6 超时
-7 设备端返回的结果有错误
200 成功
203 认证失败
500 请求格式错误

5.3.6.5.2. on_c2s_pushUnInitCallBack(注销推送回调)
void on_c2s_pushUnInitCallBack(int nResult)
  • 说明
    注销推送回调

  • 参数说明

    • nResult - 回复值
回复值 说明
-1 客户端句柄不存在
-2 库未初始化
-3 连接句柄不存在
-4 发送数据失败
-5 接收数据失败
-6 超时
-7 设备端返回的结果有错误
200 成功
203 认证失败
500 请求格式错误

5.3.6.6. SetOnS2CPushCallback(设置“推送消息回调”侦听器)

public void SetOnS2CPushCallback(PpviewClientInterface.OnS2CPushCallback cb)

5.3.6.7. OnS2CPushCallback(“推送消息回调”侦听器)

public static interface PpviewClientInterface.OnS2CPushCallback

5.3.6.7.1. on_s2c_dev_status(设备状态变化消息)
void on_s2c_dev_status(java.lang.String devId,
                       int status)
  • 说明
    设备状态变化消息

  • 参数说明

    • devId - 变化的设备ID
    • status - 变化的设备状态 1在线 0离线
  • 相关接口

5.3.6.7.2. on_s2c_dev_list_changed(设备列表发生改变)
void on_s2c_dev_list_changed()

5.3.6.7.3. on_s2c_cam_list_changed(摄像头列表变动消息)
void on_s2c_cam_list_changed(int camSn)
  • 说明
    摄像头列表变动消息(建议重新获取摄像头列表)

  • 参数说明

    • camSn - 摄像头列表的流水号
  • 相关接口

5.3.6.7.4. on_s2c_event(事件推送消息)
void on_s2c_event(EventListItem eventItem)

5.3.6.7.5. on_s2c_cam_alert_status_changed(摄像头布撤防状态发生改变消息)
void on_s2c_cam_alert_status_changed(java.lang.String devId,
                                     java.lang.String camId,
                                     java.lang.String camName,
                                     int status)
  • 说明
    摄像头布撤防状态发生改变消息

  • 参数说明

    • devId - 发生改变的设备ID
    • camId - 发生改变的摄像头ID
    • camName - 发生改变的摄像头名称
    • status - 发生改变的摄像头状态 0-撤防 1-布防
  • 相关接口

5.3.6.7.6. on_s2c_event_pic_uploaded(事件抓图已上传消息)
void on_s2c_cam_alert_status_changed(java.lang.String devId,
                                     java.lang.String camId,
                                     java.lang.String camName,
                                     int status)
  • 说明
    事件抓图已上传消息(缩略图已上传,可以重新获取缩略图)

  • 参数说明

    • event_id - 事件ID
  • 相关接口

5.3.6.7.7. on_s2c_friend_list_changed(好友及黑名单列表变化消息)
void on_s2c_friend_list_changed(int event_type,
                                java.lang.String relation_user,
                                int relation_type)
  • 说明
    好友及黑名单列表变化消息

  • 参数说明

    • event_type - 发生的事件类型 1:添加 2:修改 3:删除
    • relation_user - 发生变化的好友名称
    • relation_type - 变化后的状态 1=好友 2=黑名单
  • 相关接口

5.3.6.7.8. on_s2c_req_cam_share(好友及黑名单列表变化消息)
void on_s2c_req_cam_share(int new_req_num)

5.3.6.7.9. on_s2c_disable_alert_event(取消摄像头正在报警的状态的推送消息)
void on_s2c_disable_alert_event(java.lang.String cam_id)

5.3.6.7.10. on_s2c_disable_low_power(取消摄像头外部传感器低电量状态的推送消息)
void on_s2c_disable_low_power(java.lang.String cam_id)

5.3.6.7.11. on_s2c_cam_private_status_changed(摄像头隐私模式发生改变的推送消息)
void on_s2c_cam_private_status_changed(java.lang.String dev_id,
                                       java.lang.String cam_id,
                                       int chl_id,
                                       int status)
  • 说明
    摄像头隐私模式发生改变的推送消息

  • 参数说明

    • dev_id - 设备ID
    • cam_id - 摄像头ID
    • chl_id - 通道号
    • status - 状态0=关闭 1=开启
  • 相关接口

5.3.6.7.12. on_s2c_dev_binded_by_another_user(此摄像头已被其它用户添加了的推送消息)
void on_s2c_dev_binded_by_another_user(java.lang.String dev_id,
                                       java.lang.String bind_user)
  • 说明
    通过二维码来添加摄像头的返回,此摄像头已被其它用户添加了

  • 参数说明

    • dev_id - 设备ID
    • bind_user - 绑定的用户
  • 相关接口

5.3.6.7.13. on_s2c_dev_binded(通过二维码来添加摄像头的返回,添加成功)
void on_s2c_dev_binded(java.lang.String dev_id)

5.4. vv.playlib.CPlayerEx(远程媒体播放器类)

所属包:vv.playlib.

public class CPlayerEx extends java.lang.Object
  • 说明:
    用于远程播放实时音视频及远程录像回放

  • 构造器

普通摄像头播放器构造函数:

CPlayerEx(Activity mActivity, int index, OnPlayerCallbackListener l)

鱼眼摄像头播放器构造函数:

CPlayerEx(Activity mActivity, int index, OnPlayerCallbackListener l, FishEyeInfo fishInfo)

5.4.1. CPlayerEx(创建播放器)

创建普通摄像头播放器:

CPlayerEx(Activity mActivity, int index, OnPlayerCallbackListener l)

创建鱼眼摄像头播放器:

CPlayerEx(Activity mActivity, int index, OnPlayerCallbackListener l, FishEyeInfo fishInfo)
  • 说明
    创建用于远程实时码流或远程录像回放需要的播放器实例

  • 参数说明

  • 返回
    播放器实例

5.4.2. setPlayMode(设置播放模式)

public void setPlayMode(int mode)
  • 说明
    设置播放模式(在播放前调用)

  • 参数说明

    • mode: - 1=单屏播放模式 4=四屏播放模式
  • 返回

5.4.3. setSurfaceview1(设置单屏播放模式的GLSurfaceView)

public void setSurfaceview1(GLSurfaceView view)
  • 说明
    设置播放模式(在播放前调用)

  • 参数说明

    • view - GLSurfaceView
  • 返回

5.4.4. setSurfaceview4(设置多屏播放模式的GLSurfaceView)

public void setSurfaceview4(GLSurfaceView view)
  • 说明
    设置多屏播放模式的GLSurfaceView(在播放前调用)

  • 参数说明

    • view - GLSurfaceView
  • 返回

5.4.5. getIndex(设置多屏播放模式的GLSurfaceView)

public int getIndex()
  • 说明
    获取当前CPlayerEx的index,index由构造函数传入

  • 参数说明

  • 返回
    当前实例的视频索引号

5.4.6. startPlay(开始实时流媒体播放)

public int startPlay(java.lang.String dev_id,
                     java.lang.String user,
                     java.lang.String pass,
                     int chl_id,
                     int stream_id)
  • 说明
    开始实时流媒体播放

  • 参数说明

    • dev_id - 摄像头所属的设备id
    • user - 设备的用户名
    • pass - 设备的密码
    • chl_id - 摄像头的通道号
    • stream_id - 码流id
  • 返回
    0= 调用成功,播放是否成功在CPlayerEx.OnPlayerCallbackListener中返回
    -1=调用失败

5.4.7. stopPlay(停止实时流媒体播放)

public void stopPlay()

  • 说明 停止实时流媒体播放

5.4.8. startPlayBack(开始远程录像回放)

public int startPlayBack(java.lang.String dev_id,
                         java.lang.String user,
                         java.lang.String pass,
                         int chl_id,
                         java.lang.String startTime)
  • 说明
    开始远程录像回放

  • 参数说明

    • dev_id - 摄像头所属的设备id
    • user - 设备的用户名
    • pass - 设备的密码
    • chl_id - 摄像头的通道号
    • startTime - 始播放时间(格式:yyyyMMddhhmmss),如"20160918123000"
  • 返回
    0= 调用成功,播放是否成功在CPlayerEx.OnPlayerCallbackListener中返回
    -1=调用失败

5.4.9. stopPlayBack(停止远程录像回放)

public void stopPlayBack()
  • 说明 停止远程录像回放

5.4.10. setAudioStatus(设置音频是否开启)

public int setAudioStatus(int status)
  • 说明
    设置音频是否开启(在播放完成,并且初始化音频库后调用)

  • 参数说明

    • status - 0=关闭 1=开启
  • 返回
    0=成功 -1=失败

5.4.11. getCaptureData(截图到内存)

public CCommonParams getCaptureData()
  • 说明
    截图到内存

  • 参数说明

  • 返回
    保存有jpeg图片的数据,其中的data为jpeg文件数据,len为长度,结构参见CCommonParams

5.4.12. getCaptureFile(截图到文件)

public int getCaptureFile(java.lang.String filename)
  • 说明
    截图到文件

  • 参数说明

    • filename - 所要保存的图片的路径和文件名(注:路径文件要先创建好,否则会一直返回-3,而且文件名要带后缀,例:pic.jpg)
  • 返回
    0= 成功
    -1=内存分配失败
    -2=压缩失败
    -3=文件打开失败
    -4=视频没有播放

5.4.13. getFrameUtcTime(获得当前帧的UTC时间)

public long getFrameUtcTime()
  • 说明
    获得当前帧的UTC时间

  • 参数说明

  • 返回
    当前帧的UTC时间

5.4.14. getFrameLocalTime(获得当前帧的本地时间)

public long getFrameLocalTime()
  • 说明
    获得当前帧的UTC本地时间

  • 参数说明

  • 返回
    当前帧的UTC本地时间

5.5. vv.playlib.OnPlayerCallbackListener(媒体播放回调侦听器)

public interface OnPlayerCallbackListener
  • 说明
    媒体播放回调侦听器

  • 方法概要

5.5.1. GetWidthAndHeight(视频宽高回调)

void GetWidthAndHeight(int i,
                       int width,
                       int height)
  • 说明
    视频宽高回调(当播放成功后会受到此回调)

  • 参数说明

    • i - 多路视频播放时的视频索引号(单路视频播放时为0)
    • width - 视频宽度
    • height - 视频高度

5.5.2. OnPlayStatusChanged(视频播放状态改变回调)

void OnPlayStatusChanged(int index,
                         int status,
                         java.lang.String tag,
                         int progress)
  • 说明
    视频播放状态改变回调

  • 参数说明

    • index - 多路视频播放时的视频下标(单路视频播放时为0)
    • status - 当前视频播放状态 1=播放成功 2=正在缓冲 3=缓冲结束 -99=播放过程中数据被断开 其他=播放失败 (2和3只有在远程录像回放时才会出现)
    • tag - 标记,预留
    • progress - 缓冲进度,只有在status=2时才有效

5.5.3. OnCaptureEnable(判断视频是否可以截图回调)

void OnCaptureEnable(int index)
  • 说明
    判断视频是否可以截图回调(播放成功后会调用此回调),收到此回调表示可以截图

  • 参数说明

    • index - 多路视频播放时的视频下标(单路视频播放时为0)

5.5.4. OnAudiosStatusChanged(音频状态回调)

void OnAudiosStatusChanged(int index,
                           int audio_status,
                           int p2ptalk_status,
                           int playHandler,
                           int sendSize)

  • 说明
    音频状态回调(当播放成功后会收到此回调)

  • 参数说明

    • index - 多路视频播放时的视频下标(单路视频播放时为0)
    • audio_status - 音频状态 0:没有音频 1:有音频
    • p2ptalk_status - 已废弃
    • playHandler - 已废弃
    • sendSize - 已废弃

5.6. vv.playlib.VVAudio(远程语音对讲类)

所属包:vv.playlib.

public class VVAudio
extends java.lang.Object

5.6.1. getInstance(获取对讲实例)

public static VVAudio getInstance()
  • 说明
    获取对讲实例,单例模式。

  • 参数说明

  • 返回
    对讲实例

5.6.2. isTalk(判断当前是否正在对讲)

public boolean isTalk()
  • 说明
    判断当前是否正在对讲

  • 参数说明

  • 返回
    true 正在对讲,false没有对讲

5.6.3. setTalkMode(设置当前对讲的播放模式)

public void setTalkMode(int mode)
  • 说明
    设置当前对讲的播放模式

  • 参数说明

    • mode - 对讲模式。

对讲模式

说明
MODE_STARTREC 半双工时,向设备输送语音模式
MODE_STARTPLAY 半双工时,接收设备端语音模式
MODE_RECANDPLAY 全双工模式
  • 返回

5.6.4. VVTalkStart(开始对讲)

public int VVTalkStart(long connector,
                       int chl_id,
                       java.lang.String devusr,
                       java.lang.String devpass)
  • 说明
    开始对讲,是否成功及对讲状态在OnVoiceTalkCallbackListener回调中返回

  • 参数说明

    • connector - P2P连接句柄
    • chl_id - 摄像头通道号
    • devusr - 设备用户名
    • devpass - 设备密码
  • 返回
    0= 调用成功,对讲是否成功及对讲状态在OnVoiceTalkCallbackListener回调中返回
    -1=调用失败

5.6.5. VVTalkStop(停止对讲)

public void VVTalkStop()
  • 说明
    停止对讲

  • 参数说明

  • 返回

5.6.6. VVAudioWrite(将收到的音频数据写入设备音轨)

public void VVAudioWrite(byte[] data,
                         int len)
  • 说明
    将收到的音频数据写入设备音轨 必须在AudioPlayer初始化并且start之后执行

  • 参数说明

    • data - 接收到的设备端发来的音频数据
    • len - 音频数据长度
  • 返回

5.6.7. setVoiceTalkCallback(设置对讲的回调函数)

public void setVoiceTalkCallback(OnVoiceTalkCallbackListener cb)

5.7. vv.playlib.OnVoiceTalkCallbackListener(对讲回调侦听器)

public interface OnVoiceTalkCallbackListener

5.7.1. OnVoiceTalkCallback(开启对讲的返回值回调)

void OnVoiceTalkCallback(int status)
  • 说明
    开启对讲的返回值回调

  • 参数说明

    • status - 回复值

    0 = 成功
    -1 = 客户端句柄不存在
    -2 = 库未初始化
    -3 = 连接句柄不存在
    -4 = 发送数据失败
    -5 = 对讲已开启,不能重复开启
    -6 = 创建音频编码器失败
    -7 = 创建音频解码器失败
    -8 = 中断
    -9 = 超时
    -10 = 数据错误
    -20 = 设备端对讲插件不存在
    -21 = 设备端对讲插件打开失败
    -22 = 开启对讲失败,可能已被别人占用
    414 = 认证失败
    500 = 协议格式错误

5.8. vv.playlib.RecPlayerEx(本地录像回放类)

所属包:vv.playlib.

public class RecPlayerEx
extends java.lang.Object
  • 说明:
    本地录像回放类。用于回放在实时播放过程中录制的本地录像。

  • 相关接口

5.8.1. RecPlayerEx(构造函数)

普通摄像头本地录像播放构造函数

RecPlayerEx(Context context, OnRecPlayerCallback callback, OnPlayerCallbackListener l)

鱼眼摄像头本地录像播放构造函数

RecPlayerEx(Context context, OnRecPlayerCallback callback, OnPlayerCallbackListener l, FishEyeInfo fishEyeInfo) 
  • 说明
    本地录像播放器构造函数

  • 参数说明

    • context - 上下文
    • callback - 每一帧的时间回调(用于定位seekbar)
    • l - 播放状态回调
    • fishEyeInfo - 鱼眼摄像头参数,参见:FishEyeInfo
  • 返回
    本地录像播放器实例

5.8.2. setSurfaceview(设置播放窗口的GLSurfaceView)

public void setSurfaceview(GLSurfaceView view)
  • 说明
    设置播放窗口的GLSurfaceView

  • 参数说明

    • view - GLSurfaceView
  • 返回

5.8.3. startRecPlayer(开始视频回放)

public int startRecPlayer(java.lang.String rec_filename)
  • 说明
    开始视频回放

  • 参数说明

    • rec_filename - 文件名称,包括完整路径
  • 返回

    =0 = 成功开启,返回文件总的秒数(包括音频和视频)
    -1 = 播放器句柄错误
    -2 = 打开文件失败

5.8.4. stopRecplayer(停止本地录像播放)

public void stopRecplayer()
  • 说明
    停止本地录像播放

  • 参数说明

  • 返回

5.8.5. seekRecplayer(定位到某一秒开始回放)

public void seekRecplayer(int sec)
  • 说明
    定位到某一秒开始回放(偏移到多少秒,从0秒开始,到整个录像文件的总时长结束,总时长由startRecPlayer返回)

  • 参数说明

    • sec - 定位到哪一秒
  • 返回

5.8.6. setIsPlayAudio(设置是否开启音频)

public void setIsPlayAudio(boolean status)
  • 说明
    设置是否开启音频

  • 参数说明

    • status - false=关闭 true=打开
  • 返回

5.8.7. setSuspend(设置是否暂停播放)

public void setSuspend(boolean suspend)
  • 说明
    设置是否暂停播放

  • 参数说明

    • suspend - true=暂停播放 false=开始播放
  • 返回

5.8.8. isSuspend(判断当前播放状态)

public boolean isSuspend()
  • 说明
    判断当前播放状态

  • 参数说明

  • 返回
    false = 播放 true = 暂停

5.8.9. getFrameUtcTime(获得当前帧的UTC时间)

public long getFrameUtcTime()
  • 说明
    获得当前帧的UTC时间

  • 参数说明

  • 返回
    当前帧的UTC时间

5.8.10. getFrameLocalTime(获取当前帧的本地时间)

public long getFrameLocalTime()
  • 说明
    获取当前帧的本地时间

  • 参数说明

  • 返回
    当前帧的本地时间

5.9. vv.playlib.OnRecPlayerCallback(本地录像回放回调侦听器)

public interface OnRecPlayerCallback
  • 说明
    本地录像回放回调侦听器

  • 方法概要

5.9.1. onFrameTimeCallback(本地录像回放回调)

void onFrameTimeCallback(int frame_time)
  • 说明
    本地录像回放回调

  • 参数说明

    • frame_time - 当前正在回放的帧的秒数。结合本地录像总时长,可用于更新进度条。

5.10. vv.playlib.FishEyePicEx(鱼眼图片预览器类)

所属包:vv.playlib.

public class FishEyePicEx
extends java.lang.Object
  • 说明: 鱼眼图片预览器类。用于VR模式预览抓取的鱼眼摄像头图片。

5.10.1. FishEyePicEx(鱼眼图片预览器类构造函数)

public FishEyePicEx(Context context,
                    FishEyeInfo fishEyeInfo,
                    java.lang.String filename)
  • 说明
    鱼眼图片预览器类构造函数

  • 参数说明

    • context - 上下文
    • fishEyeInfo - 鱼眼摄像头参数,参见:FishEyeInfo
    • filename - 带完整路径的图片文件名
  • 返回
    鱼眼图片预览器实例

5.10.2. setSurfaceview(设置播放窗口的GLSurfaceView)

public void setSurfaceview(GLSurfaceView view)
  • 说明
    设置播放窗口的GLSurfaceView

  • 参数说明

    • view - GLSurfaceView
  • 返回

5.10.3. startPreviewPic(开始预览鱼眼图片)

public void startPreviewPic()
  • 说明
    开始预览鱼眼图片

  • 参数说明

  • 返回

5.10.4. stopPreviewPic(停止预览鱼眼图片)

public void stopPreviewPic()
  • 说明
    停止预览鱼眼图片

  • 参数说明

  • 返回