设置频道暖场视频

接口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分钟内有效
warmUpFlv string 暖场视频地址,移动端不支持FLV视频文件,建议使用MP4视频文件
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";
$warmUpFlv = "http://demo.polyv.net/t/video/test.mp4"; 

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

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

//接口请求url
  $url = "http://api.live.polyv.net/v2/channels/$channelId/update?appId=$appId&timestamp=$timestamp&warmUpFlv=$warmUpFlv&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;

?>

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

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

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

设置播放器Logo

接口URL

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

接口说明

1、修改播放器logo图片
2、接口URL中的{channelId}为 频道ID
3、接口支持https协议

支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级时间戳,3分钟内有效
logoImage string logo图片地址,建议大小为:长方形140x50或正方形50x50
logoOpacity string logo透明度,取值范围为(0,1],即大于0,并且小于等于1
logoPosition string logo位置,取值为为左上角(tl)、右上角(tr)、左下角(bl)、右下角(br)
logoHref string logo图片点击跳转链接
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";
$logoImage = "http://demo.polyv.net/wfy/live/logo.jpg"; //播放器封面图
$logoOpacity = "0.5"; //透明度,取值范围为(0,1]
$logoPosition = "tr"; //图片位置,取值为左上(tl)、右上(tr)、左下(bl)、右下(br)
$logoHref ="http://www.polyv.net"; //图片点击跳转链接

$params = array(
    'appId'=>$appId,
    'logoImage'=>$logoImage,
    'logoOpacity'=>$logoOpacity,
    'logoPosition'=>$logoPosition,
    'logoHref'=>$logoHref,
    'timestamp'=>$timestamp
  );

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

//接口请求url
$url = "http://api.live.polyv.net/v2/channels/$channelId/update?appId=$appId&timestamp=$timestamp&logoHref=$logoHref&logoImage=$logoImage&logoOpacity=$logoOpacity&logoPosition=$logoPosition&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;

?>

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

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

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

修改频道名称

接口URL

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

接口说明

1、作用:修改频道名称
2、接口URL中的{channelId}为 频道ID
3、接口支持https协议

支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级时间戳,3分钟内有效
name 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";
$name = "测试频道号"; 

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

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

//接口请求url

$url = "http://api.live.polyv.net/v2/channels/$channelId/update?appId=$appId&timestamp=$timestamp&name=$name&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;

?>

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

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

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

获取频道号列表

接口URL

http://api.polyv.net/live/v1/users/{userId}/channels

接口说明

1、查询频道号列表
2、接口URL中的{userId}为 直播账号ID
3、接口支持https协议

支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
sign string 签名,为32位大写的MD5值
timestamp string 当前13位毫秒级(兼容10位秒级)时间戳,3分钟内有效

响应成功JSON

{
   status: "success",
   result: [ 
       104170,
       104100,
       104099,
       104018,
       103485,
       103328,
       101599,
       101594,
       101378
  ] 
}

响应异常JSON示例:

{
   code: "invalid.request",
   msg: "signature error." 
}

字段说明

参数名 说明
status 响应状态
result 响应结果
code 异常错误代码
msg 异常错误信息

php请求示例

<?php

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

//接口URL上变量
$userId = "XXXXXXXXX";
//接口需要的参数(非sign)赋值
$params = array(
    'appId'=>$appId,
    'timestamp'=>$timestamp
  );

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

//接口请求url
$url ="http://api.live.polyv.net/v1/users/".$userId."/channels?appId=".$appId."&timestamp=".$timestamp."&sign=".$sign;

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

?>

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

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

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

禁播直播频道

接口URL

http://api.polyv.net/live/v1/stream/{channelId}/cutoff

接口说明

1、作用:禁止频道号推流
2、接口支持https协议
3、接口URL中的{channelId}为 频道ID

支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级(兼容10位秒级)时间戳,3分钟内有效
userId string 直播账号ID
sign string 签名,为32位大写的MD5值

响应成功JSON示例:

{
  status: "success",
  result: "success"
}

响应异常JSON示例:

{
  status: "failure",
  result: "cut stream failure."
}

字段说明

参数名 类型 说明
status string 状态值
result string 相应的结果

php请求示例

<?php

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

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

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

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

//接口请求url
$url = "http://api.live.polyv.net/v1/stream/$channelId/cutoff?appId=$appId&timestamp=$timestamp&userId=$userId&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;

?>

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

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

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

获取频道观看日志

接口URL

http://api.polyv.net/live/v1/statistics/{channelId}/viewlog

接口说明

1、获取观看日志
2、接口支持https协议
3、接口URL中的{channelId}为 频道ID

支持格式

JSON

请求方式

 GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
currentDay string 查询日期,格式:yyyy-MM-dd
param1 string 观看用户ID
userId string 直播账号ID
appId string 从API设置中获取,在直播系统登记的appId
sign string 签名,为32位大写的MD5值
timestamp string 当前13位毫秒级(兼容10位秒级)时间戳,3分钟内有效

响应成功JSON示例:

{
    status: "success",
    result: [
    {
        playId: "1466737508948X1585577",
        userId: "edvf2fpec9",
        channelId: 101385,
        playDuration: 82,
        stayDuration: 84,
        flowSize: 3182842,
        sessionId: "",
        param1: "84261eee56664383840a585c7fb359eb",
        param2: "广州观众/53049",
        param3: "live",
        param4: "",
        param5: "",
        ipAddress: "121.33.51.211",
        country: "中国",
        province: "广东",
        city: "广州",
        isp: "",
        referer: "http://live.videocc.net/watch/101385",
        userAgent: "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/49.0.2623.112 Safari/537.36",
        operatingSystem: "Windows 7",
        browser: "Chrome",
        isMobile: "N",
        currentDay: "2016-06-24",
        createdTime: 1467014780000,
        lastModified: 1467049716000
    }
    ]
}

响应异常JSON示例:

{
    status: "app_not_found",
    result: "application not found."
}

字段说明

字段 说明
playId 表示此次播放动作的ID
userId 用户ID
channelId 频道号
playDuration 播放时长
stayDuration 缓存时长
flowSize 流量大小
sessionId 用户自定义参数,如学员ID等
param1/2/3/4/5 POLYV系统参数
ipAddress IP地址
country 国家
province 省份
city 城市
isp ISP运营商
referer 播放视频页面地址
userAgent 用户设备
operatingSystem 操作系统
browser 浏览器
isMobile 是否为移动端
currentDay 日志查询日期 (格式为:yyyy-MM-dd)
createdTime 日志创建日期 (13位时间戳)
lastModified 日志更新日期 (13位时间戳)

php请求示例

<?php

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

//接口需要的参数(非sign)赋值
$userId = "XXXXXXXX";
$channelId = "101385";
$currentDay = "2016-06-12";//查询的日期,格式:yyyy-MM-dd
$param1 = "8b1ed9db009948a7987fb8af4db5639f";//用户ID

$params = array(
    'appId'=>$appId,
    'userId'=>$userId,
    'currentDay'=>$currentDay,
    'param1'=>$param1,
    'timestamp'=>$timestamp
  );

//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法
//接口请求url
$url = "http://api.live.polyv.net/v1/statistics/$channelId/viewlog?appId=$appId&currentDay=$currentDay&param1=$param1&timestamp=$timestamp&userId=$userId&sign=$sign";

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

?>

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

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

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

获取频道实时在线人数

接口URL

http://api.polyv.net/live/v1/statistics/{channelId}/realtime

接口说明

1、在直播中,获取实时观看的人数
2、接口支持https协议
3、接口URL中的{channelId}为 频道ID

支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级(兼容10位秒级)时间戳,3分钟内有效
userId string 直播账号ID
sign string 签名,为32位大写的MD5值

响应成功JSON示例:

{
  status: "success",
  result: [
    {
      time: "04:01:38",
      count: "0"
    },
    {
      time: "04:01:30",
      count: "1"
    },
    {
      time: "04:01:22",
      count: "2"
    },
    {
      time: "04:01:14",
      count: "2"
    },
    {
      time: "04:01:06",
      count: "2"
    },
    {
      time: "04:00:58",
      count: "1"
    },
    {
      time: "04:00:50",
      count: "1"
    },
    {
      time: "04:00:42",
      count: "2"
    },
    {
      time: "04:00:34",
      count: "2"
    },
    {
      time: "04:00:26",
      count: "2"
    },
    {
      time: "04:00:18",
      count: "1"
    },
    {
      time: "04:00:10",
      count: "2"
    },
    {
      time: "04:00:02",
      count: "2"
    },
    {
      time: "03:59:54",
      count: "3"
    },
    {
      time: "03:59:46",
      count: "2"
    }
  ]
}

响应异常JSON示例:

{
   code: "invalid_argument",
   msg: "userId is blank."
}

字段说明

参数名 类型 说明
status string 状态值
result string 相应的结果
time string 统计的时间点(时间格式:12H)
count string 某个时间点实时观看人数

php请求示例

<?php

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

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

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

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

//接口请求url
$url = "http://api.live.polyv.net/v1/statistics/$channelId/realtime?appId=".$appId."&timestamp=".$timestamp."&userId=".$userId."&sign=".$sign;

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

?>

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

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

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

设置直播弹幕

一、嵌入直播播放器

页面代码中嵌入以下代码, 在POLYV 直播后台【我的直播】中【播放器嵌入】页面可见。
<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',
'flashvars':{"is_barrage":"on"},
'uid':'e3wx706i3v',
'vid':'99853'
});
</script>

二、接口

示例页:

http://playertest.polyv.net/player2/test/demo/Livedanmu.html

function j2s_setBarrage( ){
   return true;
}
弹幕功能开关,必须返回 true. 播放器获取参数后判断是否开启弹幕功能。
function j2s_showBarrage( ){
   if( player!=undefined&&player.j2s_showBarrage!=undefined ){
      player.j2s_showBarrage( );
   }
}
显示弹幕,默认为显示。
function j2s_hideBarrage( ){
   if( player!=undefined && player.j2s_hideBarrage!=undefined ){
      player.j2s_hideBarrage( );
   }
}
隐藏弹幕。
function j2s_addBarrageMessage( _str ){
   if( player!=undefined && player.j2s_addBarrageMessage!=null){
      player.j2s_addBarrageMessage(_str );
   }
}
弹幕发送,参数为标准 JSON 格式字符串。
'[{
"msg":"1463bf66ce3",
"fontSize":"24",
"fontColor":"0xCCCC00",
"fontMode":"roll"
}]'
_str 字符串参数示例:
参数名 参数值 意义 是否必须项
msg string 弹幕发送消息
fontSize string 弹幕字体大小
fontColor string 弹幕字体颜色
fontMode string 弹幕进入效果 &nbps roll:右端横向进入
注:移动端弹幕发送弹幕字体大小,弹幕字体颜色均为固定值,不受参数设置控制。
以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

获取频道直播状态

接口URL

http://api.polyv.net/live_status/query

接口说明

1、作用:获取频道直播状态
2、接口支持https协议

请求方式

GET

请求参数限制

true

请求参数

参数名 必选 类型 说明
stream string 可调用获取频道信息接口,获取stream字段的值

返回结果

如果正在直播,返回live,否则返回end。

请求示例:http://api.polyv.net/live_status/query?stream=eciyhturt820160305194727292

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