千眼一平台androidSDK调用文档.docx
- 文档编号:25729136
- 上传时间:2023-06-12
- 格式:DOCX
- 页数:25
- 大小:887.96KB
千眼一平台androidSDK调用文档.docx
《千眼一平台androidSDK调用文档.docx》由会员分享,可在线阅读,更多相关《千眼一平台androidSDK调用文档.docx(25页珍藏版)》请在冰豆网上搜索。
千眼一平台androidSDK调用文档
目录
千眼一平台androidSDK调用文档2
一、androidSDK导入2
1、集成前准备2
2、下载SDK2
3、SDK目录讲解2
4、配置工程2
二、androidSDK基础功能2
1、SDK方法介绍2
2、初始化SDK2
3、登录3
4、获取缩略图4
5、设备上下线、断开连接和报警事件5
6、视频观看功能6
7、IPC列表功能8
8、获取设备能力12
三、视频操控功能13
1、获取画质:
13
2、设置画质:
14
3、获取布防:
14
4、设置布防:
15
5、云台控制:
16
6、翻转设置:
17
7、对讲功能:
18
8、回放功能:
19
千眼一平台androidSDK调用文档
1、androidSDK导入
1、集成前准备
到拾联科技官网注册并创建应用,获取app应用的唯一性key(auth)值
2、下载SDK
到拾联科技官网下载千眼一平台androidSDK,如果您已经下载好了SDK,下面开始学习SDK的集成使用吧!
3、SDK目录讲解
从官网上下载下来的包,解压后内容如下:
在这里主要介绍几个文件夹内容:
doc文件夹:
SDK相关API文档
libs文件夹:
千眼一平台实时视频功能的SDK包和so库
examples文件夹:
QySdkMindDemo(为开发者更深入理解SDK而提供的一个demo)
4、配置工程
在自行开发的应用中,集成千眼一平台SDK需要把libs文件夹下的qysdk_v2.0.1.jar和armeabi目录、armeabi-v7a目录、x86目录导入到你的项目libs文件夹底下。
jar名字后面的v2.0.1可能会跟你下载的不一致,这是版本号,以实际为准。
如果集成过2.0.1之前sdk的开发者,建议更新新版本,新版本有很多的优化,具体请看更新日志。
2、androidSDK基础功能
1、SDK方法介绍
在调用SDK里面的方法时,如果方法对应的参数里面有callback回调,直接调用
2、初始化SDK
建议在application的oncreate()方法中做初始化,通过QYSDK调用InitSDK(intlevel)方法,实现SDK的初始化工作。
参数:
level表示logcat日志级别数值。
0:
不打印日志,1:
错误日志,2:
警告日志,3:
信息日志,4:
调试日志,其它数值的设置都为不打印日志。
3、登录
用户在成功登录App后,要求实现SDK的登录
(1)创建QYSession对象
开发者可在登录界面的oncreate方法中进行QYSession对象的创建,该对象用来实现SDK的登录功能,
参数:
Context上下文环境
注:
本SDK的很多功能都需QYSession对象来调用
(2)设置服务器和端口号
通过QYSession对象的SetServer(Stringip,intport)方法进行服务器和端口号的设置。
参数:
1、ip服务器的域名或地址,2、port端口号。
返回结果:
返回一个int型数值结果ret,该值大于等于0时表示设置成功,小于0时表示设置失败。
(3)SDK登录
连接服务器成功后,通过QYSession对象调用ViewerLogin(Stringappid,Stringauth,OnViewerLogincallback)方法进行登录。
参数:
1、appid为当前应用id,由本司(拾联科技)提供,2、auth,为应用的唯一key,在注册应用时生成,用户通过后端调用
接口生成auth,,再通过调用
接口获得auth;3、callback为请求结果回调函数。
4、获取缩略图
组织架构获取设备通道的缩略图,通过QYSession对象调用GetDeviceCapture(longchannelID,StringsavePath,OnGetDeviceCapturecallback)方法获取缩略图并保存。
参数:
1、channelID为要获取缩略图的设备通道id,2、savePath为缩略图保存位置(例如:
SD卡路径+channelID+.png),3、callback为请求结果回调函数。
5、设备上下线、断开连接和报警事件
通过QYSession对象调用SetEventDelegate(QYSessionDelegatedelegate)方法设置事件通知回调,可以获得设备的上下线和报警事件通知。
参数:
delegate为事件通知回调接口
6、视频观看功能
视频观看功能包括三个部分,创建房间,连接房间,获取观看事件回调,可在同一个方法中实现这三部分。
(1)创建观看房间
通过QYSession对象调用CreateView(longchannelID,OnCreateViewcallback)方法创建观看房间。
参数:
1、channelID,要观看的设备通道号,2、callback请求结果回调函数。
返回结果:
1、ret:
ret>=0表示创建成功,ret<0表示创建失败;2、QYView对象,该对象可用来设置画布,连接观看房间,设置观看事件回调。
(2)连接观看房间,并将视频画面显示在画布上
创建房间成功后,通过返回的的QYView对象调用SetCanvas(SurfaceViewview)方法来设置画布。
并调用StartConnect(finalOnStartConnectcallback)方法来连接观看房间。
参数:
1、SurfaceView对象,2、callback请求回调函数
(3)获取观看事件回调
通过返回的的QYView对象调用SetEventDelegate(QYViewDelegatedelegate)方法,实现观看事件回调,观看事件包括有:
连接断开、声量变化、回放时间戳、视频大小变化、录像事件。
参数:
观看事件回调接口
7、IPC列表功能
获取完IPC列表后,可以将思维盒底下的各个通道与IPC列表进行IP绑定,还可以解除现有的通道绑定,也可以一键解绑该思维盒下的所有通道。
(1)获取IPC列表
首先通过QYSession对象的GetMind()方法获得QYMind对象,通过QYMind对象调用MindGetIpcList(longdeviceID,OnMindGetIpcListcallback)方法获取IPC列表。
参数:
1、deviceID思维盒的id;2、callback请求结果回调。
返回结果:
1、ret>=0:
请求成功;ret<0请求失败;2、存储QYIPCInfo对象的list列表,QYIPCInfo对象,属性有摄像头编号、ip地址、绑定状态(0:
未绑定1:
已绑定(只有获取ipc列表才有用))。
(2)绑定IPC列表
首先通过QYSession对象的GetMind()方法获得QYMind对象,通过QYMind对象调用MindIpcBind(longdeviceID,QYIPCInfoinfo,Stringaccout,Stringpassword,OnMindIpcBindcallback)方法进行IPC绑定。
参数:
1、deviceID通道id;2、QYIPCInfoQYIPCInfo对象,开发者自己实例化并设置相应属性;3、accout用户名,正常请求时可为null,用户鉴权时需要填写具体的用户名;4、pwd密码,正常请求时可为null,用户鉴权时需要填写具体的密码;5、callback请求结果回调。
(3)解除IPC绑定
首先通过QYSession对象的GetMind()方法获得QYMind对象,通过QYMind对象调用MindIpcUBind(longdeviceID,intmode,ArrayList
info,OnMindIpcUBindcallback)方法解除单个通道设备的IPC绑定。
参数:
1、deviceID通道id;2、mode=1:
一键解绑,mode=0解绑指定的ipc;3、存储QYIPCInfo对象的list列表,用户自己创建;4、callback请求结果回调。
(4)一键解绑
首先通过QYSession对象的GetMind()方法获得QYMind对象,通过QYMind对象调用MindIpcUBind(longdeviceID,intmode,ArrayList
参数:
1、deviceID通道id;2、mode=1:
一键解绑,mode=0解绑指定的ipc;3、存储QYIPCInfo对象的list列表,用户自己构建;4、callback请求结果回调。
8、获取设备能力
首先通过QYSession对象的GetSesionEx()获取QYSession的拓展接口,然后通过拓展接口调用GetChanelAbility(longchannelID,OnGetChanelAbilitycallback)方法获取设备的各项能力。
参数:
1、channelID设备id;2、callback回调函数。
返回结果:
1、ret>=0:
请求成功;ret<0请求失败;2、QYChannelAbility对象,包含设备的各个能力属性
注:
设备能力
三、视频操控功能
1、获取画质:
通过QYSession对象调用GetVideoQuality(longchannelID,OnGetVideoQualitycallback)方法获取画质信息。
参数:
1、channelID为视频通道id,2、callback为请求结果回调函数。
回调结果,1、ret大于等于0表示获取成功,小于0表示获取失败,2、整型的cur表示当前视频通道的画质模式,3、list表示当前视频通道的可选画质集合。
List里面的值的范围为0-4(0:
普清,1:
标清,2:
高清,3:
超清)。
2、设置画质:
通过QYSession对象调用SetVideoQuality(longchannelID,intquality,OnSetVideoQualitycallback)方法进行画质设置。
参数:
1、channelID为视频通道id,2、quality为要设置的画质值,3、callback为请求结果回调函数。
3、获取布防:
通过QYSession对象调用GetAlarmConfig(longchannelID,inttype,OnGetAlarmConfigcallback)方法获取设备通道的布防信息。
参数:
1、channelID为视频通道id,2、type为报警类型(0:
移动侦测1:
遮盖报警)手机端全部选0,3、callback请求结果回调函数。
4、设置布防:
通过QYSession对象调用SetAlarmConfig(longchannelID,inttype,QYAlarmConfigconfig,OnSetAlarmConfigcallback)方法来设置视频通道布防状态。
参数:
1、channelID为视频通道id,2、type为报警类型(0:
移动侦测1:
遮盖报警)手机端全部选0,3、config为报警配置信息对象,可以从获取布防的结果返回值获得,也可以自己构造,config通过调用setEnable(intstatues)来改变布防状态,4、callback为请求结果回调函数。
5、云台控制:
在进行视频观看时,可通过创建观看房间返回的QYView对象对摄像头进行云台控制,QYView对象在上文的创建观看房间中已赋值给全局变量qyViewWatch。
QYView对象qyViewWatch调用CtrlPTZ(finalintduration,finalintaction,finalOnCtrlPTZcallback)方法进行云台控制。
参数:
1、duration转速,目前统一设置为0,2、action动作类型,如向上、向下、变倍、回位操作等,3、callback请求结果回调函数。
注:
action动作类型
6、翻转设置:
通过QYSession对象调用SetVideoOrientation(longchannelID,intmode,
OnSetVideoOrientationcallback)方法进行视频画面的翻转设置,
参数:
1、channelID为视频通道id,2、mode为要设置的模式(0:
水平1:
垂直),3、callback为请求结果回调函数。
7、对讲功能:
对讲功能需要创建对讲房间,然后连接对讲房间后才能实现
通过QYSession对象调用CreateTalkHandle(longchannelID,OnCreateViewcallback)方法,创建对讲房间。
参数:
1、channelID为视频通道id,2、callback为请求结果回调函数。
返回结果:
1、ret大于等于0表示获取成功,小于0表示获取失败;2、QYView对象。
用来调用连接对讲房间。
对讲房间创建成功后,需要通过返回的QYView对象调用StartConnect(finalOnStartConnectcallback)方法连接对讲房间,才能开始对讲。
参数:
callback为请求结果回调函数。
8、回放功能:
步骤:
先获取天概要索引;后创建回放观看房间;获取24小时索引;设置观看起始时间,开始观看。
(1)获取天概要索引数据
通过QYSession对象调用GetStoreFileListDayIndex(longchannelID,intyear,intmonth,inttype,OnGetStoreFileListDayIndexcallback)查询天概要索引数据。
参数:
1、channelID为视频通道id,2、year要查询的年份,3、month要查询的月份,4、type查询类型,0从设备获取,1从云存获取2:
从本地,(目前都是0),5、callback为请求结果回调函数。
返回结果:
回调函数返回结果的QYDaysIndex对象存储着当月有哪几天有回放数据的信息,可通过QYDaysIndex.getDays()方法得到当月有哪几天具有回放记录。
(2)创建并连接回放房间
通过QYSession对象调用CreateRePlayHandle(longchannelID,intmode,OnCreateViewcallback)方法创建并连接回放房间。
参数:
1、channelID为视频通道id,2、mode为回放类型0:
设备端1:
云存2:
本地,3、callback为请求结果回调函数。
返回结果:
1、ret大于等于0表示创建成功,小于0表示创建失败;2、QYView对象,用来调用连接回放房间,可存储于全局变量,本文存储与qyApplyWatch。
回放房间创建成功后,用返回的QYView对象调用StartConnect(finalOnStartConnectcallback)连接回放房间。
参数:
callback为连接请求结果回调函数。
(3)获取24小时索引数据
通过创建回放房间返回的QYView对象qyApplyWatch调用GetStoreFileIndex(finalQYDaysIndex.Dayday,finalOnGetStoreFileIndexcallback)方法查询24小时索引数据。
参数:
1、day对象,构建一个Day对象,day设置要查询的年月天;2、callback,请求结果回调函数。
返回结果:
1、ret--大于等于0.表示请求成功,小于0表示请求失败;2、QYTimeIndex对象,调用该对象的getTimes()获得时间块TimeBucket的集合列表,TimeBucket对象通过getStart()和getEnd()获取回放的开始和结束时间戳。
(4)观看回放
通过创建回放房间返回的QYView对象qyApplyWatch调用CtrlReplayTime(finallongtime,finalintctrl,finalOnCtrlReplayTimecallback)方法请求开始播放回放视频。
参数:
1、time开始时间,可由24小时索引获得,时间戳格式;2、ctrl控制模式,0停止1播放;3、callback请求结果回调。
在观看回放的同时可以通过创建回放房间返回的QYView对象qyApplyWatch设置观看回放的回调事件,获得视频播放过程中的音量变化、每一帧时间戳、录像事件、连接断开事件、视频大小变化,可参照前文的视频观看回调事件。
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 千眼一 平台 androidSDK 调用 文档