海康威视播放库sdk编程指南for

SDK版本更 3.1库错误码说 获取库SDK版本号和build号 初始化Direct表面 释放Direct表 打开文件 设置流模式 获取流模式 开 关 快 慢 单帧前进 单帧回退 关闭声音（独占方式） 关闭声音（共享方式） 设置音 获取音 调整WAVE波 设置图像质 获取图像质量 设置参 获取参 设置图像锐化 设置图像Overlay翻转模 设置图像旋转模式 获取文件当前位置（百分比） 获取文件当前时间（毫秒） 获取或信 获取当前帧率 获取原始图像大小 获取当前显示帧的全局时间 设置帧类型 回调 音频回调 文件结束消息 文件结束回调 分辨改变通知消息 设置丢B帧个数 检查帧号是否连 密 设置OVERLAY显示模式及关键 获取当前是否采用OVERLAY显示模 获取OVERLAY关键 刷新显 设置显示模 获取显示模 获取源缓冲区剩余数据大小 后缓冲 源、缓冲 清空所有缓冲区的剩余数据 清空指定缓冲区的剩余数据 获取指定缓冲区的大小 设置建立索引回调 查找指定位置之前的关键帧位置 查找指定位置之后的关键帧位置 获取文件索引 设置文件索引 枚举系统中的显示设备 获取显示设备（显卡）个数 获取指定显卡和监视器信息 图像数据转为BMP格 图像数据转为JPEG格式 直接抓取BMP图像 直接抓取JPEG图像 设置JPEG图像质 抓取选择区域为JPEG格 抓取选择区域为BMP格 画图回 设置数据校 1服务器、IP设备的配套产品的相关的二次开发包，适用于以下编码产品数据流与系列、系列（ATM、车载、环境监测、审讯）网络硬盘机DS-95xx/96xx系列、DS-76xx系列SDKSDK版本号自V6.3.0.0V主版本号.子版本号.修正版本号.修正版本号升级：局部修改，bug yM4_SetSycStartTime, 0123多456789流器的显示部分，主要采用了DirectDraw技术。目前使用了两种方式显示画面：第式使用Off_screen画面，优点：多路可以相对对立，相互间不受影响，缺OVERLAY画面支持硬件的缩放，当第式得不到显卡支持时，使用OVERLAY画面OVERLAY画面处于活动状态，因此同时只能有一路器使用OVERLAY画面，而且如果其他程序正在使用OVERLAY画面，那么器就不能再使用OVERLAY画面了，同样，如果器使用了OVERLAY画面，其他程序也不能再使用OVERLAY画面。而我们在显示这一块的处理，大部分还是需要依靠显卡的BLT功能（硬件缩放，，那么相对的，cpu的利用率就会有所升高。 y) y) 函数： 参数：16build 获取错误 函数： 参数：LONGnPort 返回值：错误码，详见错误码宏定 测试所需系统功 函数： 参

支持DIRECTDRAW；如果不支持，则器不能工作

显卡BLTX显卡BLTYCPU支持SSE指令,InPentium3以上支持SSE指令说明：测试器需要的一些系统功注意：CPU放大缩小，建议将显示窗口的大小设置和图像的大小一致，例如后的图像是352*288（PAL）大小，则建议显示窗口也设置为352*288。初始化Direct表 函数： 参数：HWND 返回值：成功返回TURE；失败返回FALSE 意：1.1版本以上SDK不需要调释放Direct表 函数： 参注意：1.1SDK设置使用的定时器类 函数： 参数： n

#defineTIMER_1#defineTIMER_2低，不推荐在高倍速时使用。TURE 意：必须 获取使用的定时器类 函数： *p参数： DWORD p

获取未使用的通道 函数： 参数：[out]LONG*nPort 返回值：成功返回TURE；失败返回FALSE 明：获取未使用的通道号,通道号的上限为500释放已使用的通道 函数：BOOL 参数：LONG 返回值：成功返回TURE；失败返回FALSE 明：释放已使用的通道号，释放成功后，最好将nPort置为-1打开文 函数： 参数：

意：文件过4GB或小于4KB关闭文 函数： 参数：LONG 设置流模 函数： 参数：

