视频SDK接口定义表.docx
- 文档编号:30751974
- 上传时间:2023-08-20
- 格式:DOCX
- 页数:29
- 大小:24.61KB
视频SDK接口定义表.docx
《视频SDK接口定义表.docx》由会员分享,可在线阅读,更多相关《视频SDK接口定义表.docx(29页珍藏版)》请在冰豆网上搜索。
视频SDK接口定义表
视频开发开发包
功能
初始化SDK
和方中创
HFZC_Startup(intuMessage,HWNDhWnd,BOOLbReadyRelay=FALSE)
uMessage窗口回调消息窗ID
hWnd窗口回调消息窗口句柄
bReadyRelay是否启动转发
海康
BOOL NET_DVR_Init()
返回值:
TRUE表示成功,FALSE表示失败
大华
BOOLCLIENT_Init(
fDisConnectcbDisConnect,
DWORDdwUser
);
参数说明:
断线回调函数,回调出当前网络已经断开的设备,对调用SDK的ClIENT_LogOut()函数主动断开的设备不回调,设置为0时禁止回调
[in]dwUser
用户数据
返回值:
TRUE表示成功,FALSE表示失败
恒亿
BOOLMP4Net_ClientStartup(UINTnMessage,INHWNDhWnd)说明:
对客户端进行初始化,是客户端调用的第一个函数;设置客户端接收到服务器端命令字符串时,向客户端应用程序发送消息的目的窗口和消息ID。
参数:
nMessage:
消息IDhWnd:
消息接收窗口,不使用时可以置为NULL返回:
返回TRUE表示成功,返回FALSE表示失败;
黄河
HHNET_Startup(INHWNDhNotifyWnd,
INUINT nCommandID,
INDWORDdwFrameBufNum=0,
INBOOL bReadyRelay=FALSE,
INBOOL bReadyCenter=FALSE,
INchar *pLocalAddr=NULL);
功能
登陆视频服务器
和方中创
HFZC_Login(char*pszDVRIP,WORDwPort,char*pszUserName’
char*pszPasswordDWORDdwClientID)
海康
NET_DVR_Login_V30
LONGNET_DVR_Login_V30(
char*sDVRIP,
WORDwDVRPort,
char*sUserName,
char*sPassword,
LPNET_DVR_DEVICEINFO_V30lpDeviceInfo
)
参数说明
sDVRIP
[in]设备的IP地址
wDVRPort
[in]设备的埠号
sUserName
[in]登录的用户名
sPassword
[in]密码
lpDeviceInfo
[out]指向NET_DVR_DEVICEINFO_V30结构
返回值
获得的用户ID号
大华
LONGCLIENT_Login(
char*pchDVRIP,
WORDwDVRPort,
char*pchUserName,
char*pchPassword,
LPNET_DEVICEINFOlpDeviceInfo,
int*error=0
);
Parameters
[in]pchDVRIP
设备IP
[in]wDVRPort
设备埠
[in]pchUserName
用户名
[in]pchPassword
用户密码
[out]lpDeviceInfo
设备信息,属于输出参数
[out]error
(当函数返回成功时,该参数的值无意义),返回登录错误码,如下表
恒亿
HANDLEMP4Net_ClientLogin(INchar*sDVRIP,WORDwDVRPort,INchar*sUserName,INchar*sPassword,INchar*mac,OUTLPNET_DVR_DEVICEINFOlpDeviceInfo);说明:
远程登陆前端设备输入参数:
sDVRIP设备的IP地址或者域名(域名最大支持256个字符)wDVRPort设备的通讯端口sUserName设备登陆的用户名(最大支持32个字符)sPassword设备的登陆密码(最大支持16个字符)mac设备的MAC地址(在未获取MAC时可置为NULL,若MAC地址为NULL时,启动主动注册的设备也不会自动重新登录,只有在设备启动了主动注册,且客户端登录时MAC地址有效,才会进行自动登录)输出参数:
lpDeviceInfoDVR/DVS设备信息(此设备信息的获取暂未实现,可置为NULL)返回值:
返回(HANDLE)0xFFFFFFFF表示失败;其它值作为后续函数的参数
黄河
HHNET_LogonServer(INchar*pServerIP,
INUINTnServerPort,
INchar*pDeviceName,
INchar*pUserName,
INchar*pUserPassword,
INDWORDwClientID,
OUTHANDLE&hLogonServer,
INHWNDhNotifyWindow=NULL);
【参数】
参数名称
描述
输入/输出
全局/局部
pServerIP
服务器地址URL(IP、域名)
输入
-
nServerPort
通讯端口号
输入
-
pDeviceName
DVS设备名称(转发时使用)
输入
-
pUserName
登陆DVS使用的用户名
输入
-
pUserPassword
登陆DVS使用的密码
输入
-
wClientID
回调参数(可用做连接号等,如:
当非正常关闭时,应用程序可知道是哪个连接断开了)
输入
-
hLogonServer
登录DVS返回的句柄
输出
-
hNotifyWindow
消息通知的窗口句柄,默认通知窗口为HHNET_Startup函数中hNotifyWnd参数句柄
功能
打开通道预览
和方中创
LONGHFZC_RealPlay(LONGlLoginID,WORDwChannel,
LONGlRealHandle,
)
海康
NET_DVR_RealPlay_V30(可选connect是否在线程中处理)
LONGNET_DVR_RealPlay_V30(
LONGlUserID,
LPNET_DVR_CLIENTINFOlpClientInfo,
void(CALLBACK*fRealDataCallBack_V30)(
LONGlRealHandle,
DWORDdwDataType,
BYTE*pBuffer,
DWORDdwBufSize,
void*pUser
),
void*pUser,
BOOLbBlocked
)
参数说明
lUserID
[in]NET_DVR_Login或者NET_DVR_Login_V30的返回值
lpClientInfo
[in]NET_DVR_CLIENTINFO结构的指针
fRealDataCallBack_V30
[in]视频数据回调函数
dwUser
[in]用户数据
bBlocked
[in]请求视频过程是否阻塞:
0-否;1-是
回调函数参数说明
lRealHandle,
NET_DVR_RealPlay_V30返回值
dwDataType
数据类型
#defineNET_DVR_SYSHEAD
1
系统头数据
#defineNET_DVR_STREAMDATA
2
流数据/视频数据
#defineNET_DVR_AUDIODATA
3
音频资料
pBuffer
存放数据的缓冲区指针
dwBufSize
缓冲区的大小
dwUser
输入的用户数据
返回值
-1表示失败,其它值作为NET_DVR_StopRealPlay等函数的参数
说明
不阻塞:
设备应答请求连接就认为连接成功,如果发生码流接收失败、播放失败等情况以预览异常的方式告知应用层。
在循环播放的时候可以减短停顿的时间。
与原来的NET_DVR_RealPlay功能一致。
阻塞:
直到播放成功才返回成功给应用层。
大华
LONGCLIENT_RealPlayEx(
LONGlLoginID,
intnChannelID,
HWNDhWnd,
RealPlayTyperType
);
Parameters
[in]lLoginID
CLIENT_Login的返回值。
[in]nChannelID
实时监视通道号,如果rType为RType_Multiplay该参数保留。
当rType为RType_Multiplay_1~RType_Multiplay_16时,nChannelID决定了预览的画面,如当RType_Multiplay_4时,通道为4或5或6或7表示预览第5到第7通道的四画面预览。
[in]hWnd
窗口句柄。
值为0(NULL)时对数据不译码不显示图像。
[in]rType
枚举类型,如下表:
枚举类型
意义
DH_RType_RealPlay
实时预览
DH_RType_Multiplay
多画面预览
DH_RType_RealPlay_0
实时监视-主码流,等同于DH_RType_Realplay
DH_RType_RealPlay_1
实时监视-从码流1
DH_RType_RealPlay_2
实时监视-从码流2
DH_RType_RealPlay_3
实时监视-从码流3
DH_RType_Multiplay_1
多画面预览-1画面
DH_RType_Multiplay_4
多画面预览-4画面
DH_RType_Multiplay_8
多画面预览-8画面
DH_RType_Multiplay_9
多画面预览-9画面
DH_RType_Multiplay_16
多画面预览-16画面
ReturnValues
失败返回0,成功返回实时监视ID(实时监视句柄),将作为相关函数的参数.
恒亿
LONGMP4Net_ClientStart(INPCLIENT_VIDEOINFOpClientInfo,INvoid(*ReadDataCallBack)(DWORDdwStockHandle,INUCHAR*pPacketBuffer,DWORDnPacketSize,intFrameType))说明:
启动客户端连接参数:
pClientInfo客户端连接信息结构体ReadDataCallBack函数是网络端口接收到数据的回调函数,客户端用它来读取数据流.如果ReadDataCallBack为NULL,表示不需要读取数据流;ReadDataCallBack函数说明:
dwStockHandle:
连接句柄(MP4Net_ClientStart返回值),可用于区分不同视频预览的回调pPacketBuffer:
压缩数据缓冲区nPacketSize:
压缩数据长度FrameType:
压缩数据帧类型返回:
返回–1表示失败,其它值表示成功并可作为后续操作的参数;
注:
对于软译码方式的连接,如果pClientInfo里的m_hShowVideo为NULL表示只获取音视频数据但不译码和显示;若需要得到音视频数据,则需要将ReadDataCallBack设置为有效函数位址,并需要调用MP4Net_ClientStartCapture启动捕获才能得到音视频数据;
黄河
HHNET_OpenChannel(INchar*pServerIP,
INUINTnServerPort,
INchar*pDeviceName,
INchar*pUserName,
INchar*pUserPassword,
INHHOPEN_CHANNEL_INFO*pOpenInfo,
OUTHANDLE&hOpenChannel,
INHWNDhNotifyWindow=NULL);
功能
停止通道预览
和方中创
HFZC_StopRealPlay(LONGlRealHandle)
海康
NET_DVR_StopRealPlay
BOOLNET_DVR_StopRealPlay(
LONGlRealHandle
)
参数说明
lRealHandle
[in]NET_DVR_RealPlay或者NET_DVR_RealPlay_V30的返回值
返回值
TRUE表示成功,FALSE表示失败。
大华
停止实时监视或多画面预览。
BOOLCLIENT_StopRealPlayEx(
LONGlRealHandle
);
Parameters
[in]lRealHandle
CLIENT_RealPlayEx的返回值。
成功返回TRUE,失败返回FALSE。
恒亿
BOOLMP4Net_ClientStop(LONGStockHandle)说明:
停止客户端图像预览;参数:
StockHandle:
MP4Net_ClientStart成功的返回值;返回:
TRUE表示成功,否则表示失败;
黄河
HHNET_CloseChannel(INHANDLEhOpenChannel);
功能
退出设备登陆
和方中创
HFZC_Logout(LONGlLoginID)
海康
NET_DVR_Logout_V30(强制注销某个用户)
BOOL__stdcallNET_DVR_Logout_V30(
LONGlUserID
)
参数说明
lUserID
[in]NET_DVR_Login或者NET_DVR_Login_V30的返回值
返回值
TRUE表示成功,FALSE表示失败
说明
强制停止该用户的所有操作和释放所有的资源,确保该ID对应的线程都安全退出,资源得到释放。
注意
NET_DVR_Logout_V30会等待或者强制将该用户的所有资源释放或者退出(如线程等),而NET_DVR_Logout则不会,仅仅将当前的用户从设备上注销了
大华
BOOLCLIENT_Logout(
LONGlLoginID
);
[in]lLoginID
CLIENT_Login的返回值。
成功返回TRUE,失败返回FALSE。
恒亿
BOOLMP4Net_ClientLogout(INHANDLE说明:
注销前端DVR/DVS设备输入参数:
hdev设备句柄;MP4Net_返回值:
TRUE表示成功,FALSE表示失败
黄河
HHNET_LogoffServer(INHANDLEhServer);
功能
PTZ控制
和方中创
HFZC_PTZControl(LONGlLoginID,LONGlChannel,
DWORDdwPTZCommand,
DWORDdwPresetIndex
DWORDdwStop)
)
海康
NET_DVR_PTZControl_Other
BOOLNET_DVR_PTZControl_Other(
LONGlUserID,
LONGlChannel,
DWORDdwPTZCommand,
DWORDdwStop
)
参数说明
lUserID
[in]NET_DVR_Login或者NET_DVR_Login_V30的返回值
lChannel
[in]硬盘录像机的信道号
dwPTZCommand
[in]云台控制命令,见上表
dwStop
[in]云台停止动作或开始动作:
0-开始;1-停止。
返回值
TRUE表示成功,FALSE表示失败。
注意
云台的每一个动作都要调用该接口两次,前面三个参数一样,dwStop参数一次取值为0,一次取值为1
NET_DVR_PTZPreset_Other
BOOLNET_DVR_PTZPreset_Other(
LONGlUserID,
LONGlChannel,
DWORDdwPTZPresetCmd,
DWORDdwPresetIndex
)
参数说明
lUserID
[in]NET_DVR_Login或者NET_DVR_Login_V30的返回值
lChannel
[in]硬盘录像机的信道号
dwPTZPresetCmd
[in]云台预置位命令,见上表
dwPresetIndex
[in]预置点的序号,最多支持255个预置点(具体数目和球机有关)
返回值
TRUE表示成功,FALSE表示失败。
大华
BOOLCLIENT_PTZControl(
LONGlLoginID,
intnChannelID,
DWORDdwPTZCommand,
DWORDdwStep,
BOOLdwStop
);
Parameters
[in]lLoginID
CLIENT_Login的返回值
[in]nChannelID
通道号
[in]dwPTZCommand
支持以下云台控制命令
操作类型
功能
PTZ_UP_CONTROL
上
PTZ_DOWN_CONTROL
下
PTZ_LEFT_CONTROL
左
PTZ_RIGHT_CONTROL
右
PTZ_ZOOM_ADD_CONTROL
变倍+
PTZ_ZOOM_DEC_CONTROL
变倍-
PTZ_FOCUS_ADD_CONTROL
调焦+
PTZ_FOCUS_DEC_CONTROL
调焦-
PTZ_APERTURE_ADD_CONTROL
光圈+
PTZ_APERTURE_DEC_CONTROL
光圈-
PTZ_POINT_MOVE_CONTROL
转至预置点
PTZ_POINT_SET_CONTROL
设置
PTZ_POINT_DEL_CONTROL
删除
PTZ_POINT_LOOP_CONTROL
点间轮循
PTZ_LAMP_CONTROL
灯光雨刷
[in]dwStep
步进/速度,范围1~8,8控制效果最明显,操作预置点时dwStep为预置点值.
[in]dwStop
是否停止,对云台八方向操作及镜头操作命令有效,进行其它操作时,本参数应填充FALSE。
ReturnValues
成功返回TRUE,失败返回FALSE.
Remarks
对连接设备进行云台控制,通常的应用是打开监视通道,可以看到画面云台控制的效果,前提是控制云台的DVR的云台控制协议要和云台协议一致才能生效。
恒亿
BOOLMP4Net_ClientPTZControl(INHANDLEhdev,unsignedintuchannel,unsignedintucommand,intiparam1,intiparam2,intiparam3,intiparam4)说明:
远程控制PTZ参数:
hdev:
MP4Net_ClientLogin()函数的返回值uchannel:
通道编号(从0开始)ucommand:
PTZ命令字iparam1:
PTZ命令参数1iparam2:
PTZ命令参数2iparam3:
PTZ命令参数3iparam4:
PTZ命令参数4返回值:
TRUE表示成功,FALSE表示失败
黄河
【语法】
HHNET_SetServerConfig(INHANDLEhServer,
INHHCMD_NETnConfigCommand,
INchar*pConfigBuf,
INUINTnConfigBufSize,
INDWORDdwAppend=0);
【参数】
参数名称
描述
输入/输出
全局/局部
hServer
登录时返回的句柄
输入
-
nConfigCommand
命令
输入
-
pConfigBuf
参数数据缓冲区
输入
-
nConfigBufSize
数据长度
输入
-
dwAppend
通道号或序号(没有序号的设为0)
功能
设置报警:
和方中创
海康
BOOL__stdcallNET_DVR_SetDVRMessageCallBack_V30(
MSGCallBackfMessageCallBack,
void*pUser
);
typedefvoid(CALLBACK*MSGCallBack)(
LONGlCommand,
NET_DVR_ALARMER*pAlarmer,
char*pAlarmInfo,
DWORDdwBufLen,
void*pUser
);
参数说明
fMessageCallBack
[in]回调函数
pUser:
[in]用户数据
回调函数参数说明
lCommand
报警消息类型
pAlarmer
报警设备信息,指向NET_DVR_ALARMER结构
pAlarmInfo
报警信息
dwBufLen
报警信息长度
pUser
输入的用户数据
返回值
TRUE表示成功,FALSE表示失
大华
voidCLIENT_SetDVRMessCallBack(
fMessCallBack cbMessage,
DWORDdwUser
);
Parameters
cbMessage
消息回调
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 视频 SDK 接口 定义