威视达康网络摄像机开发包说明.docx
- 文档编号:29029426
- 上传时间:2023-07-20
- 格式:DOCX
- 页数:43
- 大小:30.46KB
威视达康网络摄像机开发包说明.docx
《威视达康网络摄像机开发包说明.docx》由会员分享,可在线阅读,更多相关《威视达康网络摄像机开发包说明.docx(43页珍藏版)》请在冰豆网上搜索。
威视达康网络摄像机开发包说明
HeKaiPCSDK
接口说明
文件状态:
[]草稿
[]正式发布
[√]正在修改
文件标识:
当前版本:
1.0
作者:
jf
完成日期:
2015-08-20
版本/状态
作者
起止日期
备注
1.0
jf
2015-08-14
创建文档、编写SDK接口
1.SDK接口汇总
函数名
功能说明
互联网/局域网
hk_InitVideo
初始化视频回调函数
hk_InitAudio
初始化音频回调函数(监听)
hk_AudioData
设备接收音频数据(对讲)
互联网
sccInitModel
初始化互联网信息回调函数
sccUnInitModel
注销互联网信息回调
sccLogin
用户登录
sccLogOut
注销登录
hk_RegionMonServer
注册监控服务
hk_GetItem
获取互联网设备列表
sccWANCalling
开启互联网视频/监听/对讲
sccWANDevidCalling
通过设备ID与访问密码呼叫视频
sccWANCloseCall
关闭互联网视频/监听/对讲
DoWanAddDev
互联网列表添加设备
DoWanDeleteDev
删除互联网列表数据
DoWanUpdateDevName
修改设备别名
DoRegistrationUser
注册登录用户
SysUpdatePasswd
登录成功后修改用户登录密码
DoSetAccessPswd
修改设备访问密码
局域网
hk_InitLAN
注册局域网回调函数
hk_UnInitLAN
注销退出局域网
hk_LanRefresh
刷新局域网列表
sccLANCalling
开启局域网视频/监听/对讲
sccLANCloseCall
关闭局域网视频/监听/对讲
hk_LanSetNetProxy
设置IR-CUT和互联网地址
GetLanSysInfo
获取设备信息(固定ip/SD卡信息/视频参数/无线IP/移动帧测)
SetLanDevIP
设置局域网有线IP
InitGetWifiSid
初始化wifisid回调函数
DoLanGetWifiSid
获取wifisid列表
SetLanWifi
设置局域网无线IP
SD
hk_InitSdData
初始化视频数据回调
InitSdFile
初始化SDFile
DoLanReadSdData
局域网读取设备SD卡录像文件目录
DoLanDowSdData
局域网下载SD卡文件
DoMonSDReadData
互联网获取SD卡录像文件目录
DoMonDowSdData
下载文件
报警信息
InitAlarmInfo
初始化报警信息回调
DoLocalMonSetAlarmRng
区域报警设置
DoLocalMonFormatSD
格式化SD卡
DoLocalMonSetSdParam
设置SD卡各参数信息.
参数设置
sccSetLANInfo
局域网参数设置
sccSetWANInfo
互联网参数设置
sccGetWANInfo
获取互联网参数(视频参数,SD卡信息...)
2.SDK接口详细说明
2.1数据类型
2.1.1分辨率定义
enumenumVGAMode
{
ENUM_NONE=0,
ENUM_QQ720P=1,/*320*180*/
ENUM_CIF=2,/*352x288*/
ENUM_QVGA=3,/*320x240*/
ENUM_Q720P=4,/*640*360*/
ENUM_VGA=5,/*640x480*/
ENUM_D_ONE=6,/*704x480*/
ENUM_PAL_D1=7,/*704x576*/
ENUM_XVGA=8,/*1024x768*/
ENUM_720P=9,/*1280*720*/
ENUM_SXGA=10,/*1280x1024*/
ENUM_RESOLUTION_ALL,
};
2.1.2设备各设置类型定义
enum_CMD_SET_
{
HK_CMD_SENSITIVITY=101,
HK_CMD_QUALITE=102,
HK_CMD_SHARPNESS=103,
HK_CMD_BRIGHTNESS=104,
HK_CMD_SATURATION=105,
HK_CMD_CONTRAST=106,
HK_CMD_RESTPARAM=107,
HK_CMD_RATE=108,
HK_CMD_IP_INFO=201,//获取有线IP信息
HK_CMD_SD_INFO=202,//获取SD卡配置信息
HK_CMD_VIDEO_INFO=203,//获取视频各参数信息
HK_CMD_WIFI_IP_INTO=204,//获取无线各信息
HK_CMD_GET_SENS=205,//获取报警开关信息
HK_CMD_GET_DEV_TYPE=206,//获取设备类型
HK_CMD_GET_AREA_INFO=207,//获取区域报警信息
HK_CMD_GUTT
};
2.1.3互联网回调下发信息列表
typedefenum
{
HK_REGION_SERVER=101,//注册监控服务(userData,101,1(成功)/2(失败),0)
HK_GET_ITEM=102,//获取用户设备列表(userData,102,buf,len)
HK_ADDDEV_INFO=103,//提交添加设备信息(userData,103,result=%d;Count=%d;DevFlag=%s;audio=%s;devid=%s;alias=%s;,len)
HK_DEV_OLINE=104,//设备上线(userData,104,设备ID,0)
HK_DEV_OFFLINE=108,//设备下线(userData,104,设备ID,0)
HK_GET_SHARE_USER=109,//获取设备分享用户(userData,109,0(没有)/user=%s;popedom=%d,--Count(个数减减))
HK_DEL_SHARE_USER=110,//删除分享用户(userData,110,0(失败)/1(成功),0)
HK_ADD_SHARE_USER=111,//添加分享用户(userData,111,0(失败)/user=%s;popedom=%d(成功),)
HK_UPDATE_DEV_NAME=112,//修改设备别名(userData,112,0(失败)/1(成功),0)
HK_DEL_DEV=113,//删除列表设备(userData,113,0(失败)/1(成功),0)
HK_ADD_MYDEV=114,//添加自己设备(userData,114,0(失败)/1(成功),0)
HK_UPDATE_ACCESSPWD=115,//修改访问密码(userData,115,0(失败)/1(成功),0)
HK_UPDATE_MANAGEMENT_PWD=116,//修改管理密码(userData,116,0(失败)/1(成功),0)
HK_INVITE_DEV_SERVER=105,//呼叫音视频,连接服务。
(userData,105,2/3/4/5/6,0)
HK_INVITE_DEV_VIDEO=106,//呼叫音视频连接数据。
(userData,106,0(失败)/1(成功),0)
}HK_WAN_BACK_INFO;
2.1.4参数设置指定集
enumscc_param
{
SCC_PTZ_UP=1,//云台上
SCC_PTZ_DOWN=2,//云台下
SCC_PTZ_LEFT=3,//云台向左
SCC_PTZ_RIGHT=4,//云台向右
SCC_FOCAL_NEAR=5,//焦聚拉近
SCC_FOCAL_FAR=6,//焦聚拉远
SCC_PTZ_STOP=7,//停止云台,FU,转动
SCC_APERTURE_NEAR=8,//光圈拉近
SCC_APERTURE_FAR=9,//光圈拉远
SCC_PTZ_CRUISE=60,//巡航(intnType值:
1:
云台水平巡航,2:
云台垂直巡航,3:
云台全方位巡航)
SCC_DEV_BRIGHTNESS=50,//亮度设置([163])
SCC_DEV_COLOR=51,//色彩([163])
SCC_DEV_CONTRAST=52,//对比度([163])
SCC_DEV_SATURATION=53,//饱各度([163])
SCC_DEV_STREAM=54,//码流([164096])
SCC_DEV_QUALITY=55,//设置视频质量(1:
好2:
中3:
差)
SCC_DEV_RESOLUTION=56,//修改分辨率(值参考enumVGAMode)
SCC_DEV_FRAMERATE=57,//修改帧率([130])
SCC_DEV_SENSITIVITY=59,//修改报警敏感度([010])
SCC_UPSIDE_DOWN=61,//上下翻转
SCC_HORIZONTALLY=62,//水平翻转
SCC_GET_PRESET=63,//移动到某个预置位[18]
SCC_SET_PRESET=64,//设置某个预置位[18]
SCC_SET_SPEED=65,//设置云台速度[1(慢)10(愉)]
SCC_DEV_EXPOSING=66,//爆光度([163])
SCC_DEV_SHARPNESS=67,//锐度([163])
SCC_DEV_FREQUENCY=70,//频率[50(PAL)60(NTSC)]
SCC_DEV_CBR_VBR=106,//设置[0(CBR)1(VBR)]
SCC_DEFAULT_PARAM=107,//恢复默认视频参数
SCC_FACTORY_SET=109,//恢复出厂设置
SCC_DEV_REBOOT=110,//重启设备
};
2.1.5视频回调参数定义
typedefstructSCC_MideData_v2
{
char*pCallid;//呼叫ID
unsignedintnCID;//通道ID号
char*pDataBuf;//视频数据
unsignedintnSize;//视频数据长度
shortnRes;//分辨率参考enumVGAMode定义
shortnEnType;//编码类型1:
MPEG4;2:
M_JPEG4,5,6:
H264(4,5,都是H264)
shortnfilp;//翻转类型1:
上下翻转;2:
左右翻转;3:
上下左右翻转
shortnFreamType;//帧类型(H264码流)2:
为I帧,其他为P帧
shortfragx;//大数据分包组合(3,2,1)三包数据.
char*next;
unsignedintnTimeStmp;//时间戳把解码显示部分的时间减去帧间隔,不够的用sleep补上
}SCC_MideData;
2.1.6互联网设备信息指令
enumscc_waninfo
{
SCC_WEB_VIDEO_INFO=1,//获取画面信息(分辨率帧率...)
SCC_WEB_SD_INFO=2,//获取SD卡信息
SCC_WEB_WIFI_INFO=3,//获取WiFi配置信息
};
2.2回调函数说明
视频回调函数
函数名
typedefvoid(*HKMIEDDATACALLBACK)(void*userData,SCC_MideData*pMideData);
功能
用于打开视频通道获取视频流数据的回调函数
参数
userData
用户自定义的变量指针
SCC_MideData
视频回调参数
返回值
音频回调函数
函数名
typedefvoid(*HKAUDIODATACALLBACK)(void*userData,unsignedintnCID,char*pDataBuf,intnSize);
功能
用于打开音频通道获取音频流数据的回调函数
参数
userData
用户自定义的变量指针
nCID
pDataBuf
音频数据
nSize
音频数据的大小
返回值
互联网回调函数
函数名
typedefvoid(*HKSYSTEMCALLBACK)(void*userData,intnCmd,char*cBuf,intiLen);
功能
互联网各操作下发消息的回调函数
参数
userData
用户自定义的变量指针
nCmd
参看HK_WAN_BACK_INFO
cBuf
数据包
iLen
数据大小
返回值
局域网回调函数
函数名
typedefvoid(*HKLANCALLBACK)(void*userData,char*devid,char*devType,inthkid,intiCount,intiStatus,char*audioType);
功能
局域网数据回调函数
参数
userData
用户自定义的变量指针
devid
设备ID
devType
设备类型("hkdvr","H264",“MPEG4”...)
hkid
局域网设备唯一标识,呼叫视频的时候要用到
iCount
设备节点数,如设备是hkdvr类型,就有4路8路16路等。
其它类型为0
iStatus
设备状态1,2是设备上线,0下线。
10网络断开
audioType
PCMG726G711G729
返回值
wifi回调函数
函数名
typedefvoid(*HKWIFISIDCALLBACK)(void*userData,char*cBuf,intiLen);
功能
wifi数据回调函数
参数
userData
用户自定义的变量指针
cBuf
数据包
iLen
数据包大小
返回值
SDDATA回调函数
函数名
typedefvoid(*HKMIEDSDCALLBACK)(void*userData,unsignedintnCID,char*pDataBuf,intnSize,shortnRes,shortnEnType,shortnfilp,shortnFreamType);
功能
SDDATA初始化视频数据回调
参数
userData
用户自定义的变量指针
nCID
通道ID号
pDataBuf
数据包
nSize
音频视频数据长度
nRes
分辨率参考enumVGAMode定义
nEnType
编码类型1:
MPEG42:
M_JPEG4,5,6:
H264(4,5,都是H264);音频类型G729—G711-130G726-258PCM-514
nfilp
翻转类型1上下翻转2左右翻转3上下左右翻转
nFreamType
帧类型1为I帧,其他为P帧
返回值
SD回调函数
函数名
typedefvoid(*HKCALLBACKSDFILE)(void*userData,intnCmd,char*cBuf,intiCount);
功能
SD数据回调函数
参数
userData
用户自定义的变量指针
nCmd
cBuf
数据包
iCount
返回值
报警信息提交回调函数
函数名
typedefvoid(*HKCALLBACKALARMINFO)(void*userData,intnCmd,char*cDevid,intiFlag,intilParm);
功能
报警信息提交回调
参数
userData
用户自定义的变量指针
nCmd
cDevid
设备ID
iFlag
intiFlag;==0/移动侦测报警,==1IO报警
ilParm
预留
返回值
互联网设备信息回调函数
函数名
typedefvoid(*HKCALLBACKWANINFO)(void*userData,intnCmd,char*cDevid,char*DataBuff,intilParm);
功能
报警信息提交回调
参数
userData
用户自定义的变量指针
nCmd
参看scc_waninfo
cDevid
设备ID
DataBuff
nCmd=SCC_WEB_VIDEO_INFO
(1)设备画面信息数据包格式
stream=%d;sha=%d;bri=%d;sat=%d;con=%d;rate=%d;enc=%d;sens=%d;iropen=%d;frequency=%d;speed=%d;hue=%d;exposure=%d;
●stream码流设置[162048]
●sha锐度值:
1–63
●bri亮度...
●sat饱合度...
●con对比度...
●rate帧率[130]
●enc分辨率3;5;9
●rate帧率[130]
●sens报警度0-100关闭
●iropenir开关关,开
●frequency50,60,70
●speed云台速度
●hue色彩[163]
●exposure爆光度[163]
nCmd=SCC_WEB_SD_INFO
(2)SD卡信息数据包格式
move=%d;outmove=%d;auto=%d;loopwr=%d;splite=%d;size=%d;use=%d;leftsize=%d;audio=%d;stream=%d;
●move移动报警录像
●outmove输出报警录像
●auto自动录像
●loopwr循环写
●splite分割大小
●sizeSD容量
●use已经使用大小
●audio音频
nCmd=SCC_WEB_SD_INFO(3)设备wifi信息数据包格式
open=%d;ip=%s;mask=%s;wet=%s;dns=%s;mac=%s;flag=%d;sid=%s;satype=%s;keytype=%s;entype=%s;
●open开启关闭无线。
值:
-开始无线,-关闭无线
●sid无线SSID
●satype无线安全类型
●keytypeascii或者hex(一般情况都是空)
●entype加密方式
ilParm
预留
返回值
2.3函数说明
函数名
EXPORTDECL_APIinthk_InitVideo(void*userData,HKMIEDDATACALLBACKmdCallBack);
功能
初始化视频回调函数(互联网和局域网都使用该接口初始化回调函数)
参数
userData
用户自定义的变量指针,可在回调函数中使用
mdCallBack
回调函数指针参看HKMIEDDATACALLBACK
返回值
成功
-1
失败
函数名
EXPORTDECL_APIinthk_InitAudio(void*userData,HKAUDIODATACALLBACKaudioCallBack);
功能
初始化音频(监听)回调函数(互联网和局域网都使用该接口初始化回调函数)
参数
userData
用户自定义的变量指针,可在回调函数中使用
audioCallBack
回调函数指针参看HKAUDIODATACALLBACK
返回值
成功
-1
失败
函数名
EXPORTDECL_APIinthk_AudioData(constchar*cBuf,intiLen,intlParam);
功能
设备接收音频数
参数
cBuf
音频数据
iLen
数据长度
lParam
预留参数
返回值
>=0
成功
-1
失败
函数名
EXPORTDECL_APIintsccInitModel(void*userData,HKSYSTEMCALLBACKFunLogin/*,HKMIEDDATACALLBACKmdCallBack*/);
功能
初始化互联网模块回调函数
参数
userData
用户自定义的变量指针,可在回调函数中使用
FunLogin
回调函数指针参看HKSYSTEMCALLBACK
返回值
>=0
模块加载成功
-1
失败
函数名
EXPORTDECL_APIvoidsccUnInitModel();
功能
注销互联网
参数
返回值
>=0
成功
-1
失败
函数名
EXPORTDECL_APIintsccLogin(char*user,char*psw,char*pHost);
功能
用户登录接口
参数
user
登陆账号
psw
登录密码
pHost
登录地址
备注
回调(*HKSYSTEMCALLBACK)(intnCmd,char*cBuf,intiLen);
nCmd;0成功,1密码错误,3网络不通,14网络断开.
cBuf=NULL,iLen=0;
返回值
>=0
成功
-1
失败
函数名
EXPORTDECL_APIintsccLogOut();
功能
用户登陆注销接口
参数
返回值
>=0
成功
-1
失败
函数名
EXPORTDECL_APIinthk_RegionMonServer();
功能
注
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 威视达康 网络 摄像机 开发 说明