查询频道实时在线人数

接口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 某个时间点实时观看人数

说明:每个频道返回最近2分半钟(10秒一个点,15条数据)的实时在线人数信息。每个频道的结果列表按照时间降序排序。

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.polyv.net/live/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...

直播助手标题区

直播助手标题区主要有:显示logo、频道名称、网络状况、设备调试、设置等功能。
按以下分区介绍:
image007

快速直达:

  1. 企业logo
  2. 频道标题
  3. 上行带宽
  4. 设备调试
  5. 隐藏直播控制区
  6. 下拉拓展列表
  7. 最小化
  8. 关闭客户端

1. 企业Logo

image009
Logo区展示企业logo以及版本号,当前版本为POLYV4.0beta版本。(可定制

2.频道标题

image010
显示该频道号的频道名称,以及在开始直播后显示当前已直播时长。

3.上行带宽

image011
开始直播后该处会检测当前上行带宽,可以根据上行带宽判断是否满足直播。
如:一场获取了屏幕与摄像头600K码率的直播,需要上行带宽200Kb/S才能满足稳定直播的需求。

4.设备调试

image012
设备调试可对当前选择设备(麦克风以及扬声器)进行检测,同时切换直播音频源输入的设备。

4.1扬声器调试

image013
在点击设备调试后,即弹出扬声器检测窗口
1、图中标记1为,设备选择下拉列表,可对扬声器设备进行选择。
2、图中标记2为,扬声器音量检测条,判断扬声器设备是否可用。
如果音量检测条为绿色即设备正常可用。
如果音量检测条为灰色即设备不可用,设备不可用时根据异常提示进行排查。
image015

4.2麦克风调试

image017
在点击设备调试后,即弹出麦克风检测窗口
图中标记1为,设备选择下拉列表,可对麦克风设备进行选择。
图中标记2为,麦克风音量检测条,判断麦克风设备是否可用。
如果音量检测条为绿色即设备正常可用。
如果音量检测条为灰色即设备不可用,设备不可用时根据异常提示进行排查。
image015

5.隐藏直播控制区功能

image021
用户在直播中想看聊天室聊天信息又不想将客户端页面展示给观看时可点击该按钮,效果如下图。
image023image022image025

6.下拉拓展区

image0271、查看观看页
点击后打开直播观看页(注:在直播中打开直播观看页会有严重噪音效果)
2、系统设置
点击后打开系统设置窗口
3、直播帮助
点击后打开POLYV帮助中心网页。
4、意见反馈
可以在此进行使用建议或异常反馈。
5、切换频道
点击后打开登录界面,进行频道号切换。
6、退出
点击后退出客户端

6.1系统设置

点击后打开系统设置窗口,可以对直播具体参数进行调整
image028
1、选择编码器,软件编码或者硬件编码
软件编码:使用CPU进行解码,效率高,质量高(优先推荐使用软件编码)
硬件编码:使用显卡进行解码,在CPU荷载高的时候无法支撑软编时可以选择(在显卡不支持解码的情况下会产品黑屏现象)

2、选择推流输出分辨率(推荐使用系统默认设置)
当录屏屏幕分辩率过大时选择1:1比例,分辨率越大画面越清晰。
选择更大的分辨率对网络要求也相应增高。

3、帧率(推荐使用系统默认设置)
帧率越大画面越流畅,当直播画面出现马赛克时可将帧率调高。
选择更大的分辨率对网络要求也相应增高。

4、码率(推荐使用系统默认设置)
码率越大画面质量越好,对画面质量要求高时可调整码率。
选择更大的码率对网络要求也相应增高。

5、码率控制,动态码率或固态码率(推荐使用动态码率)
固态码率:恒定码率传输(能被大多数设备支持,但效果不理想)
动态码率:可变码率传输(效果好)

6、录像存放地址(可选择录制视频本地存放地址)

7、关闭win7 Areo效果(在电脑比较卡的情况下选择关闭),目前win 10系统下没有Areo效果,所以此选项被隐藏。

7.最小化按钮

image030
点击后可以最小化客户端。
如果采用的是录屏直播在直播开始后可将客户端最小化,不影响直播。

8.关闭客户端按钮

image031
点击后可以关闭客户端。

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

直播助手编辑区

直播源编辑区:对各种视频源进行属性编辑和显示图层调整,以及添加视频文字等素材。
image046

1. 切换场景功能

切换场景功能,可以设置三个不同场景的直播画面,在直播中根据直播需求,进行场景切换。
如下图:

场景一:设置图片源。image048
场景二:设置截屏源。image050
场景三:设置视频源。image052
三种场景分别设置了不同视频源,可以在直播当中自由切换当前想直播的画面。

2. 直播源编辑功能

image054

  • 1、点击image056可以对选择的直播源进行属性设置。
  • 2、点击image057可以对选择的直播源进行图层位置的调整,图层位置会影响到观众是否能看到该直播源。
  • 3、点击image058可以把选择的直播源删除。
2.1 摄像头源属性设置

image059
摄像头的属性设置窗口
能对摄像头设备进行选择。

2.2 图片源属性设置

image060
图片的属性设置窗口
1、能对图片进行重新选择。
2、能对图片进行不透明度设置。

2.3 文字源属性设置

image061
文字的属性设置窗口
1、能对文字进行重新编辑。
2、能改变字体字形。
3、能设置字体大小。
4、能改变字体颜色。
5、能设置文字是否滚动。
6、能设置字体不透明度以及粗体、斜体、轮廓发光、垂直显示等效果。

2.4 视频源属性设置

image062
视频的属性设置窗口
能对视频进行重新选择。

3.添加视频素材(文字以及视频)

image063
1、可以添加文字直播源。
2、可以添加本地视频直播源。

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

直播助手预览区

直播预览区:对当前直播/录制的画面进行预览、调整。
image064

1.能对直播源进行缩放操作

image066
点击视频源边上的小圆点即可对视频源进行缩放操作。
image068
直播预览区鼠标右键功能(居中、全屏、删除)

  • 1、在预览区点击鼠标右键点击屏幕居中后,可以将该直播源位置进行中心居中。
  • 2、在预览区点击鼠标右键点击拉伸到屏幕后,可以将该直播源放大至与直播画面同样大小
  • 3、在预览区点击鼠标右键点击删除后,即可将直播源删除。
以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

直播助手主控区

主控区功能

直播助手主控区01

1.选择客户端模式

 客户端有两种模式

直播助手主控区02

                  1、直播模式:想把画面直播出去时选择该模式。

                  2、录制模式:想把画面录制在本地当不直播时选择。

 

2. 添加摄像头

添加摄像头

 点击添加摄像头后,客户端会将电脑默认的摄像头设备添加至直播画面中。

 

3.添加截屏源

点击添加截屏源后会出现共享屏幕及共享

直播助手主控区04                    1、共享屏幕:将一整个屏幕直播出去。

                    2、共享窗口:将选择的软件画面直播出去。

 

4.添加图片源

 直播助手06

点击添加图片源后可以选择一张需要添加至直播画面的图片,即可将图片直播出去。

 

5. 扬声器控制

   直播助手07                                        1、可对扬声器音量进行调整。

                                           2、可通过音量检测条判断扬声器设备是否有效。

 

6. 麦克风控制

               直播助手08                   1、可对麦克风音量进行调整。

                                  2、可通过音量检测条判断麦克风设备是否有效。

 

7. 录制选择

                     直播助手09 1、勾选同时录制后将在直播的同时,将直播画面录制至本地电脑中。

                      2、点击录制文件目录可以快捷打开,录制直播文件存放文件地址。

 

8. 直播开关

开始直播 
1、控制直播开始与结束,点击开始直播,客户端开始推流

结束直播2、控制直播开始与结束,点击结束直播,客户端结束推流

 

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

直播助手定制要求

1、修改POLYV直播助手客户端的桌面icon

logo

需提供材料:
尺寸:48X48 格式:ico 图片一张

2、修改POLYV直播助手客户端的安装包icon

simple_logo

需提供材料:
尺寸:24X24 格式:png 图片一张

3、修改POLYV直播助手客户端的安装包图片

pic

需提供材料:
尺寸:480X250 格式:png 图片一张

4、修改POLYV直播助手客户端“POLYV云直播”标题栏

logo
需提供材料:
尺寸:162X18 格式:png 图片一张

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
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 弹幕进入效果 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...

播放器的授权播放

使用场景

学员登录网站页面后进入视频直播播放页面,播放器通过携带学员信息请求授权验证URL,接口判断该学员是否能播放当前视频。若不允许播放,则播放器提示相关错误信息,不能播放。用于学员播放权限验证。

后台设置

设置方式一:单个频道设置授权认证URL
频道设置 --> 播放器管理 --> 播放限制 --> 授权验证URL

设置方式二:通用设置授权认证URL,账号下所有频道开启应用默认设置生效
通用设置 --> 播放限制 --> 授权验证URL

参数说明

播放器请求授权认证URL参数说明:

参数名称 参数说明
vid 频道ID
code flashvars中自定义参数,默认空
t 时间戳
v 随机数去缓存,移动端中请求接口该字段为_
callback callback回调,移动端中请求接口使用jsonp方式
var player = polyvObject(".player").livePlayer({
    width: '100%',
    height: '100%',
    uid: 'e3wx706i3v',
    vid: '101043',
    flashvars: {
      code: 'polyv'
    }
});

请求接口示例:
http://www.mywebsite.com/pmd.php?vid=101043&code=polyv&t=1555569549636&v=867

授权认证URL接口回调参数说明

参数名称 取值范围 参数说明
status Number 是否允许播放, 1 正常播放 2 禁止播放
username String 跑马灯展示内容,可为""
sign String 授权验证sign
show String 是否显示跑马灯 on 显示 off 隐藏
message String 自定义错误信息,非必填

sign值MD5计算规则:
将vid(vid为频道ID),username,code,status,s(s为上文show的简写),t(t为播放器请求授权URL的时间戳参数)做MD5

let sign = MD5(`vid=${vid}&username=${username}&code=${code}&status=${status}&s=${show}&t=${t}`);

PHP示例代码

<?php
$status = 1;
$username = "test";
$show= "on";
$vid = $_GET["vid"];
$code = $_GET["code"];
$time = $_GET["t"];

//客户网站后台对学员身份做判断,若授权不通过不允许播放器去播视频,可以自定义提示信息,将提示信息传给POLYV播放器,让播放器显示出来
$message="该学员不是付费会员,请购买套餐后再刷新页面播放"; 

$md5=md5("vid=".$vid."&username=".$username."&code=".$code."&status=".$status."&s=".$show."&t=".$time);
$callback = isset($_GET["callback"])?$_GET["callback"]:null; //未提交callback时则设为空

$array = Array("status"=>$status,"username"=>$username,"show"=>$show,"sign"=>$md5,"message"=>$message);
$validateJson = json_encode($array);

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

※注:为了更方便的使用跑马灯功能,现已将直播跑马灯功能单独移出,具体请点击视频跑马灯–新的防录屏神器进行设置,目前授权认证接口仍需要提交相关操作,为空的参数也要提交。

注意事项

  1. 保存Json地址的域名下必需增加crossdomain.xml文件

crossdomain.xml:

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

示例

示例地址:http://demo.polyv.net/chenwb/test30/login.php

示例代码下载:zbsqrz

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