Player

本文档主要提供播放器模块下的播放器使用方式 Api 文档。

一、创建播放器

通过 setupPlayer 创建观看页的播放器。

lowLatency 参数负责控制播放器是否使用无延迟播放，开启后若当前为无延迟频道并且设备支持无延迟播放则使用无延迟进行播放，开发者可通过 supportLowLatency 方法判断当前环境和频道是否支持无延迟。

通过 PlayerEvents.PlayerInited 监听播放器创建并初始化完成事件，当触发该事件后即可调用播放器模块的其他方法，如：play、pause。

Api 方法： setupPlayer(options: SetupPlayerOptions): Promise<void>

参数说明：

• options：创建参数，SetupPlayerOptions 类型，必传，详细类型说明如下

参数名	说明	类型	必须	默认值
lowLatency	是否使用无延迟播放	boolean	否	false
playbackOptions	回放参数	SetupPlayerPlaybackOptions	否	-
autoplay	是否自动播放	boolean	否	根据后台设置
showController	是否显示控制栏	boolean	否	true
playerContext	播放器容器	PlayerBridgeInstance	否	-

示例：

const playerCtx = this.selectComponent('#player-bridging');
await watchCore.player.setupPlayer({
  lowLatency: true, // 使用无延迟播放
  playerContext: playerCtx,
});

二、获取播放器信息

播放器模块会保存播放器的状态信息，通过 getPlayerInfo 方法获取当前播放的所有状态。

Api 方法： getPlayerInfo(): PlayerStoreInfo

返回值说明： 播放器信息，PlayerStoreInfo 类型，详细类型说明如下

属性名	说明	类型
playerInited	播放器是否初始化完成	boolean
supportRefresh	是否支持刷新	boolean
supportAutoPlay	是否支持自动播放	boolean
supportLowLatency	是否支持无延迟播放	boolean
isLowLatency	当前是否无延迟播放	boolean
playStatus	播放状态	PlayStatus
barrageShow	弹幕显示状态	boolean
supportBarrageSpeed	是否支持弹幕速度切换	boolean
currentBarrageSpeed	弹幕速度	number
currentVolume	当前音量	number
lineCount	总线路数	number
currentLine	当前线路索引	number
qualityLevels	可选的清晰度列表	QualityLevelItem[]
currentQualityLevel	当前清晰度级别	number
rateList	可选的倍速列表	number[]
currentRate	当前倍速	number
durationTime	播放总时长，单位：秒	number
currentTime	当前播放进度，单位：秒	number

示例：

const playerInfo = watchCore.player.getPlayerInfo();
console.log('播放状态', playerInfo.playStatus); // playing or pause
console.log('是否支持无延迟', playerInfo.supportLowLatency);
console.log('是否无延迟', playerInfo.isLowLatency);

三、无延迟

3.1 是否支持无延迟观看

通过 supportLowLatency 方法获取当前环境和频道是否支持无延迟观看。

Api 方法： supportLowLatency(): SupportResult

返回值说明： 支持结果，SupportResult 类型

示例：

const supportResult = watchCore.player.supportLowLatency();
if (supportResult.support) {
  console.log('支持无延迟观看');
} else {
  console.log('不支持无延迟观看');
}

四、播放/暂停

4.1 恢复视频播放

通过 play 方法触发播放器播放直播流或视频。

Api 方法： play(): void

示例：

// 恢复播放
watchCore.player.play();

4.2 暂停视频播放

通过 pause 方法暂停视频播放。

Api 方法： pause(): void

示例：

// 暂停播放
watchCore.player.pause();

五、刷新

5.1 获取播放器信息

播放器模块会保存播放器的状态信息，通过 getPlayerInfo 方法获取当前播放的所有状态。

Api 方法： getPlayerInfo(): PlayerStoreInfo

返回值说明： 播放器信息，PlayerStoreInfo 类型，详细类型说明如下

属性名	说明	类型
playerInited	播放器是否初始化完成	boolean
supportRefresh	是否支持刷新	boolean
supportAutoPlay	是否支持自动播放	boolean
supportLowLatency	是否支持无延迟播放	boolean
isLowLatency	当前是否无延迟播放	boolean
playStatus	播放状态	PlayStatus
barrageShow	弹幕显示状态	boolean
supportBarrageSpeed	是否支持弹幕速度切换	boolean
currentBarrageSpeed	弹幕速度	number
currentVolume	当前音量	number
lineCount	总线路数	number
currentLine	当前线路索引	number
qualityLevels	可选的清晰度列表	QualityLevelItem[]
currentQualityLevel	当前清晰度级别	number
rateList	可选的倍速列表	number[]
currentRate	当前倍速	number
durationTime	播放总时长，单位：秒	number
currentTime	当前播放进度，单位：秒	number

示例：

const playerInfo = watchCore.player.getPlayerInfo();
console.log('播放状态', playerInfo.playStatus); // playing or pause
console.log('是否支持无延迟', playerInfo.supportLowLatency);
console.log('是否无延迟', playerInfo.isLowLatency);

5.2 创建播放器

通过 setupPlayer 创建观看页的播放器。

lowLatency 参数负责控制播放器是否使用无延迟播放，开启后若当前为无延迟频道并且设备支持无延迟播放则使用无延迟进行播放，开发者可通过 supportLowLatency 方法判断当前环境和频道是否支持无延迟。

通过 PlayerEvents.PlayerInited 监听播放器创建并初始化完成事件，当触发该事件后即可调用播放器模块的其他方法，如：play、pause。

Api 方法： setupPlayer(options: SetupPlayerOptions): Promise<void>

参数说明：

• options：创建参数，SetupPlayerOptions 类型，必传，详细类型说明如下

参数名	说明	类型	必须	默认值
lowLatency	是否使用无延迟播放	boolean	否	false
playbackOptions	回放参数	SetupPlayerPlaybackOptions	否	-
autoplay	是否自动播放	boolean	否	根据后台设置
showController	是否显示控制栏	boolean	否	true
playerContext	播放器容器	PlayerBridgeInstance	否	-

示例：

const playerCtx = this.selectComponent('#player-bridging');
await watchCore.player.setupPlayer({
  lowLatency: true, // 使用无延迟播放
  playerContext: playerCtx,
});

5.3 是否支持无延迟观看

通过 supportLowLatency 方法获取当前环境和频道是否支持无延迟观看。

Api 方法： supportLowLatency(): SupportResult

返回值说明： 支持结果，SupportResult 类型

示例：

const supportResult = watchCore.player.supportLowLatency();
if (supportResult.support) {
  console.log('支持无延迟观看');
} else {
  console.log('不支持无延迟观看');
}

5.4 恢复视频播放

通过 play 方法触发播放器播放直播流或视频。

Api 方法： play(): void

示例：

// 恢复播放
watchCore.player.play();

5.5 暂停视频播放

通过 pause 方法暂停视频播放。

Api 方法： pause(): void

示例：

// 暂停播放
watchCore.player.pause();

5.6 设置播放进度

当观众拖拽回放进度条时，通过 seekVideo 设置回放播放进度。

Api 方法： seekVideo(time: number): void

参数说明：

• time：播放时间，单位秒，number 类型，必传

示例：

// 切到 1 分 20 秒
watchCore.player.seekVideo(120);

5.7 获取播放器暖场设置信息

用于获取管理后台设置的播放器暖场信息，注意暖场设置有一定延迟，需要通过 PlayerEvents.PlayerWarmUpSettingChange 事件监听信息更新。

Api 方法： getPlayerWarmUpSetting(): PlayerWarmUpSetting

返回值说明： 播放器暖场设置，PlayerWarmUpSetting 类型，详细类型说明如下

属性名	说明	类型
warmUpType	暖场类型	undefined | WarmUpType
warmUpImg	暖场图片地址	undefined | string
warmUpVideo	暖场视频地址	undefined | string
warmUpHref	暖场图片点击跳转地址	undefined | string

示例：

watchCore.player.eventEmitter.on(PlayerEvents.PlayerWarmUpSettingChange, () => {
  const setting = watchCore.player.getPlayerWarmUpSetting();
  console.log('暖场类型', setting.warmUpType);
  console.log('暖场图片地址', setting.warmUpImg);
  console.log('暖场视频地址', setting.warmUpVideo);
});

5.8 销毁播放器

页面或组件销毁前调用 destroyPlayer 销毁播放器。

Api 方法： destroyPlayer(): void

示例：

watchCore.player.destroyPlayer();

六、音量

6.1 获取播放器信息

播放器模块会保存播放器的状态信息，通过 getPlayerInfo 方法获取当前播放的所有状态。

Api 方法： getPlayerInfo(): PlayerStoreInfo

返回值说明： 播放器信息，PlayerStoreInfo 类型，详细类型说明如下

属性名	说明	类型
playerInited	播放器是否初始化完成	boolean
supportRefresh	是否支持刷新	boolean
supportAutoPlay	是否支持自动播放	boolean
supportLowLatency	是否支持无延迟播放	boolean
isLowLatency	当前是否无延迟播放	boolean
playStatus	播放状态	PlayStatus
barrageShow	弹幕显示状态	boolean
supportBarrageSpeed	是否支持弹幕速度切换	boolean
currentBarrageSpeed	弹幕速度	number
currentVolume	当前音量	number
lineCount	总线路数	number
currentLine	当前线路索引	number
qualityLevels	可选的清晰度列表	QualityLevelItem[]
currentQualityLevel	当前清晰度级别	number
rateList	可选的倍速列表	number[]
currentRate	当前倍速	number
durationTime	播放总时长，单位：秒	number
currentTime	当前播放进度，单位：秒	number

示例：

const playerInfo = watchCore.player.getPlayerInfo();
console.log('播放状态', playerInfo.playStatus); // playing or pause
console.log('是否支持无延迟', playerInfo.supportLowLatency);
console.log('是否无延迟', playerInfo.isLowLatency);

6.2 创建播放器

通过 setupPlayer 创建观看页的播放器。

lowLatency 参数负责控制播放器是否使用无延迟播放，开启后若当前为无延迟频道并且设备支持无延迟播放则使用无延迟进行播放，开发者可通过 supportLowLatency 方法判断当前环境和频道是否支持无延迟。

通过 PlayerEvents.PlayerInited 监听播放器创建并初始化完成事件，当触发该事件后即可调用播放器模块的其他方法，如：play、pause。

Api 方法： setupPlayer(options: SetupPlayerOptions): Promise<void>

参数说明：

• options：创建参数，SetupPlayerOptions 类型，必传，详细类型说明如下

参数名	说明	类型	必须	默认值
lowLatency	是否使用无延迟播放	boolean	否	false
playbackOptions	回放参数	SetupPlayerPlaybackOptions	否	-
autoplay	是否自动播放	boolean	否	根据后台设置
showController	是否显示控制栏	boolean	否	true
playerContext	播放器容器	PlayerBridgeInstance	否	-

示例：

const playerCtx = this.selectComponent('#player-bridging');
await watchCore.player.setupPlayer({
  lowLatency: true, // 使用无延迟播放
  playerContext: playerCtx,
});

6.3 是否支持无延迟观看

通过 supportLowLatency 方法获取当前环境和频道是否支持无延迟观看。

Api 方法： supportLowLatency(): SupportResult

返回值说明： 支持结果，SupportResult 类型

示例：

const supportResult = watchCore.player.supportLowLatency();
if (supportResult.support) {
  console.log('支持无延迟观看');
} else {
  console.log('不支持无延迟观看');
}

6.4 恢复视频播放

通过 play 方法触发播放器播放直播流或视频。

Api 方法： play(): void

示例：

// 恢复播放
watchCore.player.play();

6.5 暂停视频播放

通过 pause 方法暂停视频播放。

Api 方法： pause(): void

示例：

// 暂停播放
watchCore.player.pause();

6.6 设置播放进度

当观众拖拽回放进度条时，通过 seekVideo 设置回放播放进度。

Api 方法： seekVideo(time: number): void

参数说明：

• time：播放时间，单位秒，number 类型，必传

示例：

// 切到 1 分 20 秒
watchCore.player.seekVideo(120);

6.7 获取播放器暖场设置信息

用于获取管理后台设置的播放器暖场信息，注意暖场设置有一定延迟，需要通过 PlayerEvents.PlayerWarmUpSettingChange 事件监听信息更新。

Api 方法： getPlayerWarmUpSetting(): PlayerWarmUpSetting

返回值说明： 播放器暖场设置，PlayerWarmUpSetting 类型，详细类型说明如下

属性名	说明	类型
warmUpType	暖场类型	undefined | WarmUpType
warmUpImg	暖场图片地址	undefined | string
warmUpVideo	暖场视频地址	undefined | string
warmUpHref	暖场图片点击跳转地址	undefined | string

示例：

watchCore.player.eventEmitter.on(PlayerEvents.PlayerWarmUpSettingChange, () => {
  const setting = watchCore.player.getPlayerWarmUpSetting();
  console.log('暖场类型', setting.warmUpType);
  console.log('暖场图片地址', setting.warmUpImg);
  console.log('暖场视频地址', setting.warmUpVideo);
});

6.8 销毁播放器

页面或组件销毁前调用 destroyPlayer 销毁播放器。

Api 方法： destroyPlayer(): void

示例：

watchCore.player.destroyPlayer();

七、弹幕

7.1 获取播放器信息

播放器模块会保存播放器的状态信息，通过 getPlayerInfo 方法获取当前播放的所有状态。

Api 方法： getPlayerInfo(): PlayerStoreInfo

返回值说明： 播放器信息，PlayerStoreInfo 类型，详细类型说明如下

属性名	说明	类型
playerInited	播放器是否初始化完成	boolean
supportRefresh	是否支持刷新	boolean
supportAutoPlay	是否支持自动播放	boolean
supportLowLatency	是否支持无延迟播放	boolean
isLowLatency	当前是否无延迟播放	boolean
playStatus	播放状态	PlayStatus
barrageShow	弹幕显示状态	boolean
supportBarrageSpeed	是否支持弹幕速度切换	boolean
currentBarrageSpeed	弹幕速度	number
currentVolume	当前音量	number
lineCount	总线路数	number
currentLine	当前线路索引	number
qualityLevels	可选的清晰度列表	QualityLevelItem[]
currentQualityLevel	当前清晰度级别	number
rateList	可选的倍速列表	number[]
currentRate	当前倍速	number
durationTime	播放总时长，单位：秒	number
currentTime	当前播放进度，单位：秒	number

示例：

const playerInfo = watchCore.player.getPlayerInfo();
console.log('播放状态', playerInfo.playStatus); // playing or pause
console.log('是否支持无延迟', playerInfo.supportLowLatency);
console.log('是否无延迟', playerInfo.isLowLatency);

7.2 创建播放器

通过 setupPlayer 创建观看页的播放器。

lowLatency 参数负责控制播放器是否使用无延迟播放，开启后若当前为无延迟频道并且设备支持无延迟播放则使用无延迟进行播放，开发者可通过 supportLowLatency 方法判断当前环境和频道是否支持无延迟。

通过 PlayerEvents.PlayerInited 监听播放器创建并初始化完成事件，当触发该事件后即可调用播放器模块的其他方法，如：play、pause。

Api 方法： setupPlayer(options: SetupPlayerOptions): Promise<void>

参数说明：

• options：创建参数，SetupPlayerOptions 类型，必传，详细类型说明如下

参数名	说明	类型	必须	默认值
lowLatency	是否使用无延迟播放	boolean	否	false
playbackOptions	回放参数	SetupPlayerPlaybackOptions	否	-
autoplay	是否自动播放	boolean	否	根据后台设置
showController	是否显示控制栏	boolean	否	true
playerContext	播放器容器	PlayerBridgeInstance	否	-

示例：

const playerCtx = this.selectComponent('#player-bridging');
await watchCore.player.setupPlayer({
  lowLatency: true, // 使用无延迟播放
  playerContext: playerCtx,
});

7.3 是否支持无延迟观看

通过 supportLowLatency 方法获取当前环境和频道是否支持无延迟观看。

Api 方法： supportLowLatency(): SupportResult

返回值说明： 支持结果，SupportResult 类型

示例：

const supportResult = watchCore.player.supportLowLatency();
if (supportResult.support) {
  console.log('支持无延迟观看');
} else {
  console.log('不支持无延迟观看');
}

7.4 恢复视频播放

通过 play 方法触发播放器播放直播流或视频。

Api 方法： play(): void

示例：

// 恢复播放
watchCore.player.play();

7.5 暂停视频播放

通过 pause 方法暂停视频播放。

Api 方法： pause(): void

示例：

// 暂停播放
watchCore.player.pause();

7.6 设置播放进度

当观众拖拽回放进度条时，通过 seekVideo 设置回放播放进度。

Api 方法： seekVideo(time: number): void

参数说明：

• time：播放时间，单位秒，number 类型，必传

示例：

// 切到 1 分 20 秒
watchCore.player.seekVideo(120);

7.7 获取播放器暖场设置信息

用于获取管理后台设置的播放器暖场信息，注意暖场设置有一定延迟，需要通过 PlayerEvents.PlayerWarmUpSettingChange 事件监听信息更新。

Api 方法： getPlayerWarmUpSetting(): PlayerWarmUpSetting

返回值说明： 播放器暖场设置，PlayerWarmUpSetting 类型，详细类型说明如下

属性名	说明	类型
warmUpType	暖场类型	undefined | WarmUpType
warmUpImg	暖场图片地址	undefined | string
warmUpVideo	暖场视频地址	undefined | string
warmUpHref	暖场图片点击跳转地址	undefined | string

示例：

watchCore.player.eventEmitter.on(PlayerEvents.PlayerWarmUpSettingChange, () => {
  const setting = watchCore.player.getPlayerWarmUpSetting();
  console.log('暖场类型', setting.warmUpType);
  console.log('暖场图片地址', setting.warmUpImg);
  console.log('暖场视频地址', setting.warmUpVideo);
});

7.8 销毁播放器

页面或组件销毁前调用 destroyPlayer 销毁播放器。

Api 方法： destroyPlayer(): void

示例：

watchCore.player.destroyPlayer();

八、线路

8.1 获取播放器信息

播放器模块会保存播放器的状态信息，通过 getPlayerInfo 方法获取当前播放的所有状态。

Api 方法： getPlayerInfo(): PlayerStoreInfo

返回值说明： 播放器信息，PlayerStoreInfo 类型，详细类型说明如下

属性名	说明	类型
playerInited	播放器是否初始化完成	boolean
supportRefresh	是否支持刷新	boolean
supportAutoPlay	是否支持自动播放	boolean
supportLowLatency	是否支持无延迟播放	boolean
isLowLatency	当前是否无延迟播放	boolean
playStatus	播放状态	PlayStatus
barrageShow	弹幕显示状态	boolean
supportBarrageSpeed	是否支持弹幕速度切换	boolean
currentBarrageSpeed	弹幕速度	number
currentVolume	当前音量	number
lineCount	总线路数	number
currentLine	当前线路索引	number
qualityLevels	可选的清晰度列表	QualityLevelItem[]
currentQualityLevel	当前清晰度级别	number
rateList	可选的倍速列表	number[]
currentRate	当前倍速	number
durationTime	播放总时长，单位：秒	number
currentTime	当前播放进度，单位：秒	number

示例：

const playerInfo = watchCore.player.getPlayerInfo();
console.log('播放状态', playerInfo.playStatus); // playing or pause
console.log('是否支持无延迟', playerInfo.supportLowLatency);
console.log('是否无延迟', playerInfo.isLowLatency);

8.2 创建播放器

通过 setupPlayer 创建观看页的播放器。

lowLatency 参数负责控制播放器是否使用无延迟播放，开启后若当前为无延迟频道并且设备支持无延迟播放则使用无延迟进行播放，开发者可通过 supportLowLatency 方法判断当前环境和频道是否支持无延迟。

通过 PlayerEvents.PlayerInited 监听播放器创建并初始化完成事件，当触发该事件后即可调用播放器模块的其他方法，如：play、pause。

Api 方法： setupPlayer(options: SetupPlayerOptions): Promise<void>

参数说明：

• options：创建参数，SetupPlayerOptions 类型，必传，详细类型说明如下

参数名	说明	类型	必须	默认值
lowLatency	是否使用无延迟播放	boolean	否	false
playbackOptions	回放参数	SetupPlayerPlaybackOptions	否	-
autoplay	是否自动播放	boolean	否	根据后台设置
showController	是否显示控制栏	boolean	否	true
playerContext	播放器容器	PlayerBridgeInstance	否	-

示例：

const playerCtx = this.selectComponent('#player-bridging');
await watchCore.player.setupPlayer({
  lowLatency: true, // 使用无延迟播放
  playerContext: playerCtx,
});

8.3 是否支持无延迟观看

通过 supportLowLatency 方法获取当前环境和频道是否支持无延迟观看。

Api 方法： supportLowLatency(): SupportResult

返回值说明： 支持结果，SupportResult 类型

示例：

const supportResult = watchCore.player.supportLowLatency();
if (supportResult.support) {
  console.log('支持无延迟观看');
} else {
  console.log('不支持无延迟观看');
}

8.4 恢复视频播放

通过 play 方法触发播放器播放直播流或视频。

Api 方法： play(): void

示例：

// 恢复播放
watchCore.player.play();

8.5 暂停视频播放

通过 pause 方法暂停视频播放。

Api 方法： pause(): void

示例：

// 暂停播放
watchCore.player.pause();

8.6 设置播放进度

当观众拖拽回放进度条时，通过 seekVideo 设置回放播放进度。

Api 方法： seekVideo(time: number): void

参数说明：

• time：播放时间，单位秒，number 类型，必传

示例：

// 切到 1 分 20 秒
watchCore.player.seekVideo(120);

8.7 获取播放器暖场设置信息

用于获取管理后台设置的播放器暖场信息，注意暖场设置有一定延迟，需要通过 PlayerEvents.PlayerWarmUpSettingChange 事件监听信息更新。

Api 方法： getPlayerWarmUpSetting(): PlayerWarmUpSetting

返回值说明： 播放器暖场设置，PlayerWarmUpSetting 类型，详细类型说明如下

属性名	说明	类型
warmUpType	暖场类型	undefined | WarmUpType
warmUpImg	暖场图片地址	undefined | string
warmUpVideo	暖场视频地址	undefined | string
warmUpHref	暖场图片点击跳转地址	undefined | string

示例：

watchCore.player.eventEmitter.on(PlayerEvents.PlayerWarmUpSettingChange, () => {
  const setting = watchCore.player.getPlayerWarmUpSetting();
  console.log('暖场类型', setting.warmUpType);
  console.log('暖场图片地址', setting.warmUpImg);
  console.log('暖场视频地址', setting.warmUpVideo);
});

8.8 销毁播放器

页面或组件销毁前调用 destroyPlayer 销毁播放器。

Api 方法： destroyPlayer(): void

示例：

watchCore.player.destroyPlayer();

九、清晰度

9.1 获取播放器信息

播放器模块会保存播放器的状态信息，通过 getPlayerInfo 方法获取当前播放的所有状态。

Api 方法： getPlayerInfo(): PlayerStoreInfo

返回值说明： 播放器信息，PlayerStoreInfo 类型，详细类型说明如下

属性名	说明	类型
playerInited	播放器是否初始化完成	boolean
supportRefresh	是否支持刷新	boolean
supportAutoPlay	是否支持自动播放	boolean
supportLowLatency	是否支持无延迟播放	boolean
isLowLatency	当前是否无延迟播放	boolean
playStatus	播放状态	PlayStatus
barrageShow	弹幕显示状态	boolean
supportBarrageSpeed	是否支持弹幕速度切换	boolean
currentBarrageSpeed	弹幕速度	number
currentVolume	当前音量	number
lineCount	总线路数	number
currentLine	当前线路索引	number
qualityLevels	可选的清晰度列表	QualityLevelItem[]
currentQualityLevel	当前清晰度级别	number
rateList	可选的倍速列表	number[]
currentRate	当前倍速	number
durationTime	播放总时长，单位：秒	number
currentTime	当前播放进度，单位：秒	number

示例：

const playerInfo = watchCore.player.getPlayerInfo();
console.log('播放状态', playerInfo.playStatus); // playing or pause
console.log('是否支持无延迟', playerInfo.supportLowLatency);
console.log('是否无延迟', playerInfo.isLowLatency);

9.2 创建播放器

通过 setupPlayer 创建观看页的播放器。

lowLatency 参数负责控制播放器是否使用无延迟播放，开启后若当前为无延迟频道并且设备支持无延迟播放则使用无延迟进行播放，开发者可通过 supportLowLatency 方法判断当前环境和频道是否支持无延迟。

通过 PlayerEvents.PlayerInited 监听播放器创建并初始化完成事件，当触发该事件后即可调用播放器模块的其他方法，如：play、pause。

Api 方法： setupPlayer(options: SetupPlayerOptions): Promise<void>

参数说明：

• options：创建参数，SetupPlayerOptions 类型，必传，详细类型说明如下

参数名	说明	类型	必须	默认值
lowLatency	是否使用无延迟播放	boolean	否	false
playbackOptions	回放参数	SetupPlayerPlaybackOptions	否	-
autoplay	是否自动播放	boolean	否	根据后台设置
showController	是否显示控制栏	boolean	否	true
playerContext	播放器容器	PlayerBridgeInstance	否	-

示例：

const playerCtx = this.selectComponent('#player-bridging');
await watchCore.player.setupPlayer({
  lowLatency: true, // 使用无延迟播放
  playerContext: playerCtx,
});

9.3 是否支持无延迟观看

通过 supportLowLatency 方法获取当前环境和频道是否支持无延迟观看。

Api 方法： supportLowLatency(): SupportResult

返回值说明： 支持结果，SupportResult 类型

示例：

const supportResult = watchCore.player.supportLowLatency();
if (supportResult.support) {
  console.log('支持无延迟观看');
} else {
  console.log('不支持无延迟观看');
}

9.4 恢复视频播放

通过 play 方法触发播放器播放直播流或视频。

Api 方法： play(): void

示例：

// 恢复播放
watchCore.player.play();

9.5 暂停视频播放

通过 pause 方法暂停视频播放。

Api 方法： pause(): void

示例：

// 暂停播放
watchCore.player.pause();

9.6 设置播放进度

当观众拖拽回放进度条时，通过 seekVideo 设置回放播放进度。

Api 方法： seekVideo(time: number): void

参数说明：

• time：播放时间，单位秒，number 类型，必传

示例：

// 切到 1 分 20 秒
watchCore.player.seekVideo(120);

9.7 获取播放器暖场设置信息

用于获取管理后台设置的播放器暖场信息，注意暖场设置有一定延迟，需要通过 PlayerEvents.PlayerWarmUpSettingChange 事件监听信息更新。

Api 方法： getPlayerWarmUpSetting(): PlayerWarmUpSetting

返回值说明： 播放器暖场设置，PlayerWarmUpSetting 类型，详细类型说明如下

属性名	说明	类型
warmUpType	暖场类型	undefined | WarmUpType
warmUpImg	暖场图片地址	undefined | string
warmUpVideo	暖场视频地址	undefined | string
warmUpHref	暖场图片点击跳转地址	undefined | string

示例：

watchCore.player.eventEmitter.on(PlayerEvents.PlayerWarmUpSettingChange, () => {
  const setting = watchCore.player.getPlayerWarmUpSetting();
  console.log('暖场类型', setting.warmUpType);
  console.log('暖场图片地址', setting.warmUpImg);
  console.log('暖场视频地址', setting.warmUpVideo);
});

9.8 销毁播放器

页面或组件销毁前调用 destroyPlayer 销毁播放器。

Api 方法： destroyPlayer(): void

示例：

watchCore.player.destroyPlayer();

十、倍速

10.1 获取播放器信息

播放器模块会保存播放器的状态信息，通过 getPlayerInfo 方法获取当前播放的所有状态。

Api 方法： getPlayerInfo(): PlayerStoreInfo

返回值说明： 播放器信息，PlayerStoreInfo 类型，详细类型说明如下

属性名	说明	类型
playerInited	播放器是否初始化完成	boolean
supportRefresh	是否支持刷新	boolean
supportAutoPlay	是否支持自动播放	boolean
supportLowLatency	是否支持无延迟播放	boolean
isLowLatency	当前是否无延迟播放	boolean
playStatus	播放状态	PlayStatus
barrageShow	弹幕显示状态	boolean
supportBarrageSpeed	是否支持弹幕速度切换	boolean
currentBarrageSpeed	弹幕速度	number
currentVolume	当前音量	number
lineCount	总线路数	number
currentLine	当前线路索引	number
qualityLevels	可选的清晰度列表	QualityLevelItem[]
currentQualityLevel	当前清晰度级别	number
rateList	可选的倍速列表	number[]
currentRate	当前倍速	number
durationTime	播放总时长，单位：秒	number
currentTime	当前播放进度，单位：秒	number

示例：

const playerInfo = watchCore.player.getPlayerInfo();
console.log('播放状态', playerInfo.playStatus); // playing or pause
console.log('是否支持无延迟', playerInfo.supportLowLatency);
console.log('是否无延迟', playerInfo.isLowLatency);

10.2 创建播放器

通过 setupPlayer 创建观看页的播放器。

lowLatency 参数负责控制播放器是否使用无延迟播放，开启后若当前为无延迟频道并且设备支持无延迟播放则使用无延迟进行播放，开发者可通过 supportLowLatency 方法判断当前环境和频道是否支持无延迟。

通过 PlayerEvents.PlayerInited 监听播放器创建并初始化完成事件，当触发该事件后即可调用播放器模块的其他方法，如：play、pause。

Api 方法： setupPlayer(options: SetupPlayerOptions): Promise<void>

参数说明：

• options：创建参数，SetupPlayerOptions 类型，必传，详细类型说明如下

参数名	说明	类型	必须	默认值
lowLatency	是否使用无延迟播放	boolean	否	false
playbackOptions	回放参数	SetupPlayerPlaybackOptions	否	-
autoplay	是否自动播放	boolean	否	根据后台设置
showController	是否显示控制栏	boolean	否	true
playerContext	播放器容器	PlayerBridgeInstance	否	-

示例：

const playerCtx = this.selectComponent('#player-bridging');
await watchCore.player.setupPlayer({
  lowLatency: true, // 使用无延迟播放
  playerContext: playerCtx,
});

10.3 是否支持无延迟观看

通过 supportLowLatency 方法获取当前环境和频道是否支持无延迟观看。

Api 方法： supportLowLatency(): SupportResult

返回值说明： 支持结果，SupportResult 类型

示例：

const supportResult = watchCore.player.supportLowLatency();
if (supportResult.support) {
  console.log('支持无延迟观看');
} else {
  console.log('不支持无延迟观看');
}

10.4 恢复视频播放

通过 play 方法触发播放器播放直播流或视频。

Api 方法： play(): void

示例：

// 恢复播放
watchCore.player.play();

10.5 暂停视频播放

通过 pause 方法暂停视频播放。

Api 方法： pause(): void

示例：

// 暂停播放
watchCore.player.pause();

10.6 设置播放进度

当观众拖拽回放进度条时，通过 seekVideo 设置回放播放进度。

Api 方法： seekVideo(time: number): void

参数说明：

• time：播放时间，单位秒，number 类型，必传

示例：

// 切到 1 分 20 秒
watchCore.player.seekVideo(120);

10.7 获取播放器暖场设置信息

用于获取管理后台设置的播放器暖场信息，注意暖场设置有一定延迟，需要通过 PlayerEvents.PlayerWarmUpSettingChange 事件监听信息更新。

Api 方法： getPlayerWarmUpSetting(): PlayerWarmUpSetting

返回值说明： 播放器暖场设置，PlayerWarmUpSetting 类型，详细类型说明如下

属性名	说明	类型
warmUpType	暖场类型	undefined | WarmUpType
warmUpImg	暖场图片地址	undefined | string
warmUpVideo	暖场视频地址	undefined | string
warmUpHref	暖场图片点击跳转地址	undefined | string

示例：

watchCore.player.eventEmitter.on(PlayerEvents.PlayerWarmUpSettingChange, () => {
  const setting = watchCore.player.getPlayerWarmUpSetting();
  console.log('暖场类型', setting.warmUpType);
  console.log('暖场图片地址', setting.warmUpImg);
  console.log('暖场视频地址', setting.warmUpVideo);
});

10.8 销毁播放器

页面或组件销毁前调用 destroyPlayer 销毁播放器。

Api 方法： destroyPlayer(): void

示例：

watchCore.player.destroyPlayer();

十一、回放

11.1 设置播放进度

当观众拖拽回放进度条时，通过 seekVideo 设置回放播放进度。

Api 方法： seekVideo(time: number): void

参数说明：

• time：播放时间，单位秒，number 类型，必传

示例：

// 切到 1 分 20 秒
watchCore.player.seekVideo(120);

十二、播放器设置

12.1 获取播放器暖场设置信息

用于获取管理后台设置的播放器暖场信息，注意暖场设置有一定延迟，需要通过 PlayerEvents.PlayerWarmUpSettingChange 事件监听信息更新。

Api 方法： getPlayerWarmUpSetting(): PlayerWarmUpSetting

返回值说明： 播放器暖场设置，PlayerWarmUpSetting 类型，详细类型说明如下

属性名	说明	类型
warmUpType	暖场类型	undefined | WarmUpType
warmUpImg	暖场图片地址	undefined | string
warmUpVideo	暖场视频地址	undefined | string
warmUpHref	暖场图片点击跳转地址	undefined | string

示例：

watchCore.player.eventEmitter.on(PlayerEvents.PlayerWarmUpSettingChange, () => {
  const setting = watchCore.player.getPlayerWarmUpSetting();
  console.log('暖场类型', setting.warmUpType);
  console.log('暖场图片地址', setting.warmUpImg);
  console.log('暖场视频地址', setting.warmUpVideo);
});

十三、时移打点

13.1 获取播放器信息

播放器模块会保存播放器的状态信息，通过 getPlayerInfo 方法获取当前播放的所有状态。

Api 方法： getPlayerInfo(): PlayerStoreInfo

返回值说明： 播放器信息，PlayerStoreInfo 类型，详细类型说明如下

属性名	说明	类型
playerInited	播放器是否初始化完成	boolean
supportRefresh	是否支持刷新	boolean
supportAutoPlay	是否支持自动播放	boolean
supportLowLatency	是否支持无延迟播放	boolean
isLowLatency	当前是否无延迟播放	boolean
playStatus	播放状态	PlayStatus
barrageShow	弹幕显示状态	boolean
supportBarrageSpeed	是否支持弹幕速度切换	boolean
currentBarrageSpeed	弹幕速度	number
currentVolume	当前音量	number
lineCount	总线路数	number
currentLine	当前线路索引	number
qualityLevels	可选的清晰度列表	QualityLevelItem[]
currentQualityLevel	当前清晰度级别	number
rateList	可选的倍速列表	number[]
currentRate	当前倍速	number
durationTime	播放总时长，单位：秒	number
currentTime	当前播放进度，单位：秒	number

示例：

const playerInfo = watchCore.player.getPlayerInfo();
console.log('播放状态', playerInfo.playStatus); // playing or pause
console.log('是否支持无延迟', playerInfo.supportLowLatency);
console.log('是否无延迟', playerInfo.isLowLatency);

13.2 创建播放器

通过 setupPlayer 创建观看页的播放器。

lowLatency 参数负责控制播放器是否使用无延迟播放，开启后若当前为无延迟频道并且设备支持无延迟播放则使用无延迟进行播放，开发者可通过 supportLowLatency 方法判断当前环境和频道是否支持无延迟。

通过 PlayerEvents.PlayerInited 监听播放器创建并初始化完成事件，当触发该事件后即可调用播放器模块的其他方法，如：play、pause。

Api 方法： setupPlayer(options: SetupPlayerOptions): Promise<void>

参数说明：

• options：创建参数，SetupPlayerOptions 类型，必传，详细类型说明如下

参数名	说明	类型	必须	默认值
lowLatency	是否使用无延迟播放	boolean	否	false
playbackOptions	回放参数	SetupPlayerPlaybackOptions	否	-
autoplay	是否自动播放	boolean	否	根据后台设置
showController	是否显示控制栏	boolean	否	true
playerContext	播放器容器	PlayerBridgeInstance	否	-

示例：

const playerCtx = this.selectComponent('#player-bridging');
await watchCore.player.setupPlayer({
  lowLatency: true, // 使用无延迟播放
  playerContext: playerCtx,
});

13.3 是否支持无延迟观看

通过 supportLowLatency 方法获取当前环境和频道是否支持无延迟观看。

Api 方法： supportLowLatency(): SupportResult

返回值说明： 支持结果，SupportResult 类型

示例：

const supportResult = watchCore.player.supportLowLatency();
if (supportResult.support) {
  console.log('支持无延迟观看');
} else {
  console.log('不支持无延迟观看');
}

13.4 恢复视频播放

通过 play 方法触发播放器播放直播流或视频。

Api 方法： play(): void

示例：

// 恢复播放
watchCore.player.play();

13.5 暂停视频播放

通过 pause 方法暂停视频播放。

Api 方法： pause(): void

示例：

// 暂停播放
watchCore.player.pause();

13.6 设置播放进度

当观众拖拽回放进度条时，通过 seekVideo 设置回放播放进度。

Api 方法： seekVideo(time: number): void

参数说明：

• time：播放时间，单位秒，number 类型，必传

示例：

// 切到 1 分 20 秒
watchCore.player.seekVideo(120);

13.7 获取播放器暖场设置信息

用于获取管理后台设置的播放器暖场信息，注意暖场设置有一定延迟，需要通过 PlayerEvents.PlayerWarmUpSettingChange 事件监听信息更新。

Api 方法： getPlayerWarmUpSetting(): PlayerWarmUpSetting

返回值说明： 播放器暖场设置，PlayerWarmUpSetting 类型，详细类型说明如下

属性名	说明	类型
warmUpType	暖场类型	undefined | WarmUpType
warmUpImg	暖场图片地址	undefined | string
warmUpVideo	暖场视频地址	undefined | string
warmUpHref	暖场图片点击跳转地址	undefined | string

示例：

watchCore.player.eventEmitter.on(PlayerEvents.PlayerWarmUpSettingChange, () => {
  const setting = watchCore.player.getPlayerWarmUpSetting();
  console.log('暖场类型', setting.warmUpType);
  console.log('暖场图片地址', setting.warmUpImg);
  console.log('暖场视频地址', setting.warmUpVideo);
});

13.8 销毁播放器

页面或组件销毁前调用 destroyPlayer 销毁播放器。

Api 方法： destroyPlayer(): void

示例：

watchCore.player.destroyPlayer();

十四、实时字幕

14.1 获取播放器信息

播放器模块会保存播放器的状态信息，通过 getPlayerInfo 方法获取当前播放的所有状态。

Api 方法： getPlayerInfo(): PlayerStoreInfo

返回值说明： 播放器信息，PlayerStoreInfo 类型，详细类型说明如下

属性名	说明	类型
playerInited	播放器是否初始化完成	boolean
supportRefresh	是否支持刷新	boolean
supportAutoPlay	是否支持自动播放	boolean
supportLowLatency	是否支持无延迟播放	boolean
isLowLatency	当前是否无延迟播放	boolean
playStatus	播放状态	PlayStatus
barrageShow	弹幕显示状态	boolean
supportBarrageSpeed	是否支持弹幕速度切换	boolean
currentBarrageSpeed	弹幕速度	number
currentVolume	当前音量	number
lineCount	总线路数	number
currentLine	当前线路索引	number
qualityLevels	可选的清晰度列表	QualityLevelItem[]
currentQualityLevel	当前清晰度级别	number
rateList	可选的倍速列表	number[]
currentRate	当前倍速	number
durationTime	播放总时长，单位：秒	number
currentTime	当前播放进度，单位：秒	number

示例：

const playerInfo = watchCore.player.getPlayerInfo();
console.log('播放状态', playerInfo.playStatus); // playing or pause
console.log('是否支持无延迟', playerInfo.supportLowLatency);
console.log('是否无延迟', playerInfo.isLowLatency);

14.2 创建播放器

通过 setupPlayer 创建观看页的播放器。

lowLatency 参数负责控制播放器是否使用无延迟播放，开启后若当前为无延迟频道并且设备支持无延迟播放则使用无延迟进行播放，开发者可通过 supportLowLatency 方法判断当前环境和频道是否支持无延迟。

通过 PlayerEvents.PlayerInited 监听播放器创建并初始化完成事件，当触发该事件后即可调用播放器模块的其他方法，如：play、pause。

Api 方法： setupPlayer(options: SetupPlayerOptions): Promise<void>

参数说明：

• options：创建参数，SetupPlayerOptions 类型，必传，详细类型说明如下

参数名	说明	类型	必须	默认值
lowLatency	是否使用无延迟播放	boolean	否	false
playbackOptions	回放参数	SetupPlayerPlaybackOptions	否	-
autoplay	是否自动播放	boolean	否	根据后台设置
showController	是否显示控制栏	boolean	否	true
playerContext	播放器容器	PlayerBridgeInstance	否	-

示例：

const playerCtx = this.selectComponent('#player-bridging');
await watchCore.player.setupPlayer({
  lowLatency: true, // 使用无延迟播放
  playerContext: playerCtx,
});

14.3 是否支持无延迟观看

通过 supportLowLatency 方法获取当前环境和频道是否支持无延迟观看。

Api 方法： supportLowLatency(): SupportResult

返回值说明： 支持结果，SupportResult 类型

示例：

const supportResult = watchCore.player.supportLowLatency();
if (supportResult.support) {
  console.log('支持无延迟观看');
} else {
  console.log('不支持无延迟观看');
}

14.4 恢复视频播放

通过 play 方法触发播放器播放直播流或视频。

Api 方法： play(): void

示例：

// 恢复播放
watchCore.player.play();

14.5 暂停视频播放

通过 pause 方法暂停视频播放。

Api 方法： pause(): void

示例：

// 暂停播放
watchCore.player.pause();

14.6 设置播放进度

当观众拖拽回放进度条时，通过 seekVideo 设置回放播放进度。

Api 方法： seekVideo(time: number): void

参数说明：

• time：播放时间，单位秒，number 类型，必传

示例：

// 切到 1 分 20 秒
watchCore.player.seekVideo(120);

14.7 获取播放器暖场设置信息

用于获取管理后台设置的播放器暖场信息，注意暖场设置有一定延迟，需要通过 PlayerEvents.PlayerWarmUpSettingChange 事件监听信息更新。

Api 方法： getPlayerWarmUpSetting(): PlayerWarmUpSetting

返回值说明： 播放器暖场设置，PlayerWarmUpSetting 类型，详细类型说明如下

属性名	说明	类型
warmUpType	暖场类型	undefined | WarmUpType
warmUpImg	暖场图片地址	undefined | string
warmUpVideo	暖场视频地址	undefined | string
warmUpHref	暖场图片点击跳转地址	undefined | string

示例：

watchCore.player.eventEmitter.on(PlayerEvents.PlayerWarmUpSettingChange, () => {
  const setting = watchCore.player.getPlayerWarmUpSetting();
  console.log('暖场类型', setting.warmUpType);
  console.log('暖场图片地址', setting.warmUpImg);
  console.log('暖场视频地址', setting.warmUpVideo);
});

14.8 销毁播放器

页面或组件销毁前调用 destroyPlayer 销毁播放器。

Api 方法： destroyPlayer(): void

示例：

watchCore.player.destroyPlayer();

十五、销毁

15.1 销毁播放器

页面或组件销毁前调用 destroyPlayer 销毁播放器。

Api 方法： destroyPlayer(): void

示例：

watchCore.player.destroyPlayer();