查询频道直播截图

接口URL

http://api.polyv.net/live/v2/stream/{channelId}/capture

接口说明

(接口调用有频率限制,详细请查看)

1、截图功能,查询当前频道或子频道正在直播的截图(截图五分钟更新一次)
2、接口URL中的{channelId}为 频道ID
3、接口支持https

返回结果支持格式

JSON

请求方式

GET  POST

请求数限制

TRUE

请求参数

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

响应成功JSON示例:

{
    "code": 200, 
    "status": "success", 
    "message": "", 
    "data":"//livestatic.videocc.net/uploaded/images/2018/01/ex96has7bf.jpg"
}

响应失败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": "account not exists.",
    "data": ""
}

频道不存在

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

子频道未直播

{
    "code": 400,
    "status": "error",
    "message": "account is not live.",
    "data": ""
}

频道未直播

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

获取图片失败

{
    "code": 400,
    "status": "error",
    "message": "get capture image failure.",
    "data": ""
}

字段说明

参数名 说明
code 请求状态响应码
status 请求状态
message 错误信息
data 请求成功时截图地址,请求错误时为空

php请求示例

<?php

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

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

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

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

//接口请求url

$url = "http://api.polyv.net/live/v2/stream/".$channelId."/capture?appId=".$appId."&timestamp=".$timestamp."&sign=".$sign;

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

?>

签名规则(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

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

接口说明

(接口调用有频率限制,详细请查看)

1、用于实现用户自开发观看页点赞效果,通过调用接口可以进行点赞,默认每次请求都是一次点赞
2、接口内部进行了判断,每个观众的点赞间隔1s的限制,根据提交的观众ID来区分
3、如果有需求支持同时点多个赞,可提交非必填参数times,times最大不能超过30。*如果提交次数为n,则需n-1秒才能继续点赞
4、接口支持https
5、接口URL中的{channelId}为 频道ID

返回结果支持格式

JSON

请求方式

GET  POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,32位大写MD5值
viewerId string 点赞观众的ID
times int 点赞的数目,不能超过30,提交后在times-1秒后才能再点赞

响应成功JSON示例:

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

响应失败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": ""
}

未提交viewerID

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

点赞间隔小于1s

{
    "code": 400,
    "status": "error",
    "message": "您的操作过快,请稍后再试",
    "data": ""
}

点赞次数times大于30

{
    "code": 400,
    "status": "error",
    "message": "设置的次数过多,请稍后再试",
    "data": ""
}

字段说明

参数名 说明
code 请求状态响应码
status 请求状态
message 错误信息
data 请求成功时为点赞数,请求错误时为空

php请求示例

<?php

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

//接口需要的参数(非sign)赋值
$channelId = "127075";
$times = 16;
$viewerId = '123123';

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

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

//接口请求url
$url = "http://api.polyv.net/live/v2/channels/$channelId/like?appId=$appId&timestamp=$timestamp&sign=$sign&viewerId=$viewerId&times=$times";

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

?>

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

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

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

助教功能的使用(视频)

助教功能的使用

1.首先用子频道号和密码登录助教后台;
2.助教后台分为直播预览区、连麦互动区、在线列表、提问区、公告区、聊天室;
3.助教可以预览直播、踢人、禁言、切换PPT、打开测试模式、回答观众问题、发布公告、发起签到、删除聊天等操作。
4.三分屏场景暂不支持测试模式。

 

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

连麦互动功能(视频)

连麦互动功能

使用保利威视的连麦系统,可以实现老师、助教和学生之间的视频以及语音互动。

1.开启直播,然后点击开启视频通话,学生举手申请连麦,允许通话后,学生和老师就可以进行视频互动了;
2.老师在直播端可以随意调整摄像头的画面;
3.语音通话与视频通话的操作类似,老师点击开启语音通话,其他人举手发言,老师通过后就可以进行语音通话了,语音通话可以支持多人同时连麦;
4.云课堂大班课的连麦操作和直播助手是一样的,不同的是,云课堂里摄像头的画面都是固定的,不能随意移动,只能够在固定的四个位置进行切换。

提示:连麦建议使用谷歌浏览器,且内核版本不小于58(观看页链接须为https的)

 

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

查询多个频道汇总的统计数据

接口URL

http://api.polyv.net/live/v2/statistics/{userId}/channel_summary

接口说明

(接口调用有频率限制,详细请查看)

1、根据是否提交channelIds来获取全部频道/某个频道查询时间内的播放数据
2、接口URL中的{userId}为直播账号ID
3、接口支持https

返回结果支持格式

JSON

请求方式

GET,POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,为32位大写的MD5值
startDate string 查询的开始日期 格式为yyyy-MM-dd
endDate string 查询的结束日期 格式为yyyy-MM-dd
channelIds string 要查询的频道号,不提交默认为查询所有频道,多个频道号以英文逗号“,”分开,如:105420,104400

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": [
        {
            "userId": null,
            "channelId": 101385,
            "name": "测试频道号12",
            "pcPlayDuration": 3738,
            "pcFlowSize": 14585121564,
            "pcVideoView": 944,
            "pcUniqueViewer": 138,
            "mobilePlayDuration": 399,
            "mobileFlowSize": 7937281,
            "mobileVideoView": 195,
            "mobileUniqueViewer": 71,
            "livePcPlayDuration": 38,
            "playbackPcPlayDuration": 0,
            "unknownPcPlayDuration": 0,
            "liveMobilePlayDuration": 0,
            "playbackMobilePlayDuration": 0,
            "unknownMobilePlayDuration": 0
        },
        {
            "userId": null,
            "channelId": 103669,
            "name": "直播回看1",
            "pcPlayDuration": 2943,
            "pcFlowSize": 3069092519,
            "pcVideoView": 1009,
            "pcUniqueViewer": 101,
            "mobilePlayDuration": 305,
            "mobileFlowSize": 0,
            "mobileVideoView": 104,
            "mobileUniqueViewer": 63,
            "livePcPlayDuration": 38,
            "playbackPcPlayDuration": 0,
            "unknownPcPlayDuration": 0,
            "liveMobilePlayDuration": 0,
            "playbackMobilePlayDuration": 0,
            "unknownMobilePlayDuration": 0
        }
    ]
}

