金山云Android播放SDK

Source Type: Binary SDK
Charge Type: free of charge

阅读对象

本文档面向所有使用金山云播放SDK的开发、测试人员等, 要求读者具有一定的Android编程开发经验，并且要求读者具备阅读wiki的习惯。

|||

|||

1.产品概述

金山云播放内核涵盖Android、iOS、Flash和浏览器插件四个平台，基于FFmpeg自主研发音视频媒体播放内核，作为一款全平台兼容的软件播放方案，金山云播放内核提供了跨终端平台的播放器SDK，以及开放的音视频播放、控制接口和完整的开源调用示例，不仅极大降低开发门槛，同时支持客户快速在多个平台发布产品。
KSYMediaPlayer Android SDK是金山云播放内核官方推出的Android平台上使用的软件开发工具包(SDK)，为Android开发者提供简单、快捷的接口，帮助开发者实现Android平台上的多媒体播放应用。

简要说明：

• 金山云播放SDK不限制用户的拉流地址。用户可以只使用金山云直播SDK而不使用金山云的云服务。
• 金山云播放SDK不收取任何授权使用费用(免费使用)，不含任何失效时间或者远程下发关闭的后门。同时金山云播放SDK也不要求ak/sk等鉴权，没有任何用户标识信息。
• 金山云播放SDK同时内建了业内一流的H.265解码能力，适配装载了H.265硬解芯片的设备，H.265能力也是免费使用，欢迎集成使用。
• 金山云播放SDK当前未提供开源代码，如果需要其他定制化开发功能，请通过金山云商务渠道联系。

1.1 版本信息

LICENSE和版本信息：LICENSE

1.2 关于费用

金山云SDK保证，提供的KSYMediaPlayer Android播放SDK可以用于商业应用，不会收取任何SDK使用费用。但是基于KSYMediaPlayer Android播放SDK的其他商业服务，会由特定供应商收取授权费用，大致包括：

1. 云存储
2. CDN分发

2.KSYMediaPlayer SDK 功能说明

• 接口定义与Android系统播放器MediaPlayer保持一致
• 提供KSYTextureView控件
• 支持首屏秒开
• 可设置播放器直播场景下最大缓存时长
• 支持直播追赶(RTMP和HTTP+FLV)，降低主播和观众的延迟
• 支持RTMP和HTTP+FLV直播方式
• 点播库支持多种格式(RMVB、AVI、MKV)
• 支持软解和MediaCodec硬解
• 支持视频旋转(0/90/180/270度)
• 支持播放截图
• 支持视频画面缩放模式
• 支持镜像播放
• 支持获取本地视频信息与视频缩略图
• 支持获取视频原始数据(YUV/RGB)
• 支持获取音频原始数据(PCM)
• KSYMediaPlayer支持多实例
• 支持音量调节，可静音播放
• 支持后台播放
• 支持纯音频播放
• 支持H.265/HEVC播放
• 支持在线查看文档
• 支持反交错功能
• 支持音量放大，最大可以放大两倍
• 支持cache内seek

2.1 播放库版本说明

2.1.1 单独播放SDK

当应用只不用播放功能时，需要单独引用libksyplayer.so。libksyplayer.so在不同目录下，标识为直播库与点播库。

• libs_live目录下的libksyplayer.so为直播SDK
• libs_vod目录下的libksyplayer.so为点播SDK，点播库完整包含直播库所有功能。

支持的文件封装格式和音视频编码标准如下所示：  