#defineSTREAME_REALTIME0#define STREAME_REALTIME模式（默认） TURE 意：必须在之前设置。2.2以上版本SDK以后可以做暂停，快放，慢放，单帧播 获取流模 函数 参数 返回值：STREAME_REALTIME打开 函数：BOOL DWORDnBufPoolSize)参数：

会导致无法，建议标清设备该值大于等于200*1024，设备大于等于600*1024。TURE关闭 函数： 参数：LONGnPort 返回值：成功返回TURE；失败返回FALSE输入流数 函数： 参数：

返回值：TURE表示已经输入数据。FALSE 明：输入流数据，需要在开启流之后才能输入数据，返回False一般是由于内部缓冲能跳帧或者花屏，如果无法接受，则sleep几毫秒后，再尝试多送几次 函数：BOOL DWORDnBufPoolSize)参数：

设置器中存放数据流的缓冲区大小。范围TURE 明：以音分开输入的方式打开流 函数： 参数：LONG 返回值：成功返回TURE；失败返回FALSE 函数：BOOL yM4_OpenStreamAdvanced(LONGnPort,intnProtocolType,YM4_SESSION_INFO*pstSessionInfo,DWORDnBufPoolSize)参数： #define {

RTSP unsignedchar*}返回值：成功返回TURE

明：该接口是使用非海康40个字节开流，现支持用SDP开输入 函数： 参数：

TURE,表示已经输入数据。FALSE 明：输入流(可以是复合流，但音频数据会被忽略)；打开流之后才能输入数据能跳帧或者花屏，如果无法接受，则sleep几毫秒后，再尝试多送几次输入音频 函参 通道 返回值：TURE,表示已经输入数据。FALSE 明：输入音频流；打开声音之后才能输入数据。返回False是由于内部缓冲区满，建能跳帧或者声音不连续，如果无法接受，则sleep几毫秒后，再尝试多送几次开 函数： 参数：

TURE 明：开始，画面大小将根据hWnd窗口调整，要全屏显示，只要把关 函数： 参数： 暂停/恢 函数： 参数：

明：在非状态下，无法使用暂停。在调用暂停情况下，才能启用恢复。恢复后快 函数：BOOL 参数：LONG 明：每次调用将使当前速度加快一倍，最多调用4次；要恢复正常调慢 函数： 参数：LONG 明：每次调用将使当前速度慢一倍；最多调用4次；要恢复正常调单帧前 函数： 参数：LONG 明：恢复正常需要调 单帧回 函数： 参数：LONG 明：每调用一次一帧。 意：只支持文件，必须在文件索引生成之后才能调以独占方式打开声 函数： 参数： 明：同一时刻只能有一路声音。如果现在已经有声音打开，则自动关闭原来已经打 意：默认情况下声音是关闭的yM4_ySound，yM4_StopSound需要配对调用 yM4_ySound，yM4_ySoundShare不要混用 函数： 参数：无TURE 意 yM4_ySound，yM4_StopSound需要配对调用以共享方式打开声 函数： 参数：LONG TURE 明：以共享方式声音，本路声音而不去关闭其他路 意：WIN98及其之前版本操作系统不支持创建多个声音设备。如果声卡已经被使用yM4_ySoundShare，yM4_StopSoundShare需要配对调用 yM4_ySound，yM4_ySoundShare不要混用 函数： 参数：LONG 明：以共享方式关闭声音 ym4_ySound和 yM4_StopSound是以独占方式 意：在同一个进程中，所有通道必须使用相同的方式或关闭声音yM4_ySoundShare，yM4_StopSoundShare需要配对调用设置音 函数： 参数：

返回值：成功返回TURE 的初始音量。这里的音量是只声卡输出的主音量，会影响到其他应用。获取音 函数： 参数： 返回值：音量值。这里的音量是只声卡输出的主音量，会影响到其他应用调整WAVE波 函数： 参数：LONGLONG

MIN_WAVE_COEF返回值：成功返回TURE 调整WAVE波形，可以改音的大小 设置图像质 函数： 参数：

0为高质量，01TURE 明：当设置成高质量时画面效果好，但CPU利用率高获取图像质 函数： 参数：

