2024年2月12日发(作者:况菀柳)
播放器 SDK 手册产品文档【版权声明】©2013-2017 腾讯云版权所有本文档著作权归腾讯云单独所有,未经腾讯云事先书面许可,任何主体不得以任何形式复制、修改、抄袭、传播全部或部分本文档内容。【商标声明】及其它腾讯云服务相关的商标均为腾讯云计算(北京)有限责任公司及其关联公司所有。本文档涉及的第三方主体的商标,依法由权利人所有。【服务声明】本文档意在向客户介绍腾讯云全部或部分产品、服务的当时的整体概况,部分产品、服务的内容可能有所调整。您所购买的腾讯云产品、服务的种类、服务标准等应由您与腾讯云之间的商业合同约定,除非双方另有约定,否则,腾讯云对本文档内容不做任何明示或模式的承诺或保证。版权所有:腾讯云计算(北京)有限责任公司第2页 共37页
播放器 SDK 手册产品文档文档目录文档声明 ..................................................................................................................................................................................... 2播放器 SDK 手册 ...................................................................................................................................................................... 4点播播放综述
.......................................................................................................................................................................... 4超级播放器 Android
.............................................................................................................................................................. 5超级播放器 iOS
.................................................................................................................................................................... 10超级播放器 Web
.................................................................................................................................................................. 14Web 视频播放器综述
......................................................................................................................................................... 14使用文档
............................................................................................................................................................................ 16开发文档
............................................................................................................................................................................ 31播放器 SDK 下载
.................................................................................................................................................................. 37版权所有:腾讯云计算(北京)有限责任公司第3页 共37页
播放器 SDK 手册产品文档播放器 SDK 手册点播播放综述概述腾讯云点播提供了移动端和 Web 端播放器。开发者可以快速集成,以极为简单的方式播放点播中的视频。特点仅需要视频在点播中的 fileId 即可播放,简单快速。如果视频经过转码,播放器在播放视频时会自动展示出多种清晰度供用户选择(流畅、标清、高清、超清等)。如果视频开启了视频播放控制(视频加密、Referer 防盗链和 Key 防盗链),播放器可以正常支持。场景点播播放器仅用于播放发布在腾讯云点播中的视频,不适用于播放其他平台的视频资源。移动端播放器提供 Android 和 iOS 平台的 SDK,适合在移动端 APP 中集成点播视频的播放功能。Web 端播放器集成在 Web 服务器,用于客户端(PC 和移动端)通过浏览器观看点播视频。(Web播放器尚未发布,敬请期待)版权所有:腾讯云计算(北京)有限责任公司第4页 共37页
播放器 SDK 手册产品文档超级播放器 Android功能介绍超级播放器是基于TXVodPlayer实现的集视频信息拉取、横竖屏切换、清晰度选择、弹幕等功能于一体的解决方案,且完全开源。帮助您在短时间内,打造一个媲美市面上各种流行视频App的播放体验。接入准备1.下载 SDK + Demo 开发包,下载地址为(Android).2.播放器的 UI 部分代码开源,开源代码位于
app/src/main/java/com/tencent/liteav/demo/play/版权所有:腾讯云计算(北京)有限责任公司第5页 共37页
播放器 SDK 手册产品文档文件夹中,图片资源位于app/src/main/res/drawable-xxhdpi/文件夹中,您需要先将这两部分拷贝的您的App工程中。的弹幕集成了第三方开源库DanmakuFlameMaster,可以自行在github获取,也可如Demo在示例配置
compile ':DanmakuFlameMaster:0.5.3'创建播放器超级播放器主类为SuperVideoPlayer,您需求先创建它。mSuperVideoPlayer = (SuperVideoPlayer) findViewById(_player_item_1);eoPlayCallback(mVideoPlayCallback);视频信息获取与播放普通url地址不同,获取视频信息需要通过fileId方式。TXPlayerAuthParams *p = [TXPlayerAuthParams new]; = 1252463788;版权所有:腾讯云计算(北京)有限责任公司第6页 共37页
播放器 SDK 手册产品文档 = @"45649728";TXPlayerAuthBuilder authBuilder = new TXPlayerAuthBuilder();try { Id(nt()); eId(); lay(authBuilder);} catch (NumberFormatException e) { xt(mContext, "请输入正确的AppId", 0).show();}fileId在一般是在视频上传后,由服务器返回:1.客户端视频发布后,服务器会返回fileId到客户端2.服务端视频上传,在确认上传的通知中包含对应的fileId如果文件已存在腾讯云,则可以进入 点播视频管理,找到对应的文件。点开后在右侧视频详情中,可以看到appId和fileId。SDK在请求成功后,将视频信息将以事件的形式通知到上层在Demo中SuperVideoPlayer中示例mTXPlayerGetInfo = new TXVodPlayer(context);Listener(mPlayVodListener);版权所有:腾讯云计算(北京)有限责任公司第7页 共37页
播放器 SDK 手册产品文档Listener(mGetVodInfoListener);/** * 获取fileId对应的视频信息 */private ITXVodPlayListener mGetVodInfoListener = new ITXVodPlayListener() { @Override public void onPlayEvent(TXVodPlayer player, int event, Bundle param) { String playEventLog = "receive event: " + event + ", " +ing(_DESCRIPTION); Log.d(TAG, playEventLog); if (event == _EVT_GET_PLAYINFO_SUCC) { // 获取点播文件信息成功 VodRspData data = new VodRspData(); = ing(_PLAY_COVER_URL); on = (_PLAY_DURATION); = ing(_PLAY_URL); if (mVideoPlayCallback != null) { VideoInfo(data); } } }};切换视频播放器播放另一个视频,调用setPlayUrl即可String url = "/xxx/yyy/4";版权所有:腾讯云计算(北京)有限责任公司第8页 共37页
播放器 SDK 手册产品文档if (mSuperVideoPlayer != null) { UI("新播放的视频"); yUrl(url);}移除播放器当不需要播放器时,调用onDestroy清理播放器内部状态,防止干扰下次播放。if (mSuperVideoPlayer != null) { roy();}版权所有:腾讯云计算(北京)有限责任公司第9页 共37页
播放器 SDK 手册产品文档超级播放器 iOS功能介绍超级播放器是基于TXVodPlayer实现的集视频信息拉取、横竖屏切换、清晰度选择、弹幕等功能于一体的解决方案,且完全开源。帮助您在短时间内,打造一个媲美市面上各种流行视频App的播放体验。接入准备1.下载 SDK + Demo 开发包,下载地址为(iOS)。2.超级播放器的 UI 部分源码开源,开源代码位于Player版权所有:腾讯云计算(北京)有限责任公司第10页 共37页
播放器 SDK 手册产品文档文件夹,图片资源位于Resource/Player文件夹,您需要先将这两部分拷贝的您的App工程中。其它依赖的第三方库您可以自行 Pod 添加或在
Third目录中获取MasonrySDWebImage创建播放器超级播放器主类为ZFPlayerView,您需求先创建它并添加的需要的父View中。_playerView = [[ZFPlayerView alloc] init];[_playerView playerControlView:nil playerModel:Model];// 设置代理_te = self;// 加载成功后自动播放[View autoPlayTheVideo];视频信息获取版权所有:腾讯云计算(北京)有限责任公司第11页 共37页
播放器 SDK 手册产品文档与播放普通url地址不同,获取视频信息需要通过fileId方式。TXPlayerAuthParams *p = [TXPlayerAuthParams new]; = 1252463788; = @"45649728";oPlayer = [[TXVodPlayer alloc] init];[oPlayer setIsAutoPlay:NO];egate = self;[oPlayer startPlayWithParams:p];fileId在一般是在视频上传后,由服务器返回:1.客户端视频发布后,服务器会返回fileId到客户端2.服务端视频上传,在确认上传的通知中包含对应的fileId如果文件已存在腾讯云,则可以进入 点播视频管理,找到对应的文件。点开后在右侧视频详情中,可以看到appId和fileId。SDK在请求成功后,视频信息将以事件的形式通知到上层- (void)onPlayEvent:(TXVodPlayer *)player event:(int)EvtID withParam:(NSDictionary *)param{ if (EvtID == PLAY_EVT_GET_PLAYINFO_SUCC) {版权所有:腾讯云计算(北京)有限责任公司第12页 共37页
播放器 SDK 手册产品文档 ListVideoModel *model = [ListVideoModel new]; = param[EVT_PLAY_COVER_URL]; on = [param[EVT_PLAY_DURATION] intValue]; = param[EVT_PLAY_URL]; }}切换视频播放另一个视频,您需要重新创建一个playerModel,调用resetToPlayNewVideo即可_ = [cell getSource].title;_RL = [NSURL URLWithString:[cell getSource].url];_olderImage = [UIImage imageWithData:[NSData dataWithContentsOfURL: [NSURL URLWithString:[cell getSource].cover]]];[_playerView resetToPlayNewVideo:Model];移除播放器当不需要播放器时,调用resetPlayer清理播放器内部状态,防止干扰下次播放。[View resetPlayer]; //非常重要版权所有:腾讯云计算(北京)有限责任公司第13页 共37页
播放器 SDK 手册产品文档超级播放器 WebWeb 视频播放器综述腾讯云 WEB 视频播放器介绍腾讯云针对不同的业务场景和使用场景,提供了不同的 WEB 视频播放器,分别为:点播超级播放器直播播放器1.0TCPlayer Lite点播播放器1.0下面将对这些播放器进行简要介绍点播超级播放器点播超级播放器是基于 框架并结合腾讯云点播业务而开发的视频播放器,采用以 HTML5
播放器 SDK 手册产品文档TCPlayer Lite独立播放器 TCPlayer Lite 实现了基本的视频播放器功能,采用 HTML5 和 Flash相结合的播放模式,支持播放 hls、mp4 格式的点播视频和 RTMP、http-flv、hls协议的直播视频,支持主要的桌面和移动端浏览器。该播放器仅支持传入地址播放,不关联业务,适用于轻量化 WEB 视频播放场景,支持点播和直播,支持通过CSS 定制化界面。具体介绍请看使用文档点播播放器1.0点播播放器1.0是结合腾讯云点播业务而开发的视频播放器,以 Flash 为主要播放模式,需要浏览器支持并启用Flash 插件。该播放器主要面向比较老旧的浏览器,比如IE8、9、10、11等。由于 Flash 逐步被现代浏览器禁止运行,并且 Flash 将于2020年停止开发和更新,腾讯云点播推出了以HTML5 播放为主的点播超级播放器方案,逐步替换点播播放器1.0。点播播放器1.0具体介绍请看使用文档如何选择播放器通过以上对各个播放器的介绍,了解每种播放器的特点以及适用场景,建议结合所使用的腾讯云业务,以及自身所具备的开发能力来选择合适的 WEB 播放器。如遇到播放问题,请查看常见问题文档版权所有:腾讯云计算(北京)有限责任公司第15页 共37页
播放器 SDK 手册产品文档使用文档前言本文档是介绍腾讯云视频点播服务的 Web 播放器,它可以帮助腾讯云客户通过灵活的接口,快速与自有 Web应用集成,实现视频播放功能,本文档适合有一定 Javascript 语言基础的开发人员阅读。能力介绍腾讯云视频点播 WEB 播放器是通过 HTML5
播放器 SDK 手册产品文档浏览器和手机浏览器的自适应切换,播放器内部会自动区分平台使用最优的播放方案。例如:在 IE11/10/9/8浏览器中会使用 Flash 播放器以实现其不支持 HTML5 播放 HLS 的能力,在 Chrome等现代浏览器中优先使用 HTML5 技术实现视频播放,而手机浏览器上会使用 HTML5 技术实现视频播放。点播平台的转码服务由于 MP4 和 HLS(m3u8)是目前在 PC浏览器和手机浏览器上支持程度最广泛的格式,所以腾讯云的视频点播平台最终会把上传的视频发布为 MP4和 HLS(m3u8) 格式。准备工作step 1:开通服务在 腾讯云官网 注册腾讯云帐号,然后开通点播服务。step 2:上传文件点播服务开通之后,进入 点播视频管理就可以上传新的视频文件,如果您没有开通点播服务,则无法操作这一步骤。step 3:获取 fileID 与 appID上传完视频并转码之后,您就可以在视频管理页面查到文件的 fileID,这个是播放器播放视频的最基本信息,同时您的 appID 也可以在视频管理页面查看到。下图中的两个ID,左边一个是视频文件的 fileID,另一个是您的 appID。版权所有:腾讯云计算(北京)有限责任公司第17页 共37页
播放器 SDK 手册产品文档初始化 Web 播放器在准备工作完成后,通过以下 3 个步骤,您就可以在您的网页上添加一个视频播放器。step 1:在页面中引入文件在合适的地方引入播放器样式文件与脚本文件 注意事项:如果需要在 Chrome Firefox 等现代浏览器中通过 HTML5 播放 hls,需要在 之前引入 。
播放器 SDK 手册产品文档注意事项:播放器容器必须为
播放器 SDK 手册产品文档完整的示例页面:示例代码链接功能使用说明下面将对播放器的部分功能进行详细说明,包括最佳实践与注意事项。播放器尺寸设置这里介绍几种给播放器设置尺寸的方法可以给
播放器 SDK 手册产品文档1、 首先需要在控制台设置转码多种清晰度,如下图2、视频转码后,将会生成多种清晰度的文件,在【控制台】>【视频管理】视频列表中单击视频将会看到如下图经过以上两个步骤,该视频已具备多种清晰度,使用 fileID appID 在腾讯云点播播放器中播放即可。清晰度选择效果如下图:版权所有:腾讯云计算(北京)有限责任公司第21页 共37页
播放器 SDK 手册产品文档注意事项:在浏览器劫持视频播放的情况下,该功能无法使用。通常在移动浏览器中,浏览器会劫持视频播放,用浏览器自带的播放器替代。示例:多种清晰度指定播放清晰度这里分为两种情况:指定播放某个清晰度和让播放器默认播放某个清晰度指定播放某个清晰度通过播放器的 definition 参数指定播放某个清晰度可选值1020版权所有:腾讯云计算(北京)有限责任公司说明MP4 手机MP4 标清第22页 共37页
播放器 SDK 手册产品文档可选值3240说明MP4 高清MP4 超清HLS 手机HLS 标清HLS 高清HLS 超清在下面的示例中,将指定播放 MP4 手机清晰度视频:指定播放清晰度让播放器默认播放某个清晰度在“控制台-Web 播放器管理”选定某个播放器配置进行设置默认画质在“控制台-视频管理”将视频与某个播放器配置进行关联,在使用腾讯云播放器播放该视频时,将会版权所有:腾讯云计算(北京)有限责任公司第23页 共37页
播放器 SDK 手册产品文档使用关联的播放器配置。注意事项:如果默认清晰度的视频不存在,则获取该视频的清晰度列表中第一个文件进行播放。比如播放器配置默认播放超高清,但是视频只有标清和高清,这时会播放标清视频。控制台播放器配置在设置后,大概需要10分钟使所有 CDN 节点生效该配置。在浏览器劫持视频播放的情况下,该功能无法使用。续播功能开启续播功能的前提,必须通过 fileID 播放。有了唯一的 fileID,播放器才能记录该视频的播放时长,当播放未结束时关闭页面,在同一个浏览器中再次打开播放页面,可从上次观看的时间点继续播放。通过以下参数开启续播功能:var player = TCPlayer('player-container-id', { fileID: '', // 请传入需要播放的视频 filID 必须 appID: '', // 请传入点播账号的 appID 必须 plugins:{ ContinuePlay: { // 开启续播功能 // auto: true, //[可选] 是否在视频播放后自动续播 // text:'上次播放至 ', //[可选] 提示文案版权所有:腾讯云计算(北京)有限责任公司第24页 共37页
播放器 SDK 手册产品文档 // btnText: '恢复播放' //[可选] 按钮文案 }, } });开启成功后将会看到的效果如下图:示例:续播注意事项:必须通过 fileID appID 播放经过腾讯云转码后的视频,才能使用该功能。该功能通过通过 localStorage 存储播放时间点,浏览器需支持该特性。在浏览器劫持视频播放的情况下,该功能无法使用。该功能不是多端多浏览器互通的,比如在 PC浏览器上没看完,不能在移动端浏览器上续播或者在 PC上另一个浏览器续播,需额外的接口,可以自行开发。版权所有:腾讯云计算(北京)有限责任公司第25页 共37页
播放器 SDK 手册产品文档设置播放器 logo腾讯云点播播放器支持配置播放器 logo,可以在【控制台】>【Web播放器管理】选定某个播放器配置,单击外观栏目进行设置 logo 信息。设置 logo 信息后,使用该播放器配置播放视频时,将会在指定位置显示 logo。示例:显示 Logo注意事项:控制台播放器配置在设置后,大概需要10分钟使所有 CDN 节点生效该配置。在浏览器劫持视频播放的情况下,设置的 logo 将无法显示。图片贴片功能腾讯云点播播放器支持配置片头、片中暂停、片尾显示图片贴片,并且可以添加超链接。可以在【控制台】>【Web 播放器管理】选定某个播放器配置,单击贴片栏目进行设置贴片信息。默认的贴片显示样式为水平垂直居中显示,如果图片的尺寸大于播放器显示区域,将按播放器的宽度等比缩放图片,水平居中显示图片,图片超出播放器区域部分将无法显示。可以通过 CSS 自定义贴片的显示样式。.tcp-image-patch-start{} /* 片头贴片样式Class */.tcp-image-patch-pause{} /* 片中贴片样式Class */.tcp-image-patch-ended{} /* 片尾贴片样式Class */示例:图片贴片注意事项:版权所有:腾讯云计算(北京)有限责任公司第26页 共37页
播放器 SDK 手册产品文档贴片建议使用体积不超过50KB且尺寸不超过播放器显示区域的图片,避免因图片过大影响视频初始化速度。控制台播放器配置在设置后,大概需要10分钟使所有 CDN 节点生效该配置。在浏览器劫持视频播放的情况下,设置的贴片将无法显示。Referer 防盗链开启流程请看 Referer 防盗链说明文档播放器初始化需增加参数如下:var player = TCPlayer('player-container-id', { fileID: '', // 请传入需要播放的视频filID 必须 appID: '', // 请传入点播账号的appID 必须 flash:{ swf: '//[腾讯云隔离域名]/vod-player/[appID]/[fileID]/tcplayer/' //swf 文件地址 必须 } });需传入 swf url,如果浏览器使用 Flash 播放,将会去这个地址获取 Flash 播放器。Flash播放器发起视频请求时,请求的 Referer 会带上该 url 或者带上页面的 url。注意事项:播放器在 Flash 模式下发起视频请求的 Referer 在 IE、Firefox 浏览器中会带上 swf url,与Chrome 浏览器会带上页面的 url 的情况不同。您也可以将 文件下载后,存放到您的 CDN 服务器中,swf 参数传入指向您的CDN 服务器路径。腾讯云提供的隔离域名是每个用户独有的域名,一个 appID 对应一个域名,通常格式为[appID].。版权所有:腾讯云计算(北京)有限责任公司第27页 共37页
播放器 SDK 手册产品文档需要将播放器 swf url 的域名添加到白名单内,开启了Referer防盗链的视频才能在 Flash模式下播放。播放器的 Flash swf 文件默认存放在 域名下。Key 防盗链开启流程请看 Key 防盗链说明文档播放器初始化需增加参数如下:var player = TCPlayer('player-container-id', { fileID: '', // 请传入需要播放的视频 filID 必须 appID: '', // 请传入点播账号的 appID 必须 t: '', us: '', sign:'' });参数 t、us、sign的具体含义请查看 Key 防盗链说明文档注意事项:sign 的计算方法为:sign = md5(KEY+appId+fileId+t+us),与 Key 防盗链说明文档中的计算方式不同,其余参数一致。如果同时开启了 Referer 防盗链,在 Referer 防盗链配置的示例代码基础上增加参数即可。试看功能版权所有:腾讯云计算(北京)有限责任公司第28页 共37页
播放器 SDK 手册产品文档使用试看功能需要先开启 Key 防盗链,开启流程请看 Key 防盗链说明文档播放器初始化需增加参数如下:var player = TCPlayer('player-container-id', { fileID: '', // 请传入需要播放的视频 filID 必须 appID: '', // 请传入点播账号的 appID 必须 t: '', us: '', sign:'', exper:'' });参数 t、us、sign、exper 的具体含义请查看 Key 防盗链说明文档注意事项:带试看的 sign 计算方法为:sign = md5(KEY+appId+fileId+t+exper+us),与 Key防盗链说明文档中的计算方式不同,其余参数一致。播放器播放的视频时长是 exper 参数指定的长度,与已往在播放端控制播放时长的试看功能不同,播放器不会获取完整的视频。HLS 加密播放开启流程请看视频加密文档注意事项:如果播放页面或者Flash swf url 与解密秘钥服务器域名不一致,Key 服务器需要部署 和 CORS("跨域资源共享" Cross-origin resource sharing),允许 Flash版权所有:腾讯云计算(北京)有限责任公司第29页 共37页
播放器 SDK 手册产品文档和 JavaScript 跨域获取解密秘钥。 中配置的是 swf url 的域名,并且 xml 文件必须放置在 Key服务器的根目录。播放器的 Flash swf 文件默认存放在 域名下。视频只能进行一次加密,不可多次加密,严格按照视频加密文档操作。解密秘钥正确长度为16字节,起始和末尾位置不能有空白字符。版权所有:腾讯云计算(北京)有限责任公司第30页 共37页
播放器 SDK 手册产品文档开发文档前言本文档介绍腾讯云视频点播服务的 Web 播放器的相关参数以及 API,需结合 《使用文档》使用。本文档适合有一定 Javascript 语言基础的开发人员阅读。初始化参数播放器初始化需要传入两个参数,第一个为播放器容器 ID,第二个为功能参数对象。var player = TCPlayer('player-container-id', options);options 参数列表options 对象可配置的参数:名称appIDfileIDwidth类型StringStringString / Number默认值无无无说明必选必选播放器区域宽度,单位像素,按需设置,可通过 CSS控制播放器尺寸。heightString /Number无播放器区域高度,单位像素,按需设置,可通过 CSS控制播放器尺寸。controlsposterautoplayplaybackRatesBooleanStringBooleanArraytrue无false[0.5, 1, 1.25, 1.5, 2]是否显示播放器的控制栏设置封面图片完整地址是否自动播放设置变速播放倍率选项,仅H5 有效loopmutedBooleanBooleanfalsefalse是否循环播放是否静音播放第31页 共37页版权所有:腾讯云计算(北京)有限责任公司
播放器 SDK 手册产品文档名称preload类型String默认值auto说明是否需要预加载,有 3 个属性"auto","meta","none" ,移动端由于系统限制,设置 auto 无效。swfString无Flash 播放器 swf 文件的URLposterImagebigPlayButtonBooleanBooleantruetrue是否显示封面是否显示居中的播放按钮(浏览器劫持嵌入的播放按钮无法去除)languagelanguagescontrolBarStringObjectObject"zh-CN"无无设置语言设置多语言词典设置控制栏属性的参数组合,后面有详细介绍pluginsObject无设置插件功能属性的参数组合,后面有详细介绍controlBar 参数列表controlBar 参数可以配置播放器控制栏的功能,支持的属性有:名称playToggle类型Boolean默认值true说明是否显示播放、暂停切换按钮progressControlvolumePanelcurrentTimeDisplaydurationDisplaytimeDividerBooleanBooleanBooleanBooleanBooleantruetruetruetruetruetrue是否显示播放进度条是否显示音量控制是否显示视频当前时间是否显示视频时长是否显示时间分割符是否显示播放速率选择按钮playbackRateMenuButtoBooleannfullscreenToggleBooleantruetrue是否显示全屏按钮是否显示清晰度切换菜单QualitySwitcherMenuButBooleanton版权所有:腾讯云计算(北京)有限责任公司第32页 共37页
播放器 SDK 手册产品文档plugins 插件参数列表plugins 参数可以配置播放器插件的功能,支持的属性有:名称ContinuePlay类型Object默认值无说明控制续播功能,支持的属性如下auto: false, //是否在播放时自动续播text: '上次看到 ', //提示文案btnText: '恢复播放' //按钮文案对象方法初始化播放器返回对象的方法列表:名称ready(function)参数及类型(Function)返回值及类型无说明设置播放器初始化完成后的回调play()pause()currentTime(seconds)无无(Number)无无(Number)播放以及恢复播放暂停播放获取当前播放时间点,或者设置播放时间点,该时间点不能超过视频时长duration()volume(percent)poster(src)requestFullscreen()exitFullscreen()isFullscreen()on(type,listerner)无(Number)[0,1][可选](String)无无无(String, Function)(Number)获取视频时长(Number) / 设置时无返回获取或设置播放器音量(String) / 设置时无返回无无Boolean无获取或设置播放器封面进入全屏模式退出全屏模式返回是否进入了全屏模式监听事件第33页 共37页版权所有:腾讯云计算(北京)有限责任公司
播放器 SDK 手册产品文档名称one(type,listerner)参数及类型(String, Function)返回值及类型无说明监听事件,事件处理函数最多只执行 1 次off(type,listerner)buffered()bufferedPercent()(String, Function)无无无TimeRanges值范围[0,1]解绑事件监听返回视频缓冲区间返回缓冲长度占视频时长的百分比width()(Number)[可选](Number) / 设置时无返回获取或设置播放器区域宽度,如果通过 CSS 设置播放器尺寸,该方法将无效height()(Number)[可选](Number) / 设置时无返回获取或设置播放器区域高度,如果通过 CSS 设置播放器尺寸,该方法将无效videoWidth()videoHeight()dispose()无无无(Number)(Number)无获取视频分辨率的宽度获取视频分辨率的高度销毁播放器注意事项:部分方法不能同步调用事件播放器可以通过初始化返回的对象进行事件监听,示例:var player = TCPlayer('player-container-id', options);(type, function);其中 type 为事件类型,支持的事件有:版权所有:腾讯云计算(北京)有限责任公司第34页 共37页
播放器 SDK 手册产品文档名称play介绍已经开始播放,调用 play() 方法或者设置了 autuplay为 true 且生效时触发,这时 paused 属性为 falseplaying因缓冲而暂停或停止后恢复播放时触发,paused属性为 false。通常用这个事件来标记视频真正播放,play事件只是开始播放,画面并没有开始渲染loadstartdurationchangeloadedmetadataloadeddata开始加载数据时触发视频的时长数据发生变化时触发已加载视频的 metadata当前帧的数据已加载,但没有足够的数据来播放视频的下一帧时,触发该事件progresscanplaycanplaythrough在获取到媒体数据时触发当播放器能够开始播放视频时触发当播放器预计能够在不停下来进行缓冲的情况下持续播放指定的视频时触发errorpauseratechangeseekedseekingtimeupdate视频播放出现错误时触发暂停时触发播放速率变更时触发搜寻指定播放位置结束时触发搜寻指定播放位置开始时触发当前播放位置有变更,可以理解为 currentTime有变更volumechangewaitingended设置音量或者 muted 属性值变更时触发播放停止,下一帧内容不可用时触发视频播放已结束时触发。此时 currentTime值等于媒体资源最大值resolutionswitchingresolutionswitched清晰度切换进行中清晰度切换完毕错误码当播放器触发 error 事件时,监听函数会返回错误码。错误码列表:版权所有:腾讯云计算(北京)有限责任公司第35页 共37页
播放器 SDK 手册产品文档名称-1-213介绍没有视频地址获取视频数据超时视频加载播放被中断由于网络问题造成加载视频失败解码时发生错误视频因格式不支持或者服务器或网络的问题无法加载解密时发生错误点播服务接口请求超时点播服务接口没有响应点播服务接口返回异常数据点播视频没有转码,需在点播控制台进行转码版权所有:腾讯云计算(北京)有限责任公司第36页 共37页
播放器 SDK 手册产品文档播放器 SDK 下载概述目前,腾讯云点播为客户端提供了Android,iOS 和 Web 三种客户端 SDK。Android SDK视频播放SDK 下载地址iOS SDK视频播放SDK 下载地址Web SDK视频播放Web SDK不需要下载,直接在页面中引入js即可,详情请见以上链接版权所有:腾讯云计算(北京)有限责任公司第37页 共37页
2024年2月12日发(作者:况菀柳)
播放器 SDK 手册产品文档【版权声明】©2013-2017 腾讯云版权所有本文档著作权归腾讯云单独所有,未经腾讯云事先书面许可,任何主体不得以任何形式复制、修改、抄袭、传播全部或部分本文档内容。【商标声明】及其它腾讯云服务相关的商标均为腾讯云计算(北京)有限责任公司及其关联公司所有。本文档涉及的第三方主体的商标,依法由权利人所有。【服务声明】本文档意在向客户介绍腾讯云全部或部分产品、服务的当时的整体概况,部分产品、服务的内容可能有所调整。您所购买的腾讯云产品、服务的种类、服务标准等应由您与腾讯云之间的商业合同约定,除非双方另有约定,否则,腾讯云对本文档内容不做任何明示或模式的承诺或保证。版权所有:腾讯云计算(北京)有限责任公司第2页 共37页
播放器 SDK 手册产品文档文档目录文档声明 ..................................................................................................................................................................................... 2播放器 SDK 手册 ...................................................................................................................................................................... 4点播播放综述
.......................................................................................................................................................................... 4超级播放器 Android
.............................................................................................................................................................. 5超级播放器 iOS
.................................................................................................................................................................... 10超级播放器 Web
.................................................................................................................................................................. 14Web 视频播放器综述
......................................................................................................................................................... 14使用文档
............................................................................................................................................................................ 16开发文档
............................................................................................................................................................................ 31播放器 SDK 下载
.................................................................................................................................................................. 37版权所有:腾讯云计算(北京)有限责任公司第3页 共37页
播放器 SDK 手册产品文档播放器 SDK 手册点播播放综述概述腾讯云点播提供了移动端和 Web 端播放器。开发者可以快速集成,以极为简单的方式播放点播中的视频。特点仅需要视频在点播中的 fileId 即可播放,简单快速。如果视频经过转码,播放器在播放视频时会自动展示出多种清晰度供用户选择(流畅、标清、高清、超清等)。如果视频开启了视频播放控制(视频加密、Referer 防盗链和 Key 防盗链),播放器可以正常支持。场景点播播放器仅用于播放发布在腾讯云点播中的视频,不适用于播放其他平台的视频资源。移动端播放器提供 Android 和 iOS 平台的 SDK,适合在移动端 APP 中集成点播视频的播放功能。Web 端播放器集成在 Web 服务器,用于客户端(PC 和移动端)通过浏览器观看点播视频。(Web播放器尚未发布,敬请期待)版权所有:腾讯云计算(北京)有限责任公司第4页 共37页
播放器 SDK 手册产品文档超级播放器 Android功能介绍超级播放器是基于TXVodPlayer实现的集视频信息拉取、横竖屏切换、清晰度选择、弹幕等功能于一体的解决方案,且完全开源。帮助您在短时间内,打造一个媲美市面上各种流行视频App的播放体验。接入准备1.下载 SDK + Demo 开发包,下载地址为(Android).2.播放器的 UI 部分代码开源,开源代码位于
app/src/main/java/com/tencent/liteav/demo/play/版权所有:腾讯云计算(北京)有限责任公司第5页 共37页
播放器 SDK 手册产品文档文件夹中,图片资源位于app/src/main/res/drawable-xxhdpi/文件夹中,您需要先将这两部分拷贝的您的App工程中。的弹幕集成了第三方开源库DanmakuFlameMaster,可以自行在github获取,也可如Demo在示例配置
compile ':DanmakuFlameMaster:0.5.3'创建播放器超级播放器主类为SuperVideoPlayer,您需求先创建它。mSuperVideoPlayer = (SuperVideoPlayer) findViewById(_player_item_1);eoPlayCallback(mVideoPlayCallback);视频信息获取与播放普通url地址不同,获取视频信息需要通过fileId方式。TXPlayerAuthParams *p = [TXPlayerAuthParams new]; = 1252463788;版权所有:腾讯云计算(北京)有限责任公司第6页 共37页
播放器 SDK 手册产品文档 = @"45649728";TXPlayerAuthBuilder authBuilder = new TXPlayerAuthBuilder();try { Id(nt()); eId(); lay(authBuilder);} catch (NumberFormatException e) { xt(mContext, "请输入正确的AppId", 0).show();}fileId在一般是在视频上传后,由服务器返回:1.客户端视频发布后,服务器会返回fileId到客户端2.服务端视频上传,在确认上传的通知中包含对应的fileId如果文件已存在腾讯云,则可以进入 点播视频管理,找到对应的文件。点开后在右侧视频详情中,可以看到appId和fileId。SDK在请求成功后,将视频信息将以事件的形式通知到上层在Demo中SuperVideoPlayer中示例mTXPlayerGetInfo = new TXVodPlayer(context);Listener(mPlayVodListener);版权所有:腾讯云计算(北京)有限责任公司第7页 共37页
播放器 SDK 手册产品文档Listener(mGetVodInfoListener);/** * 获取fileId对应的视频信息 */private ITXVodPlayListener mGetVodInfoListener = new ITXVodPlayListener() { @Override public void onPlayEvent(TXVodPlayer player, int event, Bundle param) { String playEventLog = "receive event: " + event + ", " +ing(_DESCRIPTION); Log.d(TAG, playEventLog); if (event == _EVT_GET_PLAYINFO_SUCC) { // 获取点播文件信息成功 VodRspData data = new VodRspData(); = ing(_PLAY_COVER_URL); on = (_PLAY_DURATION); = ing(_PLAY_URL); if (mVideoPlayCallback != null) { VideoInfo(data); } } }};切换视频播放器播放另一个视频,调用setPlayUrl即可String url = "/xxx/yyy/4";版权所有:腾讯云计算(北京)有限责任公司第8页 共37页
播放器 SDK 手册产品文档if (mSuperVideoPlayer != null) { UI("新播放的视频"); yUrl(url);}移除播放器当不需要播放器时,调用onDestroy清理播放器内部状态,防止干扰下次播放。if (mSuperVideoPlayer != null) { roy();}版权所有:腾讯云计算(北京)有限责任公司第9页 共37页
播放器 SDK 手册产品文档超级播放器 iOS功能介绍超级播放器是基于TXVodPlayer实现的集视频信息拉取、横竖屏切换、清晰度选择、弹幕等功能于一体的解决方案,且完全开源。帮助您在短时间内,打造一个媲美市面上各种流行视频App的播放体验。接入准备1.下载 SDK + Demo 开发包,下载地址为(iOS)。2.超级播放器的 UI 部分源码开源,开源代码位于Player版权所有:腾讯云计算(北京)有限责任公司第10页 共37页
播放器 SDK 手册产品文档文件夹,图片资源位于Resource/Player文件夹,您需要先将这两部分拷贝的您的App工程中。其它依赖的第三方库您可以自行 Pod 添加或在
Third目录中获取MasonrySDWebImage创建播放器超级播放器主类为ZFPlayerView,您需求先创建它并添加的需要的父View中。_playerView = [[ZFPlayerView alloc] init];[_playerView playerControlView:nil playerModel:Model];// 设置代理_te = self;// 加载成功后自动播放[View autoPlayTheVideo];视频信息获取版权所有:腾讯云计算(北京)有限责任公司第11页 共37页
播放器 SDK 手册产品文档与播放普通url地址不同,获取视频信息需要通过fileId方式。TXPlayerAuthParams *p = [TXPlayerAuthParams new]; = 1252463788; = @"45649728";oPlayer = [[TXVodPlayer alloc] init];[oPlayer setIsAutoPlay:NO];egate = self;[oPlayer startPlayWithParams:p];fileId在一般是在视频上传后,由服务器返回:1.客户端视频发布后,服务器会返回fileId到客户端2.服务端视频上传,在确认上传的通知中包含对应的fileId如果文件已存在腾讯云,则可以进入 点播视频管理,找到对应的文件。点开后在右侧视频详情中,可以看到appId和fileId。SDK在请求成功后,视频信息将以事件的形式通知到上层- (void)onPlayEvent:(TXVodPlayer *)player event:(int)EvtID withParam:(NSDictionary *)param{ if (EvtID == PLAY_EVT_GET_PLAYINFO_SUCC) {版权所有:腾讯云计算(北京)有限责任公司第12页 共37页
播放器 SDK 手册产品文档 ListVideoModel *model = [ListVideoModel new]; = param[EVT_PLAY_COVER_URL]; on = [param[EVT_PLAY_DURATION] intValue]; = param[EVT_PLAY_URL]; }}切换视频播放另一个视频,您需要重新创建一个playerModel,调用resetToPlayNewVideo即可_ = [cell getSource].title;_RL = [NSURL URLWithString:[cell getSource].url];_olderImage = [UIImage imageWithData:[NSData dataWithContentsOfURL: [NSURL URLWithString:[cell getSource].cover]]];[_playerView resetToPlayNewVideo:Model];移除播放器当不需要播放器时,调用resetPlayer清理播放器内部状态,防止干扰下次播放。[View resetPlayer]; //非常重要版权所有:腾讯云计算(北京)有限责任公司第13页 共37页
播放器 SDK 手册产品文档超级播放器 WebWeb 视频播放器综述腾讯云 WEB 视频播放器介绍腾讯云针对不同的业务场景和使用场景,提供了不同的 WEB 视频播放器,分别为:点播超级播放器直播播放器1.0TCPlayer Lite点播播放器1.0下面将对这些播放器进行简要介绍点播超级播放器点播超级播放器是基于 框架并结合腾讯云点播业务而开发的视频播放器,采用以 HTML5
播放器 SDK 手册产品文档TCPlayer Lite独立播放器 TCPlayer Lite 实现了基本的视频播放器功能,采用 HTML5 和 Flash相结合的播放模式,支持播放 hls、mp4 格式的点播视频和 RTMP、http-flv、hls协议的直播视频,支持主要的桌面和移动端浏览器。该播放器仅支持传入地址播放,不关联业务,适用于轻量化 WEB 视频播放场景,支持点播和直播,支持通过CSS 定制化界面。具体介绍请看使用文档点播播放器1.0点播播放器1.0是结合腾讯云点播业务而开发的视频播放器,以 Flash 为主要播放模式,需要浏览器支持并启用Flash 插件。该播放器主要面向比较老旧的浏览器,比如IE8、9、10、11等。由于 Flash 逐步被现代浏览器禁止运行,并且 Flash 将于2020年停止开发和更新,腾讯云点播推出了以HTML5 播放为主的点播超级播放器方案,逐步替换点播播放器1.0。点播播放器1.0具体介绍请看使用文档如何选择播放器通过以上对各个播放器的介绍,了解每种播放器的特点以及适用场景,建议结合所使用的腾讯云业务,以及自身所具备的开发能力来选择合适的 WEB 播放器。如遇到播放问题,请查看常见问题文档版权所有:腾讯云计算(北京)有限责任公司第15页 共37页
播放器 SDK 手册产品文档使用文档前言本文档是介绍腾讯云视频点播服务的 Web 播放器,它可以帮助腾讯云客户通过灵活的接口,快速与自有 Web应用集成,实现视频播放功能,本文档适合有一定 Javascript 语言基础的开发人员阅读。能力介绍腾讯云视频点播 WEB 播放器是通过 HTML5
播放器 SDK 手册产品文档浏览器和手机浏览器的自适应切换,播放器内部会自动区分平台使用最优的播放方案。例如:在 IE11/10/9/8浏览器中会使用 Flash 播放器以实现其不支持 HTML5 播放 HLS 的能力,在 Chrome等现代浏览器中优先使用 HTML5 技术实现视频播放,而手机浏览器上会使用 HTML5 技术实现视频播放。点播平台的转码服务由于 MP4 和 HLS(m3u8)是目前在 PC浏览器和手机浏览器上支持程度最广泛的格式,所以腾讯云的视频点播平台最终会把上传的视频发布为 MP4和 HLS(m3u8) 格式。准备工作step 1:开通服务在 腾讯云官网 注册腾讯云帐号,然后开通点播服务。step 2:上传文件点播服务开通之后,进入 点播视频管理就可以上传新的视频文件,如果您没有开通点播服务,则无法操作这一步骤。step 3:获取 fileID 与 appID上传完视频并转码之后,您就可以在视频管理页面查到文件的 fileID,这个是播放器播放视频的最基本信息,同时您的 appID 也可以在视频管理页面查看到。下图中的两个ID,左边一个是视频文件的 fileID,另一个是您的 appID。版权所有:腾讯云计算(北京)有限责任公司第17页 共37页
播放器 SDK 手册产品文档初始化 Web 播放器在准备工作完成后,通过以下 3 个步骤,您就可以在您的网页上添加一个视频播放器。step 1:在页面中引入文件在合适的地方引入播放器样式文件与脚本文件 注意事项:如果需要在 Chrome Firefox 等现代浏览器中通过 HTML5 播放 hls,需要在 之前引入 。
播放器 SDK 手册产品文档注意事项:播放器容器必须为
播放器 SDK 手册产品文档完整的示例页面:示例代码链接功能使用说明下面将对播放器的部分功能进行详细说明,包括最佳实践与注意事项。播放器尺寸设置这里介绍几种给播放器设置尺寸的方法可以给
播放器 SDK 手册产品文档1、 首先需要在控制台设置转码多种清晰度,如下图2、视频转码后,将会生成多种清晰度的文件,在【控制台】>【视频管理】视频列表中单击视频将会看到如下图经过以上两个步骤,该视频已具备多种清晰度,使用 fileID appID 在腾讯云点播播放器中播放即可。清晰度选择效果如下图:版权所有:腾讯云计算(北京)有限责任公司第21页 共37页
播放器 SDK 手册产品文档注意事项:在浏览器劫持视频播放的情况下,该功能无法使用。通常在移动浏览器中,浏览器会劫持视频播放,用浏览器自带的播放器替代。示例:多种清晰度指定播放清晰度这里分为两种情况:指定播放某个清晰度和让播放器默认播放某个清晰度指定播放某个清晰度通过播放器的 definition 参数指定播放某个清晰度可选值1020版权所有:腾讯云计算(北京)有限责任公司说明MP4 手机MP4 标清第22页 共37页
播放器 SDK 手册产品文档可选值3240说明MP4 高清MP4 超清HLS 手机HLS 标清HLS 高清HLS 超清在下面的示例中,将指定播放 MP4 手机清晰度视频:指定播放清晰度让播放器默认播放某个清晰度在“控制台-Web 播放器管理”选定某个播放器配置进行设置默认画质在“控制台-视频管理”将视频与某个播放器配置进行关联,在使用腾讯云播放器播放该视频时,将会版权所有:腾讯云计算(北京)有限责任公司第23页 共37页
播放器 SDK 手册产品文档使用关联的播放器配置。注意事项:如果默认清晰度的视频不存在,则获取该视频的清晰度列表中第一个文件进行播放。比如播放器配置默认播放超高清,但是视频只有标清和高清,这时会播放标清视频。控制台播放器配置在设置后,大概需要10分钟使所有 CDN 节点生效该配置。在浏览器劫持视频播放的情况下,该功能无法使用。续播功能开启续播功能的前提,必须通过 fileID 播放。有了唯一的 fileID,播放器才能记录该视频的播放时长,当播放未结束时关闭页面,在同一个浏览器中再次打开播放页面,可从上次观看的时间点继续播放。通过以下参数开启续播功能:var player = TCPlayer('player-container-id', { fileID: '', // 请传入需要播放的视频 filID 必须 appID: '', // 请传入点播账号的 appID 必须 plugins:{ ContinuePlay: { // 开启续播功能 // auto: true, //[可选] 是否在视频播放后自动续播 // text:'上次播放至 ', //[可选] 提示文案版权所有:腾讯云计算(北京)有限责任公司第24页 共37页
播放器 SDK 手册产品文档 // btnText: '恢复播放' //[可选] 按钮文案 }, } });开启成功后将会看到的效果如下图:示例:续播注意事项:必须通过 fileID appID 播放经过腾讯云转码后的视频,才能使用该功能。该功能通过通过 localStorage 存储播放时间点,浏览器需支持该特性。在浏览器劫持视频播放的情况下,该功能无法使用。该功能不是多端多浏览器互通的,比如在 PC浏览器上没看完,不能在移动端浏览器上续播或者在 PC上另一个浏览器续播,需额外的接口,可以自行开发。版权所有:腾讯云计算(北京)有限责任公司第25页 共37页
播放器 SDK 手册产品文档设置播放器 logo腾讯云点播播放器支持配置播放器 logo,可以在【控制台】>【Web播放器管理】选定某个播放器配置,单击外观栏目进行设置 logo 信息。设置 logo 信息后,使用该播放器配置播放视频时,将会在指定位置显示 logo。示例:显示 Logo注意事项:控制台播放器配置在设置后,大概需要10分钟使所有 CDN 节点生效该配置。在浏览器劫持视频播放的情况下,设置的 logo 将无法显示。图片贴片功能腾讯云点播播放器支持配置片头、片中暂停、片尾显示图片贴片,并且可以添加超链接。可以在【控制台】>【Web 播放器管理】选定某个播放器配置,单击贴片栏目进行设置贴片信息。默认的贴片显示样式为水平垂直居中显示,如果图片的尺寸大于播放器显示区域,将按播放器的宽度等比缩放图片,水平居中显示图片,图片超出播放器区域部分将无法显示。可以通过 CSS 自定义贴片的显示样式。.tcp-image-patch-start{} /* 片头贴片样式Class */.tcp-image-patch-pause{} /* 片中贴片样式Class */.tcp-image-patch-ended{} /* 片尾贴片样式Class */示例:图片贴片注意事项:版权所有:腾讯云计算(北京)有限责任公司第26页 共37页
播放器 SDK 手册产品文档贴片建议使用体积不超过50KB且尺寸不超过播放器显示区域的图片,避免因图片过大影响视频初始化速度。控制台播放器配置在设置后,大概需要10分钟使所有 CDN 节点生效该配置。在浏览器劫持视频播放的情况下,设置的贴片将无法显示。Referer 防盗链开启流程请看 Referer 防盗链说明文档播放器初始化需增加参数如下:var player = TCPlayer('player-container-id', { fileID: '', // 请传入需要播放的视频filID 必须 appID: '', // 请传入点播账号的appID 必须 flash:{ swf: '//[腾讯云隔离域名]/vod-player/[appID]/[fileID]/tcplayer/' //swf 文件地址 必须 } });需传入 swf url,如果浏览器使用 Flash 播放,将会去这个地址获取 Flash 播放器。Flash播放器发起视频请求时,请求的 Referer 会带上该 url 或者带上页面的 url。注意事项:播放器在 Flash 模式下发起视频请求的 Referer 在 IE、Firefox 浏览器中会带上 swf url,与Chrome 浏览器会带上页面的 url 的情况不同。您也可以将 文件下载后,存放到您的 CDN 服务器中,swf 参数传入指向您的CDN 服务器路径。腾讯云提供的隔离域名是每个用户独有的域名,一个 appID 对应一个域名,通常格式为[appID].。版权所有:腾讯云计算(北京)有限责任公司第27页 共37页
播放器 SDK 手册产品文档需要将播放器 swf url 的域名添加到白名单内,开启了Referer防盗链的视频才能在 Flash模式下播放。播放器的 Flash swf 文件默认存放在 域名下。Key 防盗链开启流程请看 Key 防盗链说明文档播放器初始化需增加参数如下:var player = TCPlayer('player-container-id', { fileID: '', // 请传入需要播放的视频 filID 必须 appID: '', // 请传入点播账号的 appID 必须 t: '', us: '', sign:'' });参数 t、us、sign的具体含义请查看 Key 防盗链说明文档注意事项:sign 的计算方法为:sign = md5(KEY+appId+fileId+t+us),与 Key 防盗链说明文档中的计算方式不同,其余参数一致。如果同时开启了 Referer 防盗链,在 Referer 防盗链配置的示例代码基础上增加参数即可。试看功能版权所有:腾讯云计算(北京)有限责任公司第28页 共37页
播放器 SDK 手册产品文档使用试看功能需要先开启 Key 防盗链,开启流程请看 Key 防盗链说明文档播放器初始化需增加参数如下:var player = TCPlayer('player-container-id', { fileID: '', // 请传入需要播放的视频 filID 必须 appID: '', // 请传入点播账号的 appID 必须 t: '', us: '', sign:'', exper:'' });参数 t、us、sign、exper 的具体含义请查看 Key 防盗链说明文档注意事项:带试看的 sign 计算方法为:sign = md5(KEY+appId+fileId+t+exper+us),与 Key防盗链说明文档中的计算方式不同,其余参数一致。播放器播放的视频时长是 exper 参数指定的长度,与已往在播放端控制播放时长的试看功能不同,播放器不会获取完整的视频。HLS 加密播放开启流程请看视频加密文档注意事项:如果播放页面或者Flash swf url 与解密秘钥服务器域名不一致,Key 服务器需要部署 和 CORS("跨域资源共享" Cross-origin resource sharing),允许 Flash版权所有:腾讯云计算(北京)有限责任公司第29页 共37页
播放器 SDK 手册产品文档和 JavaScript 跨域获取解密秘钥。 中配置的是 swf url 的域名,并且 xml 文件必须放置在 Key服务器的根目录。播放器的 Flash swf 文件默认存放在 域名下。视频只能进行一次加密,不可多次加密,严格按照视频加密文档操作。解密秘钥正确长度为16字节,起始和末尾位置不能有空白字符。版权所有:腾讯云计算(北京)有限责任公司第30页 共37页
播放器 SDK 手册产品文档开发文档前言本文档介绍腾讯云视频点播服务的 Web 播放器的相关参数以及 API,需结合 《使用文档》使用。本文档适合有一定 Javascript 语言基础的开发人员阅读。初始化参数播放器初始化需要传入两个参数,第一个为播放器容器 ID,第二个为功能参数对象。var player = TCPlayer('player-container-id', options);options 参数列表options 对象可配置的参数:名称appIDfileIDwidth类型StringStringString / Number默认值无无无说明必选必选播放器区域宽度,单位像素,按需设置,可通过 CSS控制播放器尺寸。heightString /Number无播放器区域高度,单位像素,按需设置,可通过 CSS控制播放器尺寸。controlsposterautoplayplaybackRatesBooleanStringBooleanArraytrue无false[0.5, 1, 1.25, 1.5, 2]是否显示播放器的控制栏设置封面图片完整地址是否自动播放设置变速播放倍率选项,仅H5 有效loopmutedBooleanBooleanfalsefalse是否循环播放是否静音播放第31页 共37页版权所有:腾讯云计算(北京)有限责任公司
播放器 SDK 手册产品文档名称preload类型String默认值auto说明是否需要预加载,有 3 个属性"auto","meta","none" ,移动端由于系统限制,设置 auto 无效。swfString无Flash 播放器 swf 文件的URLposterImagebigPlayButtonBooleanBooleantruetrue是否显示封面是否显示居中的播放按钮(浏览器劫持嵌入的播放按钮无法去除)languagelanguagescontrolBarStringObjectObject"zh-CN"无无设置语言设置多语言词典设置控制栏属性的参数组合,后面有详细介绍pluginsObject无设置插件功能属性的参数组合,后面有详细介绍controlBar 参数列表controlBar 参数可以配置播放器控制栏的功能,支持的属性有:名称playToggle类型Boolean默认值true说明是否显示播放、暂停切换按钮progressControlvolumePanelcurrentTimeDisplaydurationDisplaytimeDividerBooleanBooleanBooleanBooleanBooleantruetruetruetruetruetrue是否显示播放进度条是否显示音量控制是否显示视频当前时间是否显示视频时长是否显示时间分割符是否显示播放速率选择按钮playbackRateMenuButtoBooleannfullscreenToggleBooleantruetrue是否显示全屏按钮是否显示清晰度切换菜单QualitySwitcherMenuButBooleanton版权所有:腾讯云计算(北京)有限责任公司第32页 共37页
播放器 SDK 手册产品文档plugins 插件参数列表plugins 参数可以配置播放器插件的功能,支持的属性有:名称ContinuePlay类型Object默认值无说明控制续播功能,支持的属性如下auto: false, //是否在播放时自动续播text: '上次看到 ', //提示文案btnText: '恢复播放' //按钮文案对象方法初始化播放器返回对象的方法列表:名称ready(function)参数及类型(Function)返回值及类型无说明设置播放器初始化完成后的回调play()pause()currentTime(seconds)无无(Number)无无(Number)播放以及恢复播放暂停播放获取当前播放时间点,或者设置播放时间点,该时间点不能超过视频时长duration()volume(percent)poster(src)requestFullscreen()exitFullscreen()isFullscreen()on(type,listerner)无(Number)[0,1][可选](String)无无无(String, Function)(Number)获取视频时长(Number) / 设置时无返回获取或设置播放器音量(String) / 设置时无返回无无Boolean无获取或设置播放器封面进入全屏模式退出全屏模式返回是否进入了全屏模式监听事件第33页 共37页版权所有:腾讯云计算(北京)有限责任公司
播放器 SDK 手册产品文档名称one(type,listerner)参数及类型(String, Function)返回值及类型无说明监听事件,事件处理函数最多只执行 1 次off(type,listerner)buffered()bufferedPercent()(String, Function)无无无TimeRanges值范围[0,1]解绑事件监听返回视频缓冲区间返回缓冲长度占视频时长的百分比width()(Number)[可选](Number) / 设置时无返回获取或设置播放器区域宽度,如果通过 CSS 设置播放器尺寸,该方法将无效height()(Number)[可选](Number) / 设置时无返回获取或设置播放器区域高度,如果通过 CSS 设置播放器尺寸,该方法将无效videoWidth()videoHeight()dispose()无无无(Number)(Number)无获取视频分辨率的宽度获取视频分辨率的高度销毁播放器注意事项:部分方法不能同步调用事件播放器可以通过初始化返回的对象进行事件监听,示例:var player = TCPlayer('player-container-id', options);(type, function);其中 type 为事件类型,支持的事件有:版权所有:腾讯云计算(北京)有限责任公司第34页 共37页
播放器 SDK 手册产品文档名称play介绍已经开始播放,调用 play() 方法或者设置了 autuplay为 true 且生效时触发,这时 paused 属性为 falseplaying因缓冲而暂停或停止后恢复播放时触发,paused属性为 false。通常用这个事件来标记视频真正播放,play事件只是开始播放,画面并没有开始渲染loadstartdurationchangeloadedmetadataloadeddata开始加载数据时触发视频的时长数据发生变化时触发已加载视频的 metadata当前帧的数据已加载,但没有足够的数据来播放视频的下一帧时,触发该事件progresscanplaycanplaythrough在获取到媒体数据时触发当播放器能够开始播放视频时触发当播放器预计能够在不停下来进行缓冲的情况下持续播放指定的视频时触发errorpauseratechangeseekedseekingtimeupdate视频播放出现错误时触发暂停时触发播放速率变更时触发搜寻指定播放位置结束时触发搜寻指定播放位置开始时触发当前播放位置有变更,可以理解为 currentTime有变更volumechangewaitingended设置音量或者 muted 属性值变更时触发播放停止,下一帧内容不可用时触发视频播放已结束时触发。此时 currentTime值等于媒体资源最大值resolutionswitchingresolutionswitched清晰度切换进行中清晰度切换完毕错误码当播放器触发 error 事件时,监听函数会返回错误码。错误码列表:版权所有:腾讯云计算(北京)有限责任公司第35页 共37页
播放器 SDK 手册产品文档名称-1-213介绍没有视频地址获取视频数据超时视频加载播放被中断由于网络问题造成加载视频失败解码时发生错误视频因格式不支持或者服务器或网络的问题无法加载解密时发生错误点播服务接口请求超时点播服务接口没有响应点播服务接口返回异常数据点播视频没有转码,需在点播控制台进行转码版权所有:腾讯云计算(北京)有限责任公司第36页 共37页
播放器 SDK 手册产品文档播放器 SDK 下载概述目前,腾讯云点播为客户端提供了Android,iOS 和 Web 三种客户端 SDK。Android SDK视频播放SDK 下载地址iOS SDK视频播放SDK 下载地址Web SDK视频播放Web SDK不需要下载,直接在页面中引入js即可,详情请见以上链接版权所有:腾讯云计算(北京)有限责任公司第37页 共37页