信息	直播	点播(完整包含直播所有功能)
流协议	HLS, RTMP, HTTP,HTTPS, FILE	HLS, RTMP, RTSP, HTTP, HTTPS, FILE
封装格式	FLV, TS, MPEG, MOV, M4V, MP3, AAC, GIF, ASF, RM	FLV, TS, MPEG, MOV, M4V, MP3, AAC, GIF, ASF, RM, MKV, AVI, WEBM
视频编码格式	H263, H264, H265, MPEG1, MPEG2, MPEG4, AVS, MJPEG, JPEG2000, GIF	H263, H264, H265, MPEG1, MPEG2, MPEG4, MJPEG, VC-1, WMV, RV40, PNG, JPEG, YUV, WEBP, TIFF, VP*
音频编码格式	AAC, MP3, NELLYMOSER, AMRNB, AMRWB, WMV1, WMV2, WMV3	AAC, MP3, NELLYMOSER, AMRNB, AMRWB, WMV1, WMV2, WMV3, OGG, FLAC, DTS, COOK

点播库包含直播库全部功能，并且额外支持了更多的vod格式。

2.1.2 直播SDK

KSYLive_Android集成了libksyplayer，具有播放SDK直播的所有功能，并且集成了KSYStreamer，具有推流SDK所有功能。

如果使用直播推流、播放功能，请使用KSYLive_Android，无需单独集成libksyplayer。

2.1.3 体系结构

当前播放SDK libksyplayer支持以下体系结构:

• armeabi
• armeabi-v7a
• arm64-v8a
• x86
• x86_64

为了节省apk size，如果没有特殊缘由，请只集成armeabi-v7a版本。

只集成armeabi-v7a版本，会导致ARMv5 ARMv6 设备不能运行。如果APP需要适配这两类设备，需要额外集成armebi版本。 ARMv5 ARMv6 设备计算性能较差，金山云不保证该芯片设备上的直播体验。不推荐直播APP视频适配该两款芯片设备。

具体可参见Wiki SDK集成注意事项

2.2 SDK文档

详情请见wiki

3.下载并使用SDK

3.1 下载SDK

KSYMediaPlayer下载方式：

github下载

• 从github下载：https://github.com/ksvc/KSYMediaPlayer_Android.git

解压缩后包含 demo、doc、README.md 四个部分, 解压后的目录结构如下所示:

• KsyunPlayerDemo/ 目录存放KSY Android Player Demo，用于帮助开发都快速了解如何使用SDK。
• doc/ 目录存放接口参考文档。
• libs_live/ 目录包括直播so库，现提供了Android全部体系结构的支持。
• libs_vod/ 目录包括点播so库，现提供了Android全部体系结构的支持。
• README.md 即本文档。

需要注意的是：KsyunPlayerDemo/playerlib/libs 目录下只有 armeabi-v7a 的直播库，便于用户快速使用KsyunPlayerDemo，用户可根据自身需要将对应平台的动态库放至该目录下即可

直播库与点播库的区别可见链接: https://github.com/ksvc/KSYMediaPlayer_Android/wiki/LiveAndVod

oschina下载

• 从oschina下载：http://git.oschina.net/ksvc/KSYMediaPlayer_Android

对于部分地方访问github比较慢的情况，可以从oschina clone，获取的库内容和github一致。

$ git clone https://git.oschina.net/ksvc/KSYMediaPlayer_Android.git

3.2 注意事项

集成SDK注意事项

3.3 KSYMediaPlayer的使用方法

在上述步骤之后，SDK已经集成至开发工程中，下面将给出KSYMediaPlayer的基本调用示例
KSYMediaPlayer基本调用示例

4.接口说明

请见doc目录下的详细接口说明

5.其他文档

用户如果有疑问，可访问此链接
GitHub WiKi
直播延迟相关设置
本地视频缩略图
重置播放器&重新播放
画面拉伸

6.反馈与建议

6.1 反馈模板

类型	描述
SDK名称	KSYMediaPlayer_android
SDK版本	v2.5.0
设备型号	oppo r9s
OS版本	Android 6.0.1
问题描述	描述问题出现的现象
操作描述	描述经过如何操作出现上述问题
额外附件	文本形式控制台log、crash报告、其他辅助信息（界面截屏或录像等）

6.2 联系方式

• 主页：金山云 
• Issues：https://github.com/ksvc/KSYMediaPlayer_Android/issues