Player

Player

new Player()

Methods

on(eventName, handler, contextopt)

监听事件。

Example
let onRTCClientBanned = function(event) {
  console.error('player | client-banned observed: ' + event);
  // 退出刷新页面
};
player.on(TWebLive.EVENT.RTC_CLIENT_BANNED, onRTCClientBanned);
Parameters:
Name Type Attributes Description
eventName String

事件名称。所有的事件名称都存放在 TWebLive.EVENT 变量中，如需要查看可以使用 console.log(TWebLive.EVENT) 把所有的事件显示出来。事件列表

handler function

处理事件的方法，当事件触发时，会调用此handler进行处理。
context * <optional>

期望 handler 执行时的上下文

off(eventName, handler, contextopt)

取消监听事件。

Example
player.off(TWebLive.EVENT.RTC_CLIENT_BANNED, onRTCClientBanned);
Parameters:
Name Type Attributes Description
eventName String

事件名称。所有的事件名称都存放在 TWebLive.EVENT 变量中，如需要查看可以使用 console.log(TWebLive.EVENT) 把所有的事件显示出来。事件列表

handler function

处理事件的方法，当事件触发时，会调用此handler进行处理。
context * <optional>

期望 handler 执行时的上下文

setLogLevel(level)

设置日志级别，低于 level 的日志将不会输出。

Example
player.setLogLevel(1);
Parameters:
Name Type Description
level Number

日志级别

  • 0 普通级别，日志量较多，接入时建议使用
  • 1 release级别，SDK 输出关键信息，生产环境时建议使用
  • 2 告警级别，SDK 只输出告警和错误级别的日志
  • 3 错误级别，SDK 只输出错误级别的日志
  • 4 无日志级别，SDK 将不打印任何日志

setCustomConfig(options)

设置播放器自定义配置，如 poster（播放器封面），wording（错误提示语）等，仅用于 CDN 观看，使用时请在 startPlay() 前调用。

Example
// 设置错误提示语，错误码表请参考 https://cloud.tencent.com/document/product/454/7503#step6.-.E5.AE.9A.E5.88.B6.E9.94.99.E8.AF.AF.E6.8F.90.E7.A4.BA.E8.AF.AD
player.setCustomConfig({
  wording: {
    1: '(⊙︿⊙)，播放出错啦。。。'
  }
});
// 设置播放器封面
player.setCustomConfig({
  poster: 'https://www.test.com/myimage.jpg',
});
// 设置自动播放（默认 false），该选项只对大部分 PC 平台生效
player.setCustomConfig({
  autoplay: true
});
// 设置播放器宽高
player.setCustomConfig({
  width: 800, // 播放器宽度，单位为像素
  height: 600 // 播放器高度，单位为像素
});
Parameters:
Name Type Description
options Object

自定义配置

setRenderView(options)

设置渲染流的界面。

Example
player.setRenderView({ elementID: 'playerView' });
Parameters:
Name Type Description
options Object

配置

Properties
Name Type Description
elementID string

HTML <div> 标签 ID

(async) startPlay(url) → {Promise}

开始拉流播放。

Examples
// 播放 CDN 流，填入 flv hls 地址等信息
// url 必须以 `https://` 开头
let url = 'https://'
  + 'flv=' + encodeURIComponent('https://200002949.vod.myqcloud.com/200002949_b6ffc.f0.flv') + '&' // 请替换成实际可用的播放地址
  + 'hls=' + encodeURIComponent('https://200002949.vod.myqcloud.com/200002949_b6ffc.f0.m3u8'); // 请替换成实际可用的播放地址
player.startPlay(url).then(() => {
  console.log('player | startPlay | ok');
}).catch((error) => {
  console.error('player | startPlay | failed', error);
});
// 播放 WebRTC 低延时流，填入 sdkappid roomid 等信息，此时 url 必须以 `room://` 开头
let url = `room://sdkappid=${SDKAppID}&roomid=${roomID}&userid=${userID}&usersig=${userSig}`;
player.startPlay(url).then(() => {
  console.log('player | startPlay | ok');
}).catch((error) => {
  console.error('player | startPlay | failed', error);
});
Parameters:
Name Type Description
url string

拉流地址
Returns:
Type
Promise

isPlaying() → {boolean}

是否正在拉流播放。

Example
console.log('player | isPlaying | ', player.isPlaying());
Returns:
Type
boolean

(async) pauseAudio() → {Promise}

暂停播放音频。当播放 CDN 流时，此接口的作用是静音播放器。

Example
player.pauseAudio().then(() => {
  console.log('player | pauseAudio | ok');
}).catch((error) => {
  console.error('player | pauseAudio | failed', error);
});
Returns:
Type
Promise

(async) resumeAudio() → {Promise}

恢复播放音频。当播放 CDN 流时，此接口的作用是取消静音。

Example
player.resumeAudio().then(() => {
  console.log('player | resumeAudio | ok');
}).catch((error) => {
  console.error('player | resumeAudio | failed', error);
});
Returns:
Type
Promise

(async) pauseVideo() → {Promise}

暂停播放视频。

Example
player.pauseVideo().then(() => {
  console.log('player | pauseVideo | ok');
}).catch((error) => {
  console.error('player | pauseVideo | failed', error);
});
Returns:
Type
Promise

(async) resumeVideo() → {Promise}

恢复播放视频。

Example
player.resumeVideo().then(() => {
  console.log('player | resumeVideo | ok');
}).catch((error) => {
  console.error('player | resumeVideo | failed', error);
});
Returns:
Type
Promise

setPlayoutVolume(value)

设置音量。

Example
player.setPlayoutVolume(70);
Parameters:
Name Type Description
value number

音量值，范围[0 - 100]，默认值100

resumePlay()

恢复播放音视频。

注意：由于浏览器自动播放策略的限制，在 startPlay() 监听到事件 PLAYER_AUTOPLAY_NOT_ALLOWED 后需要引导用户通过手势 调用该接口恢复播放。

Example
player.resumePlay();

stopPlay()

停止播放。

Example
player.stopPlay();