播放 SDK 说明手册
VERSION 1.01
版权所有 侵权必究
1 20
册手明说KDS放播
页共页第
前 言
非常感谢您使用我们公司的产品，我们将竭诚为您提供最好的服务。
本手册可能包含技术上不准确的地方或文字错误。
本手册的内容将做定期的更新，恕不另行通知;更新的内容将会在本手册的新版本
中加入。
我们随时会改进或更新本手册中描述的产品或程序。
2 20
册手明说KDS放播
页共页第
1.
2 3
4
5
目 录
简 介……………………………………………………………………………………………………………4 1.1 概述…………………………………………………………………………………………………………4
版本历史…………………………………………………………………………………………………………5
编程指导…………………………………………………………………………………………………………6 3.1 SDK 接口调用流程…………………………………………………………………………………… 6 数据结构定义………………………………………………………………………………………………….7
4.1 常量定义………………………………………………………………………………………………….7
4.1 数据结构定义 ……………………………………………………………. 错误!未定义书签。
4.2 数据结构定义 ………………………………………………………………………………………….. 7
4.3 数据结构定义 ………………………………………………………………………………………….. 9
4.4 回调函数原型…………………………………………………………………………………………10
4.5 错误消息定义 ……………………………………………………………. 错误!未定义书签。
接口定义……………………………………………………………………………………………………….11
5.1 SDK 初始化……………………………………………………………….. 错误!未定义书签。
5.2 异常消息回调 ……………………………………………………………. 错误!未定义书签。
5.3 设备注册……………………………………………………………………错误!未定义书签。
5.4 实时预览……………………………………………………………………错误!未定义书签。
5.5 预览时相关操作 ………………………………………………………… 错误!未定义书签。
5.6 云台控制……………………………………………………………………错误!未定义书签。
5.7 通用参数配置 ……………………………………………………………. 错误!未定义书签。
5.8 设备搜索……………………………………………………………………错误!未定义书签。
5.9 其它命令……………………………………………………………………错误!未定义书签。
3 20
册手明说KDS放播
页共页第
1. 简 介 1.1 概述
播放SDK是软件开发商在开发我司设备应用时的开发套件。本文档详细描述了开 发包中各个函数实现的功能、接口及其函数之间的调用关系和示例实现。
开发包所包括的文件有:
播放库
IPACPlaySDK.h
头文件
IPACPlayer.lib
Lib 文件
IPACPlayer.dll
接口库
4 20
册手明说KDS放播
页共页第
2 版本历史
日期
版本
修改内容
2012.07
V1.00
5 20
册手明说KDS放播
页共页第
3 编程指导
3.1 SDK 接口调用流程
6 20
册手明说KDS放播
页共页第
4 数据结构定义 4.1 常量定义
4.2 错误码定义
7 20
败失置设对法败钟不非失时序数码体顺参解页媒用入频多调输视//共 页 4第05 R32O0R51R0ER5_OOREREDEVI_OVR__EACMDREIRADTOP_4MYALP_TEN enifed# 误错有没// 005 RORREON_4MYALP_TEN enifed#
频音GEPM种各应适自能器码解，频音列频系音MGCEP有PD没MA // 000102×0 MGCLEPLPDUMAN_OI频DU音A列en系iGfe/d/#
册手明说KDS放播
0009020715x*04201 XNAIM_F9U2B7_GE_CO小RIUDOU大FSAUBen冲if缓ed/d#/# 0101213612127×0 1AU_6321217G_OIDUA enifed#
462.H有私和4G6E2P.JMH准标// 021×0 44G6E2PHJM_型O类EDI码V编en频i音fe/d/# 10型E类MI码TEL编LAIE频FR_视EMAeEpRyTtS型_oeen类di放ifve/d播/#/ 数放播持支大最// 001 STROPPUS_XAM_YALP enifed#
8 20
页共页第
败败失失件败件文失文y误流a流频l错败r合e缩失视v混o压开贝G开E拷示打P/打J位显///5425652O5IETDRLIOUVRM_R_3ER2R_O5OSR2SR2EOE5R_R_PERERMLELOOI_IRCFEFR_T_EGNAN_EDETPLJOUOB_4MYALP_TEN enifed# 应 对别 败不识 失本法 钟版败无 时器失流 体码器码 头媒编码或 件多和解短 文化器化太 有始码始件 没初解初文 / / / / / / / / / / 7 9 8 1 1 1 1 5 5 0 2 5 2 5 N R 5 T W O R C O R R O E N R O R R K E R R R N _ R E O U R E _ C _ E _ R N R D E E I E O L M _ D C I I N A E F T O E D _ _ I H _ K T S E T C I R L I E N E I N H I V F I C _ _ _ _ _ 4 4 4 4 4 M M M M M Y Y Y Y Y A A A L A L L L A L P P P P P _ _ _ _ _ T T T T T E E E E E N N N N N e e e e e n n n n n i i i i i f f f f f e e e e e d d d d d # # # # # 上以3 muitneP口口在接接作此此工用用能使败使只能失能器才流败才码时入失时解件输备，败文流，设失放持放频满量播支播音区音在不在建冲置能统能创缓/设只系只// 521145513516YR51LOY5NRLRORNOT_EORM_ROAD1EPEN1L_PRU5IEUTOFMSSR_U__ETLTEVRORTOVNOA_P_PEFPTSPRUEYUCBS_4MYALP_TEN enifed#
败失w等a存r败件D败缓t失事c失端e存程r作后i内线建d操配建件创分/创文//0/15 9R60O05R58R07RER50O_O5RNRREOREROE_R_WCERYAS_ERRFJ_ODFBEMDOLE_IMEF_T_CANOELRPLCOA_4MYALP_TEN enifed# 册手明说KDS放播 败失码解频音// 505RORRE_OIDUA_CED_4MYALP_TENenifed#
4.3 数据结构定义
9 20
册手明说KDS放播
页共页第
4.4 回调函数原型
10 20
页共页第
;)txetnoCp* diov,DIegasseM TNIU ,troPn DROWD()kcaBllaCgsMdnEeli息F信*关KC相AB取LL获AC时( d件io文v像fe录de放py播t 册手明说KDS放播
5 API 定义
5.1 IPAC_PLAYER_Init
【目的】初始化播放库
【语法】
【描述】
【参数】
【返回值】
5.2 IPAC_PLAYER_Cleanup 【目的】清除播放库
【语法】
【描述】
【参数】
【返回值】
5.3 IPAC_PLAYER_GetPort 【目的】初始化播放器
参数
成员
取值范围
输入/输出
描述
–
返回值
宏定义
描述
1
TRUE
成功
0
FALSE
失败
参数
成员
取值范围
输入/输出
描述
–
返回值
宏定义
描述
1
TRUE
成功
0
FALSE
失败
11 20
页共页第 )diov(punaelC_REYALP_CAPI tni
)diov(tinI_REYALP_CAPI tni 册手程编KDS络网
【语法】
【描述】
【参数】
【返回值】
5.4 IPAC_PLAYER_FreePort 【目的】释放播放器
【语法】
【描述】
【参数】
【返回值】
5.5 IPAC_PLAYER_Play 【目的】开始播放
【语法】
【描述】
【参数】
参数
成员
取值范围
输入/输出
描述
nPort
–
[0, 100]
输入
播放通道号
–
–
输入
播放器句柄
返回值
宏定义
描述
1
TRUE
成功
0
FALSE
失败
参数
成员
取值范围
输入/输出
描述
nPort
–
[0, 100]
输入
播放通道号
返回值
宏定义
描述
1
TRUE
成功
0
FALSE
失败
参数
成员
取值范围
输入/输出
描述
12 20
册手明说KDS放播
)dnWh DNWH,troPn GNOLU(troPteG_REYALP_CAPI tni
页共页第
)troPn GNOLU(yalP_REYALP_CAPI tni
)troPn GNOLU(troPeerF_REYALP_CAPI tni
dnWh
nPort
–
[0, 100]
输入
播放通道号
【返回值】
5.6 IPAC_PLAYER_Stop 【目的】开始播放
【语法】
【描述】
【参数】
【返回值】
5.7 IPAC_PLAYER_StartShearRecord
【目的】播放录像时剪切录像为 MP4 格式 【语法】 【描述】只有在播放录像的情况下才起作用 【参数】
【返回值】
返回值
宏定义
描述
1
TRUE
0
FALSE
失败
参数
成员
取值范围
输入/输出
描述
nPort
–
[0, 100]
输入
播放通道号
返回值
宏定义
描述
1
TRUE
成功
0
FALSE
失败
参数
成员
取值范围
输入/输出
描述
nPort
–
[0, 100]
输入
播放通道号
输入
剪切文件名
返回值
宏定义
描述
1
TRUE
成功
13 20
页共页第
eman_elifdrocer ;)eman_elifdrocer* rahc ,troPn GNOLU(droceRraehStratS_REYALP_CAPI tni
)troPn GNOLU( potS_REYALP_CAPI tni 册手明说KDS放播
0
FALSE
5.8 IPAC_PLAYER_StopShearRecord 【目的】停止播放录像时剪切录像
【语法】
【描述】
【参数】
【返回值】
5.9 IPAC_PLAYER_InputData 【目的】输入一帧数据解码数据播放
【语法】
【描述】
【参数】
【返回值】
参数
成员
取值范围
输入/输出
描述
nPort
–
[0, 100]
输入
播放通道号
返回值
宏定义
描述
1
TRUE
成功
0
FALSE
失败
参数
成员
取值范围
输入/输出
描述
nPort
–
[0, 100]
输入
播放通道号
Buf
输入
播放数据
dwSize
输入
数据大小
返回值
宏定义
描述
1
TRUE
成功
0
FALSE
失败
14 20
页共页第
)eziSwd DROWD,fub ETYBP,troPn GNOLU(ataDtupnI_REYALP_CAPI tni
;)eman_elifdrocer* rahc ,troPn GNOLU(droceRraehStratS_REYALP_CAPI tni 册手明说KDS放播
5.10 IPAC_PLAYER_InputVideoData 【目的】输入一帧视频数据解码数据播放
【语法】
【描述】
【参数】
【返回值】
5.11 IPAC_PLAYER_InputAudioData 【目的】输入一帧音频数据解码数据播放
【语法】
【描述】
【参数】
【返回值】
5.12 IPAC_PLAYER_RefreshPlay 【目的】暂停时刷新显示最后一画面
参数
成员
取值范围
输入/输出
描述
nPort
–
[0, 100]
输入
播放通道号
Buf
输入
播放数据
dwSize
输入
数据大小
返回值
宏定义
描述
1
TRUE
成功
0
FALSE
失败
参数
成员
取值范围
输入/输出
描述
nPort
–
[0, 100]
输入
播放通道号
Buf
输入
播放数据
dwSize
输入
数据大小
返回值
宏定义
描述
1
TRUE
成功
0
FALSE
失败
15 20
页共页第
)eziSwd DROWD,fub ETYBP,troPn GNOLU( ataDoiduAtupnI_REYALP_CAPI tni
)eziSwd DROWD,fub ETYBP,troPn GNOLU(ataDoediVtupnI_REYALP_CAPI tni 册手明说KDS放播
【语法】
【描述】
【参数】
【返回值】
5.13 IPAC_PLAYER_CaptureOnePicture 【目的】抓拍图片
【语法】
【描述】
【参数】
【返回值】
5.14 IPAC_PLAYER_OpenFile 【目的】打开录像文件播放
【语法】
描述】
【参数】
参数
成员
取值范围
输入/输出
描述
nPort
–
[0, 100]
输入
播放通道号
返回值
宏定义
描述
1
成功
0
失败
参数
成员
取值范围
输入/输出
描述
nPort
–
[0, 100]
输入
播放通道号
输入
保存图片路径
返回值
宏定义
描述
1
成功
0
失败
参数
成员
取值范围
输入/输出
描述
16 20
册手明说KDS放播
)troPn GNOL(yalPhserfeR_REYALP_CAPI tni
页共页第
)eman_elif* rahc ,troPn GNOLU(eliFnepO_REYALP_CAPI tni
eman_elif_ni )eman_elif_ni* rahc ,troPn GNOLU(erutciPenOerutpaC_REYALP_CAPI
nPort
–
[0, 100]
输入
播放通道号
输入
播放录像文件
【返回值】
5.15 IPAC_PLAYER_CloseFile 【目的】关闭所打开的录像文件
【语法】
描述】
【参数】
【返回值】
5.16 IPAC_PLAYER_GetStreamFileInfo 【目的】获取文件大小信息
【语法】
描述】
【参数】
【返回值】
返回值
宏定义
描述
1
成功
0
失败
参数
成员
取值范围
输入/输出
描述
nPort
–
[0, 100]
输入
播放通道号
返回值
宏定义
描述
1
成功
0
失败
参数
成员
取值范围
输入/输出
描述
nPort
–
[0, 100]
输入
播放通道号
输出
文件大小
17 20
页共页第
htgneLemiTwd )htgneLemiTwd& DROWD,troPn tni(ofnIeliFmaertSteG_REYALP_CAPI tni
册手明说KDS放播
)troPn GNOLU(eliFesolC_REYALP_CAPI tni eman_elif_ni
返回值
宏定义
描述
1
成功
0
失败
5.17 IPAC_PLAYER_Fast 【目的】快进播放
【语法】
描述】
【参数】
【返回值】
5.18 IPAC_PLAYER_Pause 【目的】暂停播放
【语法】
描述】
【参数】
【返回值】
参数
成员
取值范围
输入/输出
描述
nPort
–
[0, 100]
输入
播放通道号
返回值
宏定义
描述
1
成功
0
失败
参数
成员
取值范围
输入/输出
描述
nPort
–
[0, 100]
输入
播放通道号
返回值
宏定义
描述
1
成功
0
失败
18 20
页共页第
)troPn GNOLU(esuaP_REYALP_CAPI tni
)troPn GNOLU(tsaF_REYALP_CAPI tni 册手明说KDS放播
5.19 IPAC_PLAYER_NextFrame 【目的】单帧播放
【语法】
描述】
【参数】
【返回值】
5.20 IPAC_PLAYER_SetFileEndCallBack 【目的】注册播放文件相关信息
【语法】
描述】
【参数】
【返回值】
参数
成员
取值范围
输入/输出
描述
nPort
–
[0, 100]
输入
播放通道号
返回值
宏定义
描述
1
成功
0
失败
参数
成员
取值范围
输入/输出
描述
nPort
–
[0, 100]
输入
播放通道号
输出
回调函数
输入
上下文
返回值
宏定义
描述
1
成功
0
失败
19 20
页共页第
corPetnxoeDtenloiCFp ,corPenoDeliFp kcaBllaCgsMdnEeliF,troPn GNOLU(kcaBllaCdnEeliFteS_REYALP_CAPI tn)itxetnoCp* diov
)troPn GNOLU(emarFtxeN_REYALP_CAPI tni 册手明说KDS放播
5.21 IPAC_PLAYER_GetSdkVersion
20 20
册手明说KDS放播
页共页第