使用文档

最后更新时间:2021-09-01 10:06:57

    本文档是介绍腾讯云视立方 Web 超级播放器(TCPlayer),它可以帮助腾讯云客户通过灵活的接口,快速与自有 Web 应用集成,实现视频播放功能,本文档适合有一定 Javascript 语言基础的开发人员阅读。

    能力介绍

    腾讯云视立方 Web 超级播放器是通过 HTML5 的<video>标签以及 Flash 实现视频播放。在浏览器不支持视频播放的情况下,实现了视频播放效果的多平台统一体验,并结合腾讯云点播视频服务,提供防盗链和播放 HLS 普通加密视频等功能。

    功能支持

    功能\浏览器 Chrome Firefox Edge QQ 浏览器 Mac Safari iOS Safari iOS 微信 QQ Android Chrome Android 微信、QQ 手机 QQ 浏览器 IE 8, 9, 10, 11
    MP4 格式
    HLS 格式
    播放器尺寸设置
    续播功能
    倍速播放
    缩略图预览 - - - - - - -
    (11支持)
    切换 fileID 播放
    镜像功能
    进度条标记 - - - - -
    HLS 自适应码率
    Referer 防盗链 - - -
    清晰度切换提示 - - - - - - -
    试看功能
    HLS 加密播放 - - - - - - - -
    视频统计信息 - - - - - - -
    自定义提示文案
    说明:

    • 视频编码格式仅支持 H.264 编码。
    • Chrome、Firefox 包括 Windows、macOS 平台。
    • Chrome、Firefox、Edge 及 QQ 浏览器播放 HLS 需要加载 hls.js
    • Android 微信、QQ 为 TBS 内核,原生支持播放 MP4、HLS。
    • Referer 防盗链功能是基于 HTTP 请求头的 Referer 字段实现的,部分 Android 浏览器发起的 HTTP 请求不会携带 Referer 字段。
    • IE8 采用 Flash 播放,IE9/10/11 播放 HLS 时采用 Flash 播放,需要确保浏览器支持 Flash 插件。
    • IE8 仅支持 Windows 7 系统的 IE8。

    播放器兼容常见的浏览器,播放器内部会自动区分平台,并使用最优的播放方案。例如:在 IE11/10/9/8 浏览器中会使用 Flash 播放器以实现其不支持 HTML5 播放 HLS 的能力,在 Chrome 等现代浏览器中优先使用 HTML5 技术实现视频播放,而手机浏览器上会使用 HTML5 技术或者浏览器内核能力实现视频播放。

    点播平台的转码服务

    由于 MP4 和 HLS(M3U8)是目前在桌面浏览器和手机浏览器上支持程度最广泛的格式,所以腾讯云的视频点播平台最终会把上传的视频发布为 MP4 和 HLS(M3U8)格式。

    准备工作

    具体流程请参见 使用超级播放器播放 - 接入指引 文档。

    初始化 Web 播放器

    在准备工作完成后,通过以下步骤,您就可以在网页上添加一个视频播放器。

    步骤1:在页面中引入文件

    在合适的地方引入播放器样式文件与脚本文件:

    <link href="https://web.sdk.qcloud.com/player/tcplayer/release/v4.2.1/tcplayer.min.css" rel="stylesheet">
    <!--如果需要在 Chrome 和 Firefox 等现代浏览器中通过 H5 播放 HLS 格式的视频,需要在 tcplayer.v4.2.min.js 之前引入 hls.min.0.13.2m.js。-->
    <script src="https://web.sdk.qcloud.com/player/tcplayer/release/v4.2.1/libs/hls.min.0.13.2m.js"></script>
    <!--播放器脚本文件-->
    <script src="https://web.sdk.qcloud.com/player/tcplayer/release/v4.2.1/tcplayer.v4.2.1.min.js"></script>
    

    建议在使用播放器 SDK 的时候自行部署资源,点击下载播放器资源

    部署解压后的文件夹,不能调整文件夹里面的目录,避免资源互相引用异常。

    如果您部署的地址为 aaa.xxx.ccc,在合适的地方引入播放器样式文件与脚本文件:

    <link href="aaa.xxx.ccc/tcplayer.min.css" rel="stylesheet">
    <!--如果需要在 Chrome 和 Firefox 等现代浏览器中通过 H5 播放 HLS 格式的视频,需要在 tcplayer.v4.2.1.min.js 之前引入 hls.min.0.13.2m.js。-->
    <script src="aaa.xxx.ccc/libs/hls.min.0.13.2m.js"></script>
    <!--播放器脚本文件-->
    <script src="aaa.xxx.ccc/tcplayer.v4.2.1.min.js"></script>
    
    说明:

    暂不支持 VUE React 等框架的模块加载方式,可以通过 script 全局引入相关脚本的方式进行使用。

    步骤2:放置播放器容器

    在需要展示播放器的页面位置加入播放器容器。例如,在 index.html 中加入如下代码(容器 ID 以及宽高都可以自定义)。

    <video id="player-container-id" width="414" height="270" preload="auto" playsinline webkit-playsinline>
    </video>
    
    说明:

    • 播放器容器必须为<video>标签。
    • 示例中的 player-container-id 为播放器容器的 ID,可自行设置。
    • 播放器容器区域的尺寸,建议通过 CSS 进行设置,通过 CSS 设置比属性设置更灵活,可以实现例如铺满全屏、容器自适应等效果。
    • 示例中的 preload 属性规定是否在页面加载后载入视频,通常为了更快的播放视频,会设置为 auto,其他可选值:meta(当页面加载后只载入元数据),none(当页面加载后不载入视频),移动端由于系统限制不会自动加载视频。
    • playsinlinewebkit-playsinline 这几个属性是为了在标准移动端浏览器不劫持视频播放的情况下实现行内播放,此处仅作示例,请按需使用。
    • 设置 x5-playsinline 属性在 TBS 内核会使用 X5 UI 的播放器。

    步骤3:初始化代码

    在页面初始化的代码中加入以下初始化脚本,传入在准备工作中获取到的 fileID(【媒资管理】中的视频 ID)与 appID(在【账号信息】>【基本信息】中查看)。

    var player = TCPlayer('player-container-id', { // player-container-id 为播放器容器 ID,必须与 html 中一致
       fileID: '5285890799710670616', // 请传入需要播放的视频 fileID(必须)
       appID: '1400329073' // 请传入点播账号的 appID(必须)
     });
    
    注意:

    要播放的视频需经过腾讯云转码,原始视频无法保证在浏览器中正常播放。

    完整示例页面

    单击 示例代码 进入示例页面,在该页面鼠标右键单击选择【查看网页源代码】,即可查看示例源码。

    功能使用说明

    下面将对播放器的部分功能进行详细说明,包括最佳实践与注意事项。

    播放器尺寸设置

    这里介绍几种给播放器设置尺寸的方法:

    • 可以给标签设置 width 和 height 属性,width 和 height 的属性值是以像素计量的(如 width = "100px" 或 width = 100),不能设置百分比。
    • 可以通过 CSS 设置尺寸,支持像素和百分比等类型的值(如 width:"100px" 或 width:"100%" )。
    说明:

    • 如果不设置宽高,播放器在获取到视频的分辨率后,将会以视频的分辨率设置播放器的显示尺寸,如果浏览器的可视区域尺寸小于视频分辨率,会造成播放器区域超出浏览器的可视区域,所以通常不建议这样做。最佳实践为通过 CSS 设置播放器的尺寸。
    • 熟练运用 CSS 可以实现铺满全屏、容器自适应等效果。

    示例

    进入示例页面,在该页面鼠标右键单击选择【查看网页源代码】,即可查看示例源码。

    续播功能

    开启续播功能的前提,必须通过 fileID 播放。有了唯一的 fileID,播放器才能记录该视频的播放时长,当播放未结束时关闭页面,在同一个浏览器中再次打开播放页面,可从上次观看的时间点继续播放。通过以下参数开启续播功能:

    var player = TCPlayer('player-container-id', {
      fileID: '', // 请传入需要播放的视频 fileID(必须)
      appID: '', // 请传入点播账号的 appID(必须)
      plugins:{
          ContinuePlay: { // 开启续播功能
            // auto: true, //[可选] 是否在视频播放后自动续播
            // text:'上次播放至 ', //[可选] 提示文案
            // btnText: '恢复播放' //[可选] 按钮文案
          },
        }
    });
    

    开启成功后将会看到的效果如下图:

    示例

    单击 续播 进入示例页面,在该页面鼠标右键单击选择【查看网页源代码】,即可查看示例源码。

    注意:

    • 必须通过 fileID 和 appID 播放经过腾讯云转码后的视频,才能使用该功能。
    • 该功能通过 localStorage 存储播放时间点,浏览器需支持该特性。
    • 在浏览器劫持视频播放的情况下,该功能无法使用。
    • 该功能不是多端多浏览器互通的,例如在 PC 浏览器上没看完,不能在移动端浏览器上续播或者在 PC 上另一个浏览器续播,需额外的接口,可以自行开发。

    倍速播放

    在浏览器支持的情况下播放器默认开启倍速播放功能。

    var player = TCPlayer('player-container-id', {
    fileID: '', // 请传入需要播放的视频 fileID(必须)
    appID: '', // 请传入点播账号的 appID(必须)
    playbackRates: [0.5, 1, 1.25, 1.5, 2] // 设置变速播放倍率选项,仅 HTML5 播放模式有效
    });
    
    注意:

    • 如果浏览器不支持倍速播放,播放器将不会显示倍速切换按钮。
    • 如需关闭该功能请参见 开发文档

    缩略图预览

    点播超级播放器支持缩略图预览,开启该功能有两种方式:

    • 通过服务端 API 生成视频的缩略图与 VTT 文件,相关文档可参阅 截图 - 雪碧图
    • 自行生成缩略图文件与 VTT 文件,并将两个文件的 URL 传递给播放器,参考示例“缩略图预览 - 传入缩略图与 VTT 文件”

    开启成功的效果如下图:

    示例

    进入示例页面,在该页面鼠标右键单击选择【查看网页源代码】,即可查看示例源码。

    注意:

    • 该功能仅支持桌面端浏览器。
    • 在浏览器劫持视频播放的情况下,该功能无法使用。
    • 生成的缩略图越多,进度条预览越精确,而缩略图越多,图片越大加载越慢,需要取舍平衡。

    切换 fileID 播放

    通过实例化对象的 loadVideoByID(args) 方法,可以更换视频进行播放。该方法支持的参数如下:

    player.loadVideoByID({
     fileID: '', // 请传入需要播放的视频 fileID(必须)
     appID: '', // 请传入点播账号的 appID(必须)
     psign:'' // 参考 Key 防盗链说明
    });
    

    示例

    单击 切换 fileID 播放 进入示例页面,在该页面鼠标右键单击选择【查看网页源代码】,即可查看示例源码。

    镜像功能

    激活镜像功能,可以让视频画面镜像翻转,如下图所示:

    开启右键菜单镜像选项:

    var player = TCPlayer('player-container-id', {
     fileID: '', // 请传入需要播放的视频 fileID(必须)
     appID: '', // 请传入点播账号的 appID(必须)
     plugins: {
       ContextMenu: {
         mirror: true
       }
     }
    });
    

    示例

    单击 镜像功能 进入示例页面,在该页面鼠标右键单击选择【查看网页源代码】,即可查看示例源码。

    注意:

    在浏览器劫持视频播放的情况下,该功能无法使用。

    进度条标记

    通过服务端 API 对视频 增加打点信息,可以在播放器中开启显示进度条标记,如下图所示:

    播放器开启方式:

    var player = TCPlayer('player-container-id', {
     fileID: '', // 请传入需要播放的视频 fileID(必须)
     appID: '', // 请传入点播账号的 appID(必须)
     plugins: {
       ProgressMarker: true
     }
    });
    

    示例

    单击 进度条标记 进入示例页面,在该页面鼠标右键单击选择【查看网页源代码】,即可查看示例源码。

    注意:

    • 该功能仅支持桌面端浏览器。
    • 在浏览器劫持视频播放的情况下,该功能无法使用。

    HLS 自适应码率播放

    • HLS 规范的 Master Playlist 可以根据网络速度自适应码率播放,在视频下载过程中,如果网络速度满足下载高码率的 TS 分片时,播放器将切换播放高码率的 TS 分片,反之播放低码率的 TS 分片。移动端和桌面端大部分浏览器都支持该特性。
    • 播放 HLS Master Playlist 时,播放器的清晰度选择功能将会变成选择特定的码率或者根据网络速度自动选择。如下图所示:
    注意:

    • 自适应码率播放全端都默认采用自动切换逻辑。
    • 由于部分浏览器没有提供相应的接口和不支持 MSE,这些浏览器无法手动选择特定的清晰度,也不会显示切换清晰度的选项。
    • Flash 播放模式下不支持手动选择特定的码率。

    示例

    单击 HLS Master Playlist 进入示例页面,在该页面鼠标右键单击选择【查看网页源代码】,即可查看示例源码。

    Referer 防盗链

    开启流程请参见 Referer 防盗链。播放器初始化需增加参数如下:

    var player = TCPlayer('player-container-id', {
        fileID: '', // 请传入需要播放的视频 fileID(必须)
        appID: '', // 请传入点播账号的appID(必须)
        flash:{
            swf: '//[腾讯云隔离域名]/vod-player/[appID]/[fileID]/tcplayer/player.swf' //swf 文件地址(必须)
        }
      });
    

    需传入 swf URL,如果浏览器使用 Flash 播放,将会从这个地址获取 Flash 播放器。Flash 播放器发起视频请求时,请求的 Referer 会带上该 URL 或者带上页面的 URL。

    说明:

    • 播放器在 Flash 模式下发起视频请求的 Referer,在 IE、Firefox 浏览器中会带上 swf URL,与 Chrome 浏览器会带上页面的 URL 的情况不同。
    • 您也可以将 player.swf 文件下载后,存放到您的 CDN 服务器中,swf 参数传入指向您的 CDN 服务器路径。
    • 腾讯云提供的隔离域名是每个用户独有的域名,一个 appID 对应一个域名,通常格式为[appID].vod2.myqcloud.com
    • 需要将播放器 swf URL 的域名添加到白名单内,开启了 Referer 防盗链的视频才能在 Flash 模式下播放。
    • 播放器的 Flash swf 文件默认存放在imgcache.qq.com域名下,如需部署到自己的服务器上,可自行下载并部署,swf 文件地址
    • 如果是在域名限制区域,需要的播放器的 Flash swf 文件默认存放在cloudcache.tencent-cloud.com域名下。
    • iframe 嵌入播放器页面,视频请求的 Referer 会带上 iframe src。

    清晰度切换提示

    开启清晰度切换提示开关,可以增加如下提示:

    播放器初始化需增加参数如下:

    var tcplayer = TCPlayer('player-container-id', { // player-container-id 为播放器容器ID,必须与html中一致
       fileID: '', // 请传入需要播放的视频fileID 必须
       appID: '', // 请传入点播账号的appID 必须
       plugins: {
         ContextMenu: {
           levelSwitch: {
             open: true, // 打开切换提示
             // switchingText: '正在为您切换至', // 开始切换时文案
             // switchedText: '切换成功', // 切换成功时文案
             // switchErrorText: '切换失败', // 切换失败时文案
           }
         }
       }
     });
    

    Key 防盗链

    开启流程请参见 Key 防盗链。播放器初始化需增加参数如下:

    var player = TCPlayer('player-container-id', {
        fileID: '', // 请传入需要播放的视频 fileID(必须)
        appID: '', // 请传入点播账号的 appID(必须)
        psign:''
      });
    

    参数 psign 即超级播放器签名,其具体含义请参见 超级播放器签名

    注意:

    如果同时开启了 Referer 防盗链,在 Referer 防盗链配置的示例代码基础上增加参数即可。

    试看功能

    使用试看功能需要先开启 Key 防盗链,开启流程请参见 Key 防盗链。播放器初始化需增加参数如下:

    var player = TCPlayer('player-container-id', {
     fileID: '', // 请传入需要播放的视频 fileID(必须)
     appID: '', // 请传入点播账号的 appID(必须)
     psign:''
    });
    

    参数 psign 即超级播放器签名,其具体含义请参见 超级播放器签名

    注意:

    • 播放器播放的视频时长是 exper 参数指定的长度,与已往在播放端控制播放时长的试看功能不同,播放器不会获取完整的视频。
    • 试看时长是根据视频关键帧进行裁剪,实际截取的试看时长可能会比设定值少。
    • 开启试看后播放器仍会显示视频原始时长(在 Chrome 和 Firefox 播放 HLS 格式的试看视频会显示试看时长)。

    HLS 加密播放

    播放页面必须加载 hls.js,播放示例代码如下:

    var player = TCPlayer('player-container-id', {
        fileID: '', // 请传入需要播放的视频 fileID(必须)
        appID: '' // 请传入点播账号的 appID(必须)
        psign:''
      });
    

    参数 psign 即超级播放器签名,其具体含义请参见 超级播放器签名

    注意:

    • 如果播放页面或者 Flash swf URL 与解密密钥服务器域名不一致,Key 服务器需要部署 corssdomain.xml 和 CORS("跨域资源共享",Cross-origin resource sharing),允许 Flash 和 JavaScript 跨域获取解密密钥。
    • crossdomain.xml 中配置的是 swf URL 的域名,并且 xml 文件必须放置在 Key 服务器的根目录。
    • 播放器的 Flash swf 文件默认存放在imgcache.qq.com域名下,如需部署到自己的服务器上,可自行下载并部署,swf 文件地址
    • 如果是在域名限制区域,需要的播放器的 Flash swf 文件默认存放在cloudcache.tencent-cloud.com域名下。
    • 视频只能进行一次加密,不可多次加密,严格按照视频加密文档操作。
    • 解密密钥正确长度为16字节,起始和末尾位置不能有空白字符。

    视频统计信息

    右键打开视频统计面板,可以查看视频的实时信息,如下图所示:

    开启右键菜单打开视频统计信息选项:

    var player = TCPlayer('player-container-id', {
     fileID: '', // 请传入需要播放的视频 fileID(必须)
     appID: '', // 请传入点播账号的 appID(必须)
     plugins: {
       ContextMenu: {
         statistic: true
       }
     }
    });
    

    示例

    单击 视频统计信息 进入示例页面,在该页面鼠标右键单击选择【查看网页源代码】,即可查看示例源码。

    注意:

    • 该功能仅支持桌面端浏览器。
    • 在浏览器劫持视频播放的情况下,该功能无法使用。

    自定义提示文案

    当您想要自定义提示文案时,可以通过初始化参数 languages 设置指定的提示文案,示例代码如下:

    var player = TCPlayer('player-container-id', {
    fileID: '', // 请传入需要播放的视频 fileID(必须)
    appID: '', // 请传入点播账号的 appID(必须)
    languages:{
      'zh-cn':{
        'AppID is not exist, Please check if the AppID is correct.': '请确认 appID 是否填写正确'
      }
    }
    });
    

    错误码对应文案列表:

    名称 描述
    -1 No video has been loaded. 播放器没有检测到可用的视频地址。
    -2 Could not download the video. 获取视频数据超时。
    1 You aborted the media playback. 视频数据加载过程中被中断。
    2 A network error caused the media download to fail part-way. 由于网络问题造成加载视频失败。
    3 The media playback was aborted due to a corruption problem or because the media used features your browser did not support. 视频解码时发生错误。
    4 The media could not be loaded, either because the server or network failed or because the format is not supported. 视频因格式不支持或者服务器或网络的问题无法加载。
    5 The media is encrypted and we do not have the keys to decrypt it. 视频解密时发生错误。
    10 Request timed out. 点播媒体数据接口请求超时。
    11 Server is not respond. 点播媒体数据接口没有返回数据。
    12 Server respond error data. 点播媒体数据接口返回异常数据。
    13 No video transcoding information found. 播放器没有检测到可以在当前播放器播放的视频数据,请对该视频进行转码操作。
    14 A network error caused the media download to fail part-way. 网络错误导致视频下载中途失败。
    15 The media playback was aborted due to a corruption problem or because the media used features your browser did not support. 由于视频文件损坏或是该视频使用了您的浏览器不支持的功能,播放终止。
    16 The media playback was aborted due to a corruption problem or because the media used features your browser did not support. 由于视频文件损坏或是该视频使用了您的浏览器不支持的功能,播放终止。
    17 Rise an internal exception when playing HLS. 播放 HLS 时出现内部异常。
    500 Server failed. 媒体服务器错误。
    1001 The media file does not exist. Please check if the fileID is correct. 媒体文件不存在,请检查 fileID 是否正确。
    1002 The trial duration is illegal. The trial duration must be within the video duration. 试看时长不合法,试看时长要在视频时长范围内。
    1003 Param pcfg is not unique. pcfg 不唯一。
    1004 The license has expired. Please check whether the expiration time setting is reasonable. license 过期,请检查过期时间设置是否合理。
    1005 Did not find an adaptive stream that can be played. 没有找到可以播放的自适应码流。
    1006 Invalid request format, please check the request format. 请求格式不合法,请检查请求格式。
    1007 AppID is not exist, Please check if the AppID is correct. AppID 不存在,请检查 AppID 是否正确。
    1008 Without anti-leech information. 没带防盗链检测。
    1009 psign check failed. 播放参数 psign 校验失败。
    1010 Other errors. 其他错误。
    2001 Internal error. 内部错误。
    10008 The media file does not exist. Please check if the fileID is correct. 媒体文件不存在,请检查 fileID 是否正确。

    更新日志

    TCPlayer 在不断更新及完善中,下面是 TCPlayer 发布的主版本介绍。

    日期 版本 更新内容
    2020.7.10 4.1 1. 修改默认 hls.js 版本为0.13.2。
    2. 支持开启 Key 防盗链功能。
    3. 修复其他已知问题。
    2020.6.17 4.0 1. 修复试看视频时长保持显示原始时长。
    2. 启用后台清晰度配置。
    3. 修复其他已知问题。