文档即将上线...

文档即将上线...

保利威视频加密采用私有的加密算法，提供包括加密转码、安全传输、解密播放等一体化的视频安全方案。通过对视频数据本身进行高强度的加密，视频文件即使被下载到本地也无法直接播放和传播，可有效防止视频泄露和盗版问题，详见：视频加密。

为了方便开发者快速集成，我们将解密播放相关逻辑都封装到了播放器内部，与播放普通视频相比，在播放器端，开发者只需多传入播放凭证参数即可实现加密视频的播放。

开发指引

加密视频，需使用播放凭证方式进行播放，播放器需要传递的参数如下：

注：playsafe或playsafeUrl参数用于PC端解密播放，ts、sign用于移动端H5播放器解密。如果PC和移动端使用同一份播放器代码，则三个参数都需要传值。

播放器代码示例：

<div id="player"></div>
<script src="//player.polyv.net/script/player.js"></script>
<script>
var player = polyvPlayer({
    wrap: '#player',
    width: 800,
    height: 533,
    vid: '88083abbf5bcf1356e05d39666be527a_8',   
    playsafe:'81814fed-bdd0-4506-bec1-ebc8093148c5-hfevwsfxcsbcocx', 
  //playsafeUrl:'https://myDomain.com/token', // 业务方自定义的获取播放凭证接口URL，与playsafe参数二选一
    ts:'1568131545000',
    sign:'88313661ba7ded642c7b557b0a364b4b'
});

//切换加密视频时，需要重新获取播放凭证。如果初始化播放器时使用了playsafeUrl参数，则播放器会自动获取新的凭证，无需传playsafe参数。
player.changeVid({
  vid: '88083abbf5bcf1356e05d39666be527a_9', //需要切换的视频vid
  playsafe: '81814fed-bdd0-4506-bec1-ebc8093148c6-hfevwsfxcsbcocx', //新获取的playsafe token
  sign: '88313661ba7ded642c7b557b0a364b4c', //新获取的sign和ts参数
  ts: '1568131545001'
});
</script>

Web页面播放加密视频前，需要先访问业务方自己的服务端授权验证接口（可以在这里加上自有业务的授权验证逻辑，例如是否登录、是否购买课程等, 建议使用HTTPS）。如果业务上允许播放，则通过创建 Playsafe Token接口获取播放凭证（或者在服务端生成sign、ts参数），并返回给Web端播放器。

服务端生成播放凭证代码示例：

PHP 代码：

// 接口中应附带自有业务的授权验证逻辑，如判断是否登录、是否购买课程等

// 以下为生成播放凭证的代码示例
function get_client_ip() {
  if (!empty($_SERVER['HTTP_CLIENT_IP'])) {
    $ipaddress = $_SERVER['HTTP_CLIENT_IP'];
  } elseif (!empty($_SERVER['HTTP_X_FORWARDED_FOR'])) {
      $ipaddress = $_SERVER['HTTP_X_FORWARDED_FOR'];
  } else {
      $ipaddress = $_SERVER['REMOTE_ADDR'];
  }
    return $ipaddress;
}

$userId = 'your userId';       // 保利威点播账号的userId
$secretkey = 'your secretkey';     // 保利威点播账号的secretkey
$videoId = '88083abbf5bcf1356e05d39666be527a_8';  // 视频vid
$ts = time() * 1000;      // 时间戳
$viewerIp = get_client_ip();  // 观众ip
$viewerId = '12345';      // 观众id
$viewerName = 'testUser';  // 观众昵称, 若值为中文需要urlencode('张三')
$extraParams = 'HTML5';  // 自定义扩展参数
$disposable = false // true 表示 token 仅一次有效。false 则表示在有效期内可以多次验证。默认为 false。

/* 将参数 $userId、$secretkey、$videoId、$ts、$viewerIp、$viewerIp、$viewerId、$viewerName、$extraParams按照ASCKII升序 key + value + key + value ... +value 拼接
*/
$concated =  'extraParams'.$extraParams.'ts'.$ts.'userId'.$userId.'videoId'.$videoId.'viewerId'.$viewerId.'viewerIp'.$viewerIp.'viewerName'.$viewerName;
// 首尾加上secretkey值
$plain = $secretkey.$concated.$secretkey;
// 取大写MD5
$sign = strtoupper(md5($plain));

// 然后将下列参数用post请求  https://hls.videocc.net/service/v1/token 获取 token
$url = 'https://hls.videocc.net/service/v1/token';
$data = array('userId' => $userId, 'videoId' => $videoId, 'ts' => $ts, 'viewerIp' => $viewerIp, 'viewerName' => $viewerName, 'extraParams' => $extraParams, 'viewerId' => $viewerId, 'sign' => $sign);
$options = array(
    'http' => array(
        'header'  => "Content-type: application/x-www-form-urlencodedrn",
        'method'  => 'POST',
        'content' => http_build_query($data)
    )
);
$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);

// 获取接口返回结果中的token值, 并传给播放器播放加密视频
$token = json_decode($result)->data->token;
echo $token;

如果播放器使用playsafeUrl参数的方式，则需输出json格式：

// 已省略获取token的代码...
$token = json_decode($result)->data->token;
$code = json_decode($result)->code; // 响应代码，200为成功，403为ts过期或签名错误，400为参数错误（例如缺少 userId 或 videoId）
$message=json_decode($result)->message;
$status=json_decode($result)->status;
if($code == 200){
    $array = Array("code"=>$code,'status'=>$status,'message'=>$message,"data"=>$token);
}else{
    $array = Array("code"=>$code,'status'=>$status,'message'=>$message,"data"=>json_decode($result)->data);
}
$Json = json_encode($array);
echo $Json; //输出json

playsafeUrl返回结果示例：

// 请求成功
{
    "code": 200,
    "status": "success",
    "message": "",
    "data": "973d7731803940a1b14fdc93941f493c"
}
// 请求失败（签名错误）
{
    "code": 403,
    "status": "error",
    "message": "sign_invalid",
    "data": "sign parameter invalid."
}

playsafeUrl可能存在跨域问题，解决方案请参考：跨域访问设置。

如果需要在移动端H5播放Web加密视频，则需返回sign和ts参数给播放器：

// php
$vid = "88083abbf5bcf1356e05d39666be527a_8"; // 视频vid
$secretkey= "your secretkey"; // 保利威点播账号的secretkey
$ts=time()*1000;  // 10位的秒级时间戳，后面加多3个0，最后为13位的数值
$sign = md5($secretkey.$vid.$ts); 

屏幕录像是最难防范的一种视频盗版方式，保利威播放器提供的防录屏跑马灯功能，通过设定文字内容（一般是观众的身份ID信息）在视频上不规则滚动，以此来警示盗版者，达到视频版权保护的效果。

另外在用户网站中，除了通过登录信息（cookies）验证观众是否有权限访问视频播放页面外，还可以通过保利威播放器验证观众是否有播放某一个视频的权限，从而实现对观众权限的双重验证。

防录屏跑马灯的视频介绍：防录屏神器–跑马灯（视频）。

实现流程

实现步骤

一、管理后台设置

1. 登录云点播管理后台，点击 【设置】 → 【视频设置】，进入视频设置页面。

2. 在授权播放和防录屏跑马灯接口设置栏中，填写业务方的接口服务URL。
   

播放器在请求授权接口时，会自动适配以下情况：

1. 当填写的是完整的URL时，播放器会直接请求，例如：http://mywebsite.com/interface/validate。
2. 当填写的是不带协议头的接口地址时，播放器会根据当前页面的请求协议自动补全。例如填写的是：//mywebsite.com/interface/validate，当前页面使用https协议访问，那么实际请求的是：https://mywebsite.com/interface/validate。
3. 当填写的是不带协议头和HOST的接口地址时，播放器会根据当前页面的请求协议和HOST自动补全。例如填写的是：/interface/validate 或 interface/validate，当前页面的域名是mywebsite2.com，且页面使用http协议访问，那么实际请求的是：http://mywebsite2.com/interface/validate。

二、业务方服务端实现

1、播放器端请求

当管理后台设置授权播放和跑马灯接口后，Polyv播放器在播放视频时会首先请求后台设置的接口，请求的方式为GET，并且会附带vid、code、t、callback这四个参数，例如：https://www.mywebsite.com/validate?vid=e2e84a73837363106d8d257f60e55c4c_e&code=&t=1457938821973&callback=polyvObject16209048491895664483_1457938783908&_=1457938784101。

其中code为播放器嵌入代码中的参数，值可以自定义；t为播放器产生的随机数。播放器示例代码如下：

<script src='https://player.polyv.net/script/player.js'></script>
<div id='player'></div>
<script>
var player = polyvPlayer({
    wrap: '#player',
    width: 800,
    height: 533,
    vid: '88083abbf5bcf1356e05d39666be527a_8',   
    code: 'myCodeValue'  // 用户可自定义参数值，也可以不设置此参数，那么在请求接口时该参数值为空。参数值为中文时需要做base64URLSafe。
});
</script>

由于H5播放器通过Ajax方式请求用户接口，需要跨域请求，因此需要callback参数。而Flash播放器是通过跨域文件实现跨域，所以不需要callback参数，请求接口时只会提交vid、code和t三个参数。Flash播放器实现跨域请参考跨域访问设置。

2、服务端接口实现

业务方服务端接口如果只需实现授权验证的功能，只需返回 status、username、sign三个参数给播放器验证即可。

服务端实现的PHP示例如下：

// validate.php
<?php
$username = "elvis"; // 用户昵称, 若值为中文需要urlencode('张三')，可从session获取
$secretkey = "secretkey"; // 登录保利威管理后台，点击 【设置】 → 【API接口】获取
$vid=$_GET["vid"];
$t = $_GET["t"];
$code = $_GET["code"];

if($username=="elvis"){ 
  $status = 1; // 业务方可自定义授权验证逻辑
}else {
  $status = 2;
}
if(!empty($_GET["callback"])){
  $callback = $_GET["callback"];
}else{
  $callback = '';
}

$sign=md5("vid=$vid&secretkey=$secretkey&username=$username&code=$code&status=$status&t=$t");
$array=Array("status"=>$status,"username"=>$username,"sign"=>$sign);
$Json = json_encode($array);

if($callback!=''){ //PC H5播放器会提交callback参数
  echo $callback."(".$Json.")";
} else{ //Flash播放器不提交callback参数
  echo "(".$Json.")";
}
?>

其中，sign的计算规则为：拼接vid、secretkey、username、code、status、t参数做MD5计算：

Plain ="vid=" + vid + "&secretkey=" + secretKey + "&username=" + username + "&code=" + code + "&status=" +status + "&t=" + t
sign = MD5.hash(Plain);

以下为接口返回示例：

  polyvObject16208229674372271079_1478765178186({
  "status":1,
  "username":"elvis",
  "sign":"1cca74bd55c6076091ed84807065e5b7"
  })
// 不提交callback参数时
{
  "status":1,
  "username":"elvis",
  "sign":"2c2bfb00314da7d768d50a7d1e93bd9f"
}

如果除了授权验证，还需实现跑马灯功能，则接口需要返回跑马灯相关的参数。

服务端实现的PHP示例如下：

// validate.php
<?php
$username = "elvis"; // 用户昵称, 若值为中文需要urlencode('张三')，可从session获取
$secretkey = "secretkey"; // 登录保利威管理后台，点击 【设置】 → 【API接口】获取
$vid=$_GET["vid"];
$t = $_GET["t"];
$code = $_GET["code"];
$fontSize="40";
$fontColor="0xFFE900";
$speed="200";
$filter="on";
$setting="3";
$alpha="1";
$filterAlpha="1";
$filterColor="0x3914AF";
$blurX="2";
$blurY="2";
$tweenTime="1";
$interval="5";
$lifeTime="3";
$strength="4";
$show="on";
$msg="Errormessage!";

if($username=="elvis"){ // 业务方可自定义授权验证逻辑
 $status = 1;
}else {
 $status = 2;
}

if(!empty($_GET["callback"])){
 $callback = $_GET["callback"];
}else{
 $callback = '';
}

$sign=md5("vid=$vid&secretkey=$secretkey&username=$username&code=$code&status=$status&t=$t&msg=$msg&fontSize=$fontSize&fontColor=$fontColor&speed=$speed&filter=$filter&setting=$setting&alpha=$alpha&filterAlpha=$filterAlpha&filterColor=$filterColor&blurX=$blurX&blurY=$blurY&interval=$interval&lifeTime=$lifeTime&tweenTime=$tweenTime&strength=$strength&show=$show");
$array = Array("status"=>$status,"username"=>$username,"sign"=>$sign,"msg"=>$msg,"fontSize"=>$fontSize,"fontColor"=>$fontColor,"speed"=>$speed,"filter"=>$filter,"setting"=>$setting,"alpha"=>$alpha,"filterAlpha"=>$filterAlpha,"filterColor"=>$filterColor,"blurX"=>$blurX,"blurY"=>$blurY,"tweenTime"=>$tweenTime,"interval"=>$interval,"lifeTime"=>$lifeTime,"strength"=>$strength,"show"=>$show,);
$Json = json_encode($array);

if($callback!=''){
 echo $callback."(".$Json.")";
} else{
 echo $Json;
}
?>

其中，sign的计算规则为（参数必须按照示例中的顺序拼接）：

Plain = "vid=" + vid + "&secretkey=" + secretKey + "&username=" + username + "&code=" + code + "&status=" + status + "&t=" + t + 
"&msg=" + msg + "&fontSize=" + fontSize + "&fontColor=" + fontColor + "&speed=" + speed +"&filter=" +filter + "&setting=" + setting + 
"&alpha=" + alpha + "&filterAlpha=" + filterAlpha  + "&filterColor=" + filterColor + "&blurX=" + blurX + "&blurY=" + blurY + 
"&interval=" + interval + "&lifeTime=" + lifeTime + "&tweenTime=" + tweenTime + "&strength=" + strength + "&show=" +show;
sign = MD5.hash(Plain);

例如：当vid="8f8482aaab11dd5f45f183a9192a04c5_8",secretkey="AiDQw1mAmi",username="suki",code="abc",status="1",t="143020010115550947",msg="Errormessage!",fontSize="40",fontColor="0xFFE900",speed="200",filter="on",setting="3",alpha="1",filterAlpha="1",filterColor="0x3914AF",blurX="2",blurY="2",interval="5",lifeTime="3",tweenTime="1",strength="4",show="on"时，
拼凑起来去MD5计算的字符串为:
vid=8f8482aaab11dd5f45f183a9192a04c5_8&secretkey=AiDQw1mAmi&username=suki&code=abc&status=1&t=143020010115550947&msg=Errormessage!&fontSize=40&fontColor=0xFFE900&speed=200&filter=on&setting=3&alpha=1&filterAlpha=1&filterColor=0x3914AF&blurX=2&blurY=2&interval=5&lifeTime=3&tweenTime=1&strength=4&show=on
则sign为MD5计算后32位小写的值：3b07f56f29b7fd728bf20020442338e7

以下为接口返回示例：

{
  "status":1,
  "username":"elvis",
  "sign":"6ab63590797e513d1b6c46b407413478",
  "msg":"Errormessage!",
  "fontSize":"40",
  "fontColor":"0xFFE900",
  "speed":"200",
  "filter":"on",
  "setting":"3",
  "alpha":"1",
  "filterAlpha":"1",
  "filterColor":"0x3914AF",
  "blurX":"2",
  "blurY":"2",
  "tweenTime":"1",
  "interval":"5",
  "lifeTime":"3",
  "strength":"4",
  "show":"on"
}

三、接口返回参数说明

1. 当接口只做授权验证用途时，只需返回 status、username和sign三个参数，跑马灯相关参数可不返回。
2. 请确保接口返回数据是utf-8编码，注意 status参数是整型，不能是字符串类型。
3. 目前跑马灯功能不支持在移动端H5播放器上使用。
4. 请尽量不要对播放器样式或\标签进行修改

Polyv Web播放器支持在视频中插入广告，广告类型有：

1. 片头广告：在视频开始前播放
2. 片尾广告：在视频结束后播放
3. 暂停广告：在视频暂停时显示
4. 弹窗广告：在视频播放的某个指定时间点弹窗显示

保利威云点播平台支持通过以下两种方式来设置广告：

方式一：通过点播管理后台设置

1. 登录云点播管理后台，点击 【广告管理】 → 【添加广告】，进入广告设置页面。

2. 在广告设置页面，您可以

   • 选择广告类型：片头、暂停、弹窗、片尾。
   • 设置广告的标题和描述信息。
   • 上传广告素材，支持JPEG，GIF，PNG，FLV, MP4格式，素材文件大小不超过500MB。
   • 为广告添加链接地址，点击跳转到指定页面。
   • 选择需要播放广告的视频分类。
   • 设置广告时长、是否允许跳过、跳过按钮的文案、以及在什么时间出现跳过按钮。
   • 设置广告投放的日期、时间段以及广告状态。

   

点击这里查看视频教程

方式二：通过播放器参数设置

除了在管理后台设置广告外，您还可以通过播放器参数进行更加灵活的控制。当管理后台和播放器参数都设置时，以播放器参数为准。

广告参数设置的代码示例如下：

<div id="player"></div>
<script src="//player.polyv.net/script/player.js"></script>
<script>
var player = polyvPlayer({
    wrap: '#player',
    width: 800,
    height: 533,
    vid: '88083abbf5bcf1356e05d39666be527a_8',
    adSkip: true, //是否显示跳过广告的按钮，默认为false
    adMatter: [{ // 广告参数详细配置
        location: 1, //广告位置： 1 片头广告，2 暂停广告，3 片尾广告，4 弹窗广告
        adtype: 1,  //广告资源类型： 1 图片广告，2 视频广告，3 swf广告（flash播放器生效）
        matterurl: 'https://myDomain.com/ad.mp4', //广告资源URL
        addrurl: 'http://www.polyv.net/', //广告点击跳转链接
        timesize: 5, //广告时长，单位：秒
        cataid: 1560331332756, //需播放广告的视频分类ID,默认为1
        poplocation: 1, //弹窗广告位置（1 右下角，2 右上角，3 左下角，4 左上角）
        popuptime: 45,//弹窗广告出现的时间(移动端无效)，单位：秒
        skiptime: 1, //广告跳过按钮出现时间
        skipenabled: true,//是否显示跳过按钮
        skipbutton: '跳过'//跳过按钮提示文案
    }]
});
</script>

说明：

1. 如果设置了adSkip参数，则不会读取adMatter数组里面的skipenabled参数。

Logo是企业形象的符号化体现，设置播放器Logo便于观众对企业品牌的识别、记忆，从而有效帮助企业品牌的树立和传播。

保利威云点播平台支持通过以下两种方式来设置播放器Logo：

方式一：通过点播管理后台设置

1. 登录云点播管理后台，点击 【播放器】 → 选择已创建的播放器（或新建播放器）→ 【修改】，进入播放器设置页面。
2. 在播放器Logo栏中，进行自定义设置。您可以：
   • 上传一张图片作为播放器Logo
   • 查看当前Logo图片
   • 为Logo添加链接地址，点击跳转到指定页面
   • 设置Logo不透明度和显示位置

点击这里查看视频教程

方式二：通过播放器参数设置

除了在管理后台设置播放器Logo以外，您还可以通过播放器参数进行更加灵活的控制。当管理后台和播放器参数都设置时，以播放器参数为准。

Logo参数设置的代码示例如下：

<div id="player"></div>
<script src="//player.polyv.net/script/player.js"></script>
<script>
var player = polyvPlayer({
    wrap: '#player',
    width: 800,
    height: 533,
    vid: '88083abbf5bcf1356e05d39666be527a_8',   
    logo: {
      logo_width: 200, //Logo宽 默认 'auto'
      logo_height: 'auto', //Logo高 默认 'auto'
      logo_url: 'http://www.polyv.net/test.png', // Logo图片URL
      logo_pos: 2, //Logo显示位置，取值范围为：{0,1,2,3,4}，分别代表：隐藏、左上、右上、左下、右下
      logo_link: 'http://www.polyv.net/', // 点击Logo的跳转链接 (选填)
      logo_alpha: 50, //Logo透明度，取值范围：(0,100)
      logoOffset: '40,50',//Logo偏移量，单位：百分比。坐标原点为播放器左上角，只在Logo位置为左上、右上时生效
      logo_resize: true //默认值为false，为true时会根据播放器窗口大小动态调整Logo的尺寸，若设置了logo宽高则该参数不生效
   }
});
</script>

说明：

1. Logo图片支持的格式有：jpeg、png、gif，为了更好的显示效果，建议使用png格式的图片。
2. Logo图片尺寸小于200*200时会显示原始尺寸，大于200*200像素时会被等比缩放。
3. Logo与水印的实现机制不同：
   1. Logo是将图片添加到播放器窗口，不会对视频源文件产生影响。Logo可随时更换、调整显示位置或关闭。
   2. 水印是在视频转码时将图片“压”进视频流中，成为了视频的一部分。修改水印设置只对新上传的视频生效，不能对已发布视频的水印做任何修改。
4. 移动端H5播放器由于系统或浏览器限制，在部分情况下无法显示Logo：
   • iOS设备在全屏播放视频时，会强制使用系统播放器，此时无法显示播放器Logo。
   • Android设备下大多数的国内浏览器厂商都会在视频播放时挟持标签，由浏览器内置播放器播放视频（且视频层级最高无法叠加页面元素），这种情况下也无法显示播放器Logo。

Polyv Web播放器支持设置观众信息参数，设置后在播放器上报的观看日志中会附带观众信息，这样用户就可以通过管理后台的统计页面或服务端API来查看特定观众的视频观看情况了。

一、观众信息设置

播放器设置观众信息参数的代码示例如下：

<div id="player"></div>
<script src="//player.polyv.net/script/player.js"></script>
<script>
var player = polyvPlayer({
    wrap: '#player',
    width: 800,
    height: 533,
    vid: '88083abbf5bcf1356e05d39666be527a_8',   
    viewerInfo: {
        viewerId: '1555313336634', // 观众ID
        viewerName: 'polyv', // 观众昵称
        viewerAvatar: 'https://my.domain.com/user/avatar.png', // 观众头像URL
        viewerExtraInfo1:'', // 自定义额外信息字段1
        viewerExtraInfo2:'', // 自定义额外信息字段2
        viewerExtraInfo3:'' // 自定义额外信息字段3
     }
});
</script>

viewerinfo参数字段说明

二、查看统计数据

1. 通过管理后台查看

观看日志：

高级分析：

视频高级分析功能的详细介绍请点击这里。

2. 通过服务端API获取

用户可通过调用获取视频日志接口，根据接口返回的每条观看记录中的viewerId、viewerName等信息，掌握观众观看视频的情况。