设置频道的暖场设置开关

接口URL

https://api.polyv.net/live/v3/channel/set-warmup-enabled

接口说明

1、接口用于设置频道的暖场开关
2、接口支持https

支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp long 13位当前时间戳
sign string 签名值
channelId int 频道号
warmUpEnabled string 开关值,Y或N,Y表示开启,N表示关闭

响应成功JSON示例:

{
  "code": 200, 
  "status": "success", 
  "message": "", 
  "data": "success"
}

响应失败JSON示例:

未输入appId

{
    "code": 400,
    "status": "error",
    "message": "appId is required.",
    "data": ""
}

appId不正确

{
    "code": 400,
    "status": "error",
    "message": "application not found.",
    "data": ""
}

时间戳错误

{
    "code": 400,
    "status": "error",
    "message": "invalid timestamp.",
    "data": ""
}

签名错误

{
    "code": 403,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}

字段说明

参数名 说明
code 响应代码,成功为200,失败为400,签名错误为401,异常错误500
status 成功为success,失败为error
message 错误时为错误提示消息
data 修改成功过时为success

php请求示例

<?php
//引用config.php
include '/srv/http/config.php';

$params = array(
  'appId' => $appId,
  'timestamp' => $timestamp,
  'channelId' => '206204',
  'warmUpEnabled' => 'Y'  
);

//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法
$params['sign'] = $sign;

$url = "http://api.polyv.net/live/v3/channel/set-warmup-enabled?".http_build_query($params);

$curl = curl_init();
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_TIMEOUT, 500);
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_URL, $url);
$res = curl_exec($curl);
curl_close($curl);

echo $res;
?>

签名规则(config.php文件代码查看)

http://dev.polyv.net/2018/liveproduct/l-api/rule/sign/

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

设置播放器暂停广告

接口URL

http://api.polyv.net/live/v2/channelAdvert/{channelId}/updateStop

接口说明

1、接口用于设置某频道播放器的暂停广告
2、接口URL中的{channelId}为 频道ID
3、接口支持https

支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,32位大写MD5值
enabled string Y-打开,N-关闭;设置开关时,其余设置参数无效
stopAdvertImage string 图片地址,不填代表删除
stopAdvertHref string 点击图片跳转Url

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": true
}

响应失败JSON示例:

未输入appId

{
    "code": 400,
    "status": "error",
    "message": "appId is required.",
    "data": ""
}

appId不正确

{
    "code": 400,
    "status": "error",
    "message": "application not found.",
    "data": ""
}

时间戳错误

{
    "code": 400,
    "status": "error",
    "message": "invalid timestamp.",
    "data": ""
}

签名错误

{
    "code": 403,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}

频道不存在

{
    "code": 400,
    "status": "error",
    "message": "channel not found.",
    "data": ""
}

开关参数错误

{
    "code": 400,
    "status": "error",
    "message": "invalid enabled value",
    "data": ""
}

非法请求

{
    "code": 403, 
    "status": "error", 
    "message": "operation forbidden.", 
    "data": ""
}

字段说明

参数名 说明
code 请求结果代码,成功为200 错误为400,签名错误为403
status 请求结果,成功时为"success"错误时为"error"
message 错误信息,请求成功时为空串,错误时错误信息
data 请求成功为true,错误为空串

php请求示例

<?php
//引用config.php
include 'config.php';

$stopAdvertImage = "http://www.image.com";
$stopAdvertHref = "http://www.href.com";
$channelId="123713";

$params = array(
  'appId' => $appId,
  'timestamp' => $timestamp,
  'stopAdvertImage' => $stopAdvertImage,
  'stopAdvertHref' => $stopAdvertHref
);

//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法


$url="http://api.polyv.net/live/v2/channelAdvert/".$channelId."/updateStop";

function post($url, $post_data = '', $timeout = 5){
   $ch = curl_init();
   curl_setopt ($ch, CURLOPT_URL, $url);
   curl_setopt ($ch, CURLOPT_POST, 1);
   if($post_data != ''){
      curl_setopt($ch, CURLOPT_POSTFIELDS, $post_data);
   }

   curl_setopt ($ch, CURLOPT_RETURNTRANSFER, 1);
   curl_setopt ($ch, CURLOPT_CONNECTTIMEOUT, $timeout);
   curl_setopt($ch, CURLOPT_HEADER, false);
   $file_contents = curl_exec($ch);
   curl_close($ch);
   return $file_contents;
}

$params["sign"] = $sign;
echo post($url, $params);
?>

签名规则(config.php文件代码查看)

http://dev.polyv.net/2018/liveproduct/l-api/rule/sign/

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

设置播放器片头广告

接口URL

http://api.polyv.net/live/v2/channelAdvert/{channelId}/updateHead

接口说明

1、接口用于设置某频道播放器的片头广告
2、接口URL中的{channelId}为 频道ID
3、接口支持https

支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,32位大写MD5值
enabled string Y-开启,N-关闭;设置开关时,其余设置参数无效
headAdvertType string 广告类型,NONE-无广告,IMAGE-图片广告,FLV-视频广告
headAdvertMediaUrl string 广告地址
headAdvertHref string 广告跳转地址
headAdvertDuration int 广告时长
headAdvertWidth int 广告宽度
headAdvertHeight int 广告高度

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": true
}

响应失败JSON示例:

未输入appId

{
    "code": 400,
    "status": "error",
    "message": "appId is required.",
    "data": ""
}

appId不正确

{
    "code": 400,
    "status": "error",
    "message": "application not found.",
    "data": ""
}

时间戳错误

{
    "code": 400,
    "status": "error",
    "message": "invalid timestamp.",
    "data": ""
}

签名错误

{
    "code": 403,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}

频道不存在

{
    "code": 400,
    "status": "error",
    "message": "channel not found.",
    "data": ""
}

频道类型错误

{
    "code": 400,
    "status": "error",
    "message": "invalid advert type",
    "data": ""
}

开关参数错误

{
    "code": 400,
    "status": "error",
    "message": "invalid enabled value",
    "data": ""
}

非法请求

{
    "code": 403, 
    "status": "error", 
    "message": "operation forbidden.", 
    "data": ""
}

字段说明

参数名 说明
code 请求结果代码,成功为200 错误为400,签名错误为403
status 请求结果,成功时为"success"错误时为"error"
message 错误信息,请求成功时为空串,错误时错误信息
data 请求成功为true,错误为空串

php请求示例

<?php
//引用config.php
include 'config.php';

//接口需要的参数(非sign)赋值
$channelId="123713";

$headAdvertType = "none";
$headAdvertMediaUrl = "http://www.headAdvertMediaUrl.com";
$headAdvertHref = "http://www.headAdvertHref.com";
$headAdvertDuration = 50;
$headAdvertWidth = 100;
$headAdvertHeight = 200;

$params = array(
    'appId' => $appId,
    'timestamp' => $timestamp,
    'headAdvertType' => $headAdvertType,
    'headAdvertMediaUrl' => $headAdvertMediaUrl,
    'headAdvertHref' => $headAdvertHref,
    'headAdvertDuration' => $headAdvertDuration,
    'headAdvertWidth' => $headAdvertWidth,
    'headAdvertHeight' => $headAdvertHeight
  );

//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法


$url="http://api.polyv.net/live/v2/channelAdvert/".$channelId."/updateHead";

function post($url, $post_data = '', $timeout = 5){
   $ch = curl_init();
   curl_setopt ($ch, CURLOPT_URL, $url);
   curl_setopt ($ch, CURLOPT_POST, 1);
   if($post_data != ''){
      curl_setopt($ch, CURLOPT_POSTFIELDS, $post_data);
   }

   curl_setopt ($ch, CURLOPT_RETURNTRANSFER, 1);
   curl_setopt ($ch, CURLOPT_CONNECTTIMEOUT, $timeout);
   curl_setopt($ch, CURLOPT_HEADER, false);
   $file_contents = curl_exec($ch);
   curl_close($ch);
   return $file_contents;
}

$params["sign"] = $sign;
echo post($url, $params);
?>

签名规则(config.php文件代码查看)

http://dev.polyv.net/2018/liveproduct/l-api/rule/sign/

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

直播播放器音/视频模式切换

POLYV直播播放器,可以进行音视频观看模式的切换。
视频模式:即播放器中即播放音频也播放视频。
音频模式:即播放器中仅播放音频,音频模式对比视频模式播放其中一个优点是加载快,节省流量,缺点是不能观看直播内容,直播效果稍欠缺。

播放器调用示例

<div id="e8888b74d1229efec6b4712e17cb6b7a_e"></div>
<script src="//player.polyv.net/script/player.js"></script>
<script>
  var player = polyvPlayer({
    wrap: '#e8888b74d1229efec6b4712e17cb6b7a_e',
    width: 800,
    height: 533,
    vid: 'e8888b74d1229efec6b4712e17cb6b7a_e',
    useAudio: true
  });
</script>

选项

useAudio

类型:Boolean

说明:默认播放模式 ,可设置为 true/false 。设置为false或者不设置则使用视频模式播放,设置为true则使用音频模式播放。

实例方法

player.switchMMode(type)

参数:type

类型:String

说明:播放模式,可设置为 audio/video。分别为音频模式播放和视频模式播放。

实现效果

效果一:

效果二:

实现此效果可切换到音频模式播放时将播放器父容器高度设置为0,并在页面设置自定义样式。

ps:部分安卓手机切换到音频模式时,音量会变小。由于硬件原因,并且不能通过js控制video/audio标签音量,暂时无法解决。

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

设置播放器自定义url跑马灯

接口URL

http://api.polyv.net/live/v2/channelRestrict/{channelId}/set-diyurl-marquee

接口说明

1、通过接口可以设置播放器防录屏自定义url跑马灯开关,在开启时需提交url参数。
2、接口URL中的{channelId}为 频道ID

具体请参考自定义url跑马灯.

支持格式

JSON

请求方式

GET,POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级时间戳,3分钟内有效
marqueeRestrict Y 或 N 自定义url防录屏跑马灯开关
url string 自定义url, 在开关为关时可为空,开启开关时为必填
sign string 签名,32位大写MD5值

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": "设置成功"
}

响应失败JSON示例:

未输入appId

{
    "code": 400,
    "status": "error",
    "message": "appId not found.",
    "data": ""
}

appId不正确

{
    "code": 400,
    "status": "error",
    "message": "application not found.",
    "data": ""
}

时间戳错误

{
    "code": 400,
    "status": "error",
    "message": "invalid timestamp.",
    "data": ""
}

签名错误

{
    "code": 403,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}

频道号错误

{
    "code": 400,
    "status": "error",
    "message": "channel not found.",
    "data": ""
}

跑马灯开关错误

{
    "code": 400,
    "status": "error",
    "message": "marqueeRestrict is wrong",
    "data": ""
}

跑马灯开关为开时,未提交自定义Url

{
    "code": 400,
    "status": "error",
    "message": "url is required",
    "data": ""
}

其他情况

{
    "code": 400,
    "status": "error",
    "message": "设置失败",
    "data": ""
}

字段说明

参数名 说明
code 请求结果代码,成功为200
status 请求结果,成功时为"success"错误时为"error"
message 错误信息,请求成功时为空,错误时错误信息

php请求示例

<?php

//引用config.php
include 'config.php';

//接口需要的参数(非sign)赋值
$channelId = "127075";
$marqueeRestrict = "Y";
$url = "http://demo.polyv.net/wfy/marquee.php";

$params = array(
    'appId'=>$appId,
    'url'=>$url,
    'marqueeRestrict'=>$marqueeRestrict,
    'timestamp'=>$timestamp
  );

//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法

//接口请求url
$url = "http://api.polyv.net/live/v2/channelRestrict/$channelId/set-diyurl-marquee?appId=$appId&timestamp=$timestamp&sign=$sign&url=$url&marqueeRestrict=$marqueeRestrict";

//输出接口请求结果
echo file_get_contents($url);

?>

签名规则(config.php文件代码查看)

http://dev.polyv.net/2018/liveproduct/l-api/rule/sign/

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

直播播放器外嵌后台统计参数发送

播放器使用多终端代码在页面外嵌的时候,由于没有添加用户ID或用户昵称,导致后台观看日志统计中缺少用户ID或用户昵称区分学员信息。
若添加以下参数则可以解决上述问题。

一、播放器外嵌添加参数

<script src="https://player.polyv.net/livescript/liveplayer.js"></script>
<div id='player'></div>

<script type="text/javascript">

var player = polyvObject('#player').livePlayer({
    'width:'498',
    'height':'409',
    'uid':'e3wx706i3v',
    'vid':'102236',
    'param1':'1505212490999',
    'param2':'广州观众/27915'
});
</script>

选项

参数 类型 默认值 说明
width number \ string - 播放器设置宽度
height number \ string - 播放器设置高度
uid string - 直播频道用户ID
vid string - 直播频道
param1 string - 用户ID
param2 string - 用户昵称

二、直播后台统计数据

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

直播播放器API

播放器调用方法

<script src="https://player.polyv.net/livescript/liveplayer.js"></script>
<div id='player'></div>
<script type="text/javascript">
var player = polyvObject('#player').livePlayer({
    'width':'498',
    'height':'409',
    'uid':'e3wx706i3v',
    'vid':'99863',
    'forceH5':true
});
</script>

POLYV直播播放器参数

参数名 取值 说明
width Number / String 播放器宽度
height Number / String 播放器高度
uid String 直播账号
vid String 直播频道号
param1 Number / String 后台统计参数
param2 Number / String 后台统计参数
df Number (0 标清 1 高清 2 超清) 多码率功能,默认清晰度
banMultirate Boolean 多码率功能,是否隐藏清晰度选择面板
forceH5 Boolean 优先使用H5播放器

POLYV直播播放器接口

函数名 参数 说明
j2s_resumeVideo / 播放视频操作
j2s_pauseVideo / 暂停视频操作

POLYV直播播放器事件

函数名 参数 说明
s2j_onInitOver vid 播放器初始化完毕事件
s2j_onStartPlay vid 视频播放开始事件
s2j_onOver vid 视频播放结束事件
s2j_onPlay vid 视频播放回调事件
s2j_onPause vid 视频暂停回调事件
以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

直播播放器错误提示

  • 编号为LIVE-#001,表示传入的参数非法
  • 编号为LIVE-#002,表示用户状态异常
  • 编号为LIVE-#003,表示服务已过期
  • 编号为LIVE-#004,表示直播频道不存在或已关闭
  • 编号为LIVE-#005,表示直播可用分钟数不足
  • 编号为LIVE-#006,表示频道已达到最大同时在线观看人数
  • 编号为LIVE-#007,表示网站白名单限制
  • 编号为LIVE-#008,表示网站黑名单限制
  • 编号为LIVE-#009,表示地区白名单限制
  • 编号为LIVE-#010,表示地区黑名单限制
  • 编号为LIVE-#011,表示直播播放配置文件加载失败/解析错误
  • 编号为LIVE-#012,表示授权或跑马灯加载失败/解析错误/不通过
  • 编号为LIVE-#022,表示跑马灯被删除/修改
  • 编号为LIVE-#014,表示超过账号最高并发总人数限制
  • 编号为LIVE-#015,表示播放器识别到抓流
  • 编号为LIVE-#016,表示播放器禁止小窗播放
以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

直播播放器控制栏和弹幕开关

一、默认开启或关闭弹幕开关

参数:isBarrage=on/off
适用终端:PC端、移动端
使用效果:设置isBarrage=on或不设置改参数时,移动端或PC端的弹幕开关为开,会在播放器里显示弹幕内容;
设置isBarrage=off时,移动端或PC端的弹幕开关为关,需要手动点击开关才能显示弹幕,具体效果图如下:
终端 打开弹幕 关闭弹幕
移动 移动端弹幕开 移动端弹幕关
PC PC端弹幕开 PC端弹幕关
使用示例:在使用此参数时,请确认您开发了弹幕功能(点击POLYV 直播弹幕使用介绍进行了解和开发),在实现了弹幕功能的前提下,在代码中增加参数'isBarrage':'off',即可实现默认不显示弹幕功能

弹幕开关示例

二、控制栏显示

参数:skin_float=on/off  barStaticTime=数字
参数介绍:skin_float=on/off 表示控制栏在视频区域内/外,barStaticTime表示控制栏自动隐藏的时间,以秒为单位
使用说明:这两个参数只适用于PC端,其中skin_float默认为off,对控制栏在视频区域外的播放器皮肤才生效,设置了skin_float=off时,全屏也还是为on的效果。
使用效果:skin_float=on 时:

控制栏在视频区域内

skin_float=off 时:

控制栏在视频区域外

使用示例:控制栏在视频区域外,控制栏隐藏时间为5秒:'flashvars':{"skin_float":"off","barStaticTime":"5"}

使用示例

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

设置播放器暖场图片

接口URL

http://api.polyv.net/live/v2/channels/{channelId}/update

接口说明

1、修改播放器的暖场图片
2、暖场视频和暖场图片是处于非直播状态时,播放器显示的画面,两者在同一时间只能显示一种,
以最晚设置者为准,若想删除暖场画面,则将coverImage或warmUpFlv的值设为"http://"。
3、接口URL中的{channelId}为 频道ID
4、接口支持https协议

支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级时间戳,3分钟内有效
coverImage string 暖场图片地址,图片大小建议:800x450,支持PNG、JPEG、GIF格式
coverHref string 暖场图片跳转地址
sign string 签名,32位大写MD5值

响应成功JSON示例:

{
  code: 200,
  status: "success",
  message: "",
  data: true
}

响应异常JSON示例:

{
  code: 400,
  status: "error",
  message: "invalid timestamp.",
  data: ""
}

字段说明

参数名 说明
code 响应状态码
status 响应状态
message 异常错误信息
data 异常错误数据

php请求示例

<?php

//引用config.php
include 'config.php';

//接口需要的参数(非sign)赋值
$channelId = "127075";
$coverImage= "http://static.live.polyv.net/uploaded/images/2016/07/egqo3soa33.jpg"; //图片地址

$params = array(
    'appId'=>$appId,
    'coverImage'=>$coverImage,
    'timestamp'=>$timestamp
  );

//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法

//接口请求url
$url = "http://api.live.polyv.net/v2/channels/$channelId/update?appId=$appId&timestamp=$timestamp&coverImage=$coverImage&sign=$sign";
$ch = curl_init() or die ( curl_error() );
curl_setopt( $ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $ch, CURLOPT_CONNECTTIMEOUT, 360);
$response = curl_exec ( $ch );
curl_close ( $ch );
echo $response;

?>

注意:设置暖场图片地址的域名下必需增加crossdomain.xml文件

<cross-domain-policy>
<allow-access-from domain="*"/>
</cross-domain-policy>

签名规则(config.php文件代码查看)

http://dev.polyv.net/2018/liveproduct/l-api/rule/sign/

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...