1表示高质量，0设置参 函数：BOOL intnContrast,intnSaturation,intnHue)参数：

显示区域，参考yM4_SetDisyRegion；如果只有一个显示区域(通常情况)设为0亮度，默认色调，默认TURE 意：如果全部为默认值将不进行颜色调获取参 函数：BOOL int*pContrast,int*pSaturation,int*pHue)参数： [out]int* [out]int* [out]int* [out]int*

640-128色调，默认640-128返回值：成功返回TURE设置图像锐 函数： 参数：

锐化级别（1～6，0不做锐化，1低级，6高级）TURE 设置图像Overlay翻转模 函数： yM4_SetOverlayFlipMode(LONGnPort,BOOL参数：

TURE 明：早期的版本指overlay表面前缓冲区紧跟着一个或多个建立好的后缓冲区提高显示效率，6.1.0.3以上版本后没有功用。设置图像旋转模 函数： 参数： #define #define #define #define TURE

函数： 参数：

明：设置文件指针的相对位置（百分比 yM4_y之后调用才有效 函数：float yM4_GetyPos(LONGnPort)参数：LONGnPort 返回值：范围0-100% 明：获得文件指针的相对位置 函数： 参数：

TURE 明：根据时间设置文件位 意：如果在建立文件索引的前提下使用,为精确定位,否则即为粗略定 yM4_y之后调用才有 函数： 参数：LONG 返回值：文件当前的时间，单位毫秒 设置文件当前帧 函数： 参数： nFra

明：设置当前位置到指定帧号；根据帧号来定位位置 意：如果在建立文件索引的前提下使用,为精确定位,否则即为粗略定 yM4_y之后调用才有效获取文件当前帧 函数： m(LONG参数：LONG 返回值：当前的帧序号 明：得到当前的帧序号有 去闪 函数： 参数：

TURE说明：设置是否去闪烁功能,原先在静止图像区域有噪声情况下,图像会产生闪烁现获取或信获取文件总时 函数： 参数：LONG 返回值：文件总时间长度，单位秒 意：不支持对正在写入的文件进行时间的获取文件总帧 函数： 参数：LONG 返回值：文件总帧数 意：不支持对正在写入的文件进行帧数的获取当前帧 函数： 参数：LONG 返回值：当前码流中当前编码帧率 获取已时 函数： 参数：LONG 返回值：文件当前时间，单位秒获取已的帧 函数： 参数：LONG 返回值：已经的帧数获取原始图像大 函数： 参数： [out]LONG*

TURE 意：该函数获取的是刚刚那帧数据的长宽，因此只有当开始后才能获取准确 获取文件头长 函数： 参 明：得到当前版本器能的文件的文件头长度。主要应用在流器的STREAME_FILE模式下。以便读出文件头作为 例程(以通道为0的通道为例)： voidStart(){DWORDnLength PBYTEpFileHead newBYTE[nLength];{} yM4_y(0,m_hWnd);delete[]pFileHead;}voidInputData(){BYTE { }}获取当前显示帧的全局时 函数： yM4_GetSpecialData(LONG参数： #defineGET_YEAR(_time_) (((_time_)>>26)+2000)#defineGET_MONTH(_time_) (((_time_)>>22)&15)#defineGET_DAY(_time_) (((_time_)>>17)&31)#defineGET_HOUR(_time_) (((_time_)>>12)&31)#defineGET_MINUTE(_time_) &63)#defineGET_SECOND(_time_) &63) 明：有正常图像显示后才能调用此接设置回调流类 函数： 参数：

1流，2音频流，3复合 明：建议在回调函数前使设置帧类 函数： 参数：

#define 0#define 1#defineDECODE_NONE 2不解帧返回值：成功返回TURE；失败返回FALSE 回调 BOOLyM4_SetDecCallBack(LONGnPort,void(CALLBACK*DecCBFun)(longnPort,char*pBuf,longnSize,FRAME_INFO*pFrameInfo,longn1,longn2))参数： char FRAME_INFO*pFrameInfo ntypedef DWORDdwFra

置为NULL，否则不能为NULL16位表示。 说明：设置回调函数，替换器中的显示部分，由用户自己控制显示，该函数在yM4_y之前调用，在yM4_Stop时自动失效，下次调用yM4_y之前注意：部分不控制速度，只要用户从回调函数中返回，器就会下一部分据。这个功能的使用需要用户对显示和声音有足够的了解，否则请慎重使用，有关知识请参阅directx开发包。 函 (longnPort,char*pBuf,longnSize,FRAME_INFO*pFrameInfo,longnUser,参n2),long char ntypedef

为NULL，否则不能为返回值：成功返回TURE说明：设置回调函数，替换器中的显示部分，由用户自己控制显示，该函数在yM4_y之前调用，在yM4_Stop时自动失效，下次调用yM4_y之前了解，否则请慎重使用，有关知识请参阅directx开发包。回调函数yM4_SetDecCallBack区别在于增加了用户传递参数当前的数据格式为YV12，音频格式为PCM。 函数：BOOLyM4_SetDecCallBackEx(LONGnPort,void(CALLBACK*DecCBFun)(longnPort,char*pBuf,longnSize,FRAME_INFO*pFrameInfo,longn1,longn2),char*pDest,longnDestSize)参数： DecCBFun回调函数参数说 char typedefstruct{longLongnHeightlongnStamplongnTypelong n n

回调函数，若不需要回调函数则置为，TURE 明 yM4_SetDecCallBackEx yM4_SetDecCallBack相比yM4_SetDecCallBackEx会并显示，并将的数据以回调函数的方式给用 yM4_SetDecCallBack仅仅将后的数据给用户，并不显示。其中参数pDestnDestSize没有具体的用处,NULL当前的数据格式为YV12，音频格式为PCM函数：BOOL yM4_SetDecCallBackExMend(LONGnPort,void(CALLBACK*DecCBFun)(longnPort,char*pBuf,longnSize,FRAME_INFO*pFrameInfo,longnUser,longn2),char*pDest,longnDestSize,long参数： DecCBFun回调函数参数说 char typedefstruct{ n

则不能为NULL，TURE 明 yM4_SetDecCallBackExMend yM4_SetDecCallBackMend相比yM4_SetDecCallBackExMend会并显示并将的数据以回调函数的方式 yM4_SetDecCallBackMend仅仅将后的数据给用户，并不显当前的数据格式为YV12，音频格式为PCM音频回 函数：BOOL yM4_SetAudioCallBack(LONGnPort,void(stdcall*funAudio)(longnPort,char*pAudioBuf,longnSize,longnStamp,longnType,longnUser),longnUser)参数： void(stdcall*funAudio)

T_AUDIO16,16khz，单声道，每个采样点16位TURE 意：暂不支文件结束消 函数： 参数：

用户自定义的输入的消息；当到文件结束时用户从hWnd窗口过程中收到这个消息。此消息函数中的ram参数返回nPort的值TURE说明：设置文件结束时要发送的消息；从2.4版本SDK起，当文件完时，线程将不会自动结束，需要用户做停止工作。应用程序在收到这个消息后要调用结束函数yM4_Stop(nPort)注意：文件结束回 函数： 参数： void* void*TURE

明：设置文件结束回调函数在 y4_OpenFile之前调用才 意：关于回调函数。因为vb不支持多线程，所以当回调函数是VB的函数时vcvb详见：KnowledgeBaseArticle-Q198607“PRB:AccessViolationinVBRun-TimeUsingAddressOf、分辨改变通知消 函数： 参数：

此定义的消息。消息函数中的ram参数值是返回nPortTURE 明：设置时编码分辨率发生改变时要发送的消息 意：回调与消息不能同时使用分辨率改变通知回 函数： 参数： longnPortlong

明：需要在打开文件之前使 意：不推荐回调与消息方式同时使设置丢B帧个 函数： 参数：

明：设置 若编码类型中无B帧，则调用此接口无效。检查帧号是否连 函数： m(LONGnPort,BOOL参数： 一个I帧；FALSE：查帧号连续性。如果数据能，则，不直接跳至下一个I帧。TURE 6.1.1.17版本开始支持。密钥 函数：BOOL 参数： char*

密钥长度，单位为bit（18TURE 码。该接口在 设置OVERLAY显示模式及关键 函数： 参数：

其他模式。FALSE则不进行OVERLAY模式的尝试。用一种不常用的颜色作为透明色。这是一个双字节值TURE说明：设置OVERLAYOVERLAY于活动状态，如果此时系统中已经有程序使用了OVERLAY，那么器就不能再们的卡在预览时可能也要使用OVERLAY(用户可设置)，如果先打开器（并且OVERLAYOVERLAY而失败。OVERLAYOVERLAYBLT缺点是：只能有一路器使用。该设置必须在Y之前使用，而且需要设置获取当前是否采用OVERLAY显示模 函数： yM4_GetOverlayMode(LONG参数： 说明：检查当前器是否使用了OVERLAY模获取OVERLAY关键 函数： 参数：LONGnPort 返回值：颜色值设置或增加显示区 函数：BOOL yM4_SetDisyRegion(LONGnPort,DWORDnRegionNum,RECT*pSrcRect,HWNDhDestWnd,BOOLbEnable)参数： RECT

显示区域序号，0~(MAX_DISY_WND-1)(yM4_y中设置的窗口)进行设置，将忽略hDestWnd和bEnable的设置。0，352，288）pSrcRect=NULL,将显示整个TURE 明：设置或增加显示区域。可以做局部放大显示刷新显 函数：BOOL 参数：LONG 返回值：成功返回TURE；失败返回FALSE 函参 返回值：成功返回TURE；失败返回FALSE 明：刷新显示，同 yM4_Refreshy。为支持 y4_SetDisyRegion而增加一个设置显示模 函数： 参数：

DISY_NORMAL正常分辨率数据送显卡显示。DISY_QUARTER1/4分辨率数据送显卡显示。DISY_YC_SCALEYC伸张DISY_NOTEARING无显示效TUREDISY_QUARTER可以减小显卡工作量，从而支持路显示，但画面显示质量有下降。在正常和大画面显示时应该使用DISY_NORMAL。参数nType12获取显示模 函数： 参数： 返回值： Y_NORMAL或 说明：nType获取源缓冲区剩余数据大 函数： 参数： 设置源缓冲区阈值及回调指 函数：BOOL yM4_SetSourceBufCallBack(LONGnPort,DWORDnThreShold,dwUser,void*pResvered),DWORDdwUser,void*p)参数：LONG void p nBufSize dwUser TURE

明：设置源缓冲区阀值和剩余数据小于等于阀值时的回调函数指针。只有在数据量从大到小"越过"指定阈值的时候,才会触发回调; 重置回调标志为有效状 函数： 参数：LONG 明：重置回调标志位为有效状态。后缓冲设置缓冲区最大缓冲帧 函数： 参数：

352*288图像的所需内存最小值是352*288*3/2返回值：成功返回TURE；失败返回FALSE 明： 设置缓冲区（即后的图像缓冲区）大小；这个缓冲区比较重要，直接影响的流畅性和延时性。在一定范围内缓冲越大越流畅，同时延时越大15（帧），在25帧/秒的情况下即0.6秒的数据。在流时我们的默认值 yM4_OpenStream之后、yM4_y之前调用有获取缓冲区最大缓冲帧 函数： 参数：LONG 返回值：缓冲区最大缓冲帧数源、缓冲清空所有缓冲区的剩余数 函数： 参数：LONG 返回值：成功返回TURE；失败返回FALSE清空指定缓冲区的剩余数 函数： 参数：

有效，单位byte。获取指定缓冲区的大小函数： 参数：

有效，单位byte。后节点数（上限BUF__RENDER） byte设置建立索引回调函 yM4_SetFileRefCallBack(LONGnPort,void(stdcall参 void(stdcall*pFileRefDone) 立索引的过程是在完成，需要使用索引的函数要等待这个过程结束，而其他打开文件时是否建立文件的关键帧索引,如果索引回调未触发,表明文件查找指定位置之前的关键帧位置函数：BOOL PFRAME_POSpFramePos)参PFRAME_POS类型说明typedef

TURE说明：查找指定位置之前的关键帧位置。图像必须从关键帧开始，如果用户保存的3帧数据。查找指定位置之后的关键帧位置函数：BOOL PFRAME_POSpFramePos)参数：

如果nType是BY_FRAM则nValue表示帧号，PFRAME_POStypedef

TURE 明：查找指定位置之后的关键帧位置获取文件索 函数： 参数： DWORD*

TURE 明：获取文件索引信息，以便下次打开同一个文件时直接使用这个信息。必须在索引设置文件索 函数： 参数：

TURE 意：索引信息及其长度必须准确，在OpenFile之后调用sdk相关文档“Multiple-MonitorSystems“。枚举系统中的显示设 函数： 参 意：V6.1.1.0版本及以后版本可以不用显式调用该函数函数： 参数：无 意：V6.1.1.0版本及以后版本可以不用显式调用该函数 函数： 参TURE说明：获得系统中与windows桌面绑定的总的显示设备数目（这里主要是指显卡注意：V6.1.1.0设置窗口使用的显示设 函参 函数：BOOL DWORDnDeviceNum)参数：

返回值：成功返回TURE 为支持yM4_SetDisyRegion而增加一个参数。 获取指定显卡和监视器信息函数： DWORDnNameLen,HMONITOR*hhMonitor)参数：DWORD [out]HMONITOR*hhMonitor

lpDriverDescription已分配空间的大小，单位显示设备使用的监视器句柄，通过WindowsAPITURE注意：HMONITOR_WIN32_WINNT>=0x0500时，在“windef.h”头文件中定义，V6.1.1.06.2.0.x版本后不再起作获取指定显示设备的系统信 函数： (DWORD参数：

意：V6.1.1.0版本及以后版本多屏显示可以自适应该接口在6.2.0.x版本后不再起抓图回 函数：BOOL (longnPort,char*pBuf,longnSize,longnWidth,longnHeight,longnStamp,参数： (CALLBACK*Dis char*pBuf TURE

为NULL，否则不能置为NULL yM4_SetDecCallBack宏定义说明：设置抓图回调函数；注意要尽快返回，如果要停止回调，可以把回调函数指针回调在时钟线程中触发不能出现耗时操作否则会打乱时钟脉冲 函数：BOOL yM4_SetDisyCallBackEx(LONGnPort,void(CALLBACK*DisyCBFun)(DISY_INFO*pstDisyInfo),longnUser)参数： DisyCBFun回调函数参数说DISY_INFO*pstDis Y_INFOtypedef{

char*pBuf; }DISTURE

yM4_SetDecCallBack宏定义 明：当前获取到的图像数据类型为YV12格图像数据转为BMP格 函数：BOOL nHeight,longnType,char*sFileName)参数：char* char*

TURE 明：将后数据保存成BMP文件。送入的图像数据必须是YV12数据，可从图像数据转为JPEG格 函数：BOOL yM4_ConvertToJpegFile(char*pBuf,longnSize,longnWidth,longnHeight,longnType,char*sFileName)参数：char* char*TURE

（当前的库获取的类型是 明：将后数据保存成JPEG文件,该函数可在回调函数中使用, 直接抓取BMP图 函数：BOOL DWORD*pBmpSize)参数：

w*h*4，其中wh分别为图像宽高。TURE说明：获取的数据为一帧bmp数据，写成文件即可用浏览工具查直接抓取JPEG图 函数：BOOL DWORD*pJpegSize)参数：

JEPGJPEG图返回值：成功返回TURE说明：获取的数据为一帧JPEG数据，写成文件即可用浏览工具查设置JPEG图像质 函数： 参数： 图像质量,但抓取的图像大小最100:图像质量最好,但抓取的图像大小最大返回值：成功返回TURE；失败返回FALSE 明：设置抓取的JPEG图像质量,设置范围0~100,建议使用75~90,若不调用该函数,则采用默认图像质量,目前默认为80。需要在抓图进行前调用，建议在抓取选择区域为JPEG格式函数： 参数： typedef{

抓图数据 TURE 明：抓取出来的宽高是16的倍

实际大小数据buffer大小多加一个reserve选择区域NULL,抓取选择区域为BMP格 函数： 参数： typedef{ TUR