响应失败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": "日期格式要求为yyyy-MM-dd.",
    "data": ""
}

channelIds格式错误

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

channelds的频道号不属于当前账号

{
    "code": 400,
    "status": "error",
    "message": "channelIds is mismatching.",
    "data": ""
}

字段说明

参数名 说明
code 请求状态响应码
status 请求状态
message 错误信息
channelId 频道Id
name 频道名称
pcPlayDuration pc端播放时长,单位:分钟
pcFlowSize pc端播放流量,单位为Byte
pcVideoView pc视频播放量
pcUniqueViewer pc端唯一观众数
mobilePlayDuration 移动端播放时长,单位:分钟
mobileFlowSize 移动端播放流量,单位为Byte
mobileVideoView 移动端播放量
mobileUniqueViewer 移动端唯一观众数
livePcPlayDuration PC直播播放时长,单位为分钟
playbackPcPlayDuration PC回放播放时长,单位为分钟
liveMobilePlayDuration 移动端直播播放时长,单位为分钟
playbackMobilePlayDuration 移动端回放播放时长,单位为分钟
unknownPcPlayDuration pc 其他 播放时长,单位为分钟
unknownMobilePlayDuration 移动端其他 播放时长,单位为分钟

php请求示例

<?php
//引用config.php
include 'config.php';
//接口需要的参数(非sign)赋值
$userId = "";
$startDate = "";
$endDate = "";
$channelIds = "";

$params = array(
    'appId'=>$appId,
    'startDate'=>$startDate,
    'endDate'=>$endDate,
    'channelIds'=>$channelIds,
    'timestamp'=>$timestamp
  );

//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法
$params['sign'] = $sign;
$header = array("Content-Type:x-www-form-urlencoded");
//接口请求url
$url = "http://api.polyv.net/live/v2/statistics/".$userId."/channel_summary";
//输出接口请求结果
$curl = curl_init();
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_TIMEOUT, 5000);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_POSTFIELDS, $params);
$res = curl_exec($curl);
curl_close($curl);

echo $res;

?>

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

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

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

PC浏览器连麦提示安全限制处理方法

问题描述

在连麦过程中,出现下图提示:
连麦https提示

出现原因:

谷歌宣布了一项安全政策,任何已经集成了WebRTC等功能的网站现在都需要从一个安全的(HTTPS)站点中获得服务。这将影响Chrome浏览器的的使用,不安全(HTTP)站点将无法通过OpenTok平台实现语音、视频或屏幕共享。

解决办法

  1. 您需要为您的域名获得SSL证书。这些可从许多证书颁发机构获得,例如 https://my.gogetssl.com 、https://www.itrus.cn/ 或 https://www.getssl.cn/ 等。这可以确保网站使用的是合法 CA 签发的有效证书。
  2. 在您获得证书后,请检查证书的完整性(需包含站点证书及所有中间证书)。
  3. 您需要将证书文件和私用密钥文件发送给我们的技术支持,由保利威视为您的域名配置https。
以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

设置授权观看类型

接口URL

http://api.polyv.net/live/v2/channelSetting/{channelId}/set-auth-type

接口说明

(接口调用有频率限制,详细请查看)

1、通过接口可以设置频道的观看条件
2、接口支持https
3、接口URL中的{channelId}为 频道ID

注意:目前仅可通过此接口设置为无条件观看

返回结果支持格式

JSON

请求方式

GET,POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级时间戳,3分钟内有效
authType 目前固定取值为none 观看条件类型
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": ""
}

authType值错误

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

其他情况

{
    "code": 400,
    "status": "error",
    "message": "修改失败",
    "data": ""
}

字段说明

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

php请求示例

<?php

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

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

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

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

//接口请求url
$url = "http://api.polyv.net/live/v2/channelSetting/$channelId/set-auth-type?appId=$appId&timestamp=$timestamp&sign=$sign&authType=$authType";

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

?>

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

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

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

直播助手的使用技巧-聊天区篇(视频)

视频说明

1.直播助手聊天区有四大功能,分别是聊天、在线、提问、问答;
2.在聊天室可以查看观众的实时聊天、删除聊天信息、使用文字和表情与观众互动聊天;
3.在线列表可以查看在线的观众,也可以把特定的观众踢出直播,被踢的人24小时内不能再次进入直播和聊天室;
4.每当有观众使用提问功能提出问题,直播助手提问标签会有红点显示,您可以查看问题并回答;
5.问答功能提供了两种题型可供使用,分别是选择题和判断题,使用前需要提前准备好题目,然后选择合适的题型,开始问答即可。

 

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