保利威文档中心

幫助中心

類別: PolyvLive

更新時間:2025-10-10 12:02:04

Polyv Wx Live Player Component


Polyv Wx Live Player Component / modules/plv-live-player-core/polyv-live-player / PolyvLive

類別: PolyvLive

建構子

Constructor

new PolyvLive(config): PolyvLive

參數

config

PlayerConfig

回傳值

PolyvLive

方法

changeLevel()

changeLevel(level): void

切換清晰度

參數

level

number

清晰度索引 0 代表流暢

回傳值

void

說明

切換清晰度,切換清晰度後,會觸發UPDATE_MEDIA_INFO事件

範例

<button bind:tap="changeLevel"></button>

player.on(PlayerEventsType.UPDATE_MEDIA_INFO, (mediaInfo: MediaInfo) => {
 const { playType, src } = mediaInfo;
 this.setData({ src });
});

// 调用切换清晰度接口,触发`UPDATE_MEDIA_INFO`事件更新视频播放地址
function changeLevel() {
  player.changeLevel();
}

changeLine()

changeLine(line): void

切換線路

參數

line

number

線路索引 0 代表線路1

回傳值

void

說明

切換線路,切換線路後,會觸發UPDATE_MEDIA_INFO事件

範例

<button bind:tap="changeLine"></button>

player.on(PlayerEventsType.UPDATE_MEDIA_INFO, (mediaInfo: MediaInfo) => {
 const { playType, src } = mediaInfo;
 this.setData({ src });
});

// 调用切换线路接口,触发`UPDATE_MEDIA_INFO`事件更新视频播放地址
function changeLine() {
  player.changeLine(0);
}

changePlayCore()

changePlayCore(playCore): void

切換延遲核心

參數

playCore

number

延遲核心索引 0 代表普通延遲 1 代表無延遲

回傳值

void

說明

切換延遲核心,切換延遲核心後,會觸發UPDATE_MEDIA_INFO事件


destroy()

destroy(): void

銷毀播放實例

回傳值

void


getPlayType()

getPlayType(): PlayType

取得播放類型

回傳值

PlayType

播放類型

說明

可以透過 getPlayType 主動取得目前的播放類型

範例

const playType = player.getPlayType();

if (playType === PlayType.WAIT_START) {
  console.log('当前暂无直播, 显示暂未直播盖图');
}}

off()

off<K>(event, listener): void

取消事件監聽

型別參數

K

K extends keyof PlayerEventMap

參數

event

K

listener

PlayerEventMap[K]

回傳值

void


on()

on<K>(event, listener): void

事件監聽

型別參數

K

K extends keyof PlayerEventMap

參數

event

K

listener

PlayerEventMap[K]

回傳值

void


refresh()

refresh(): void

重新整理目前播放串流

回傳值

void

說明

一般用於直播過程中,出現卡頓等情況,主動重新整理目前播放串流

範例

<button bind:tap="refresh"></button>

player.on(PlayerEventsType.UPDATE_MEDIA_INFO, (mediaInfo: MediaInfo) => {
 const { playType, src } = mediaInfo;
 this.setData({ src });
});

// 调用刷新流接口,触发`UPDATE_MEDIA_INFO`事件更新视频播放地址
function refresh() {
  player.refresh();
}

setLivePlayerStateChange()

setLivePlayerStateChange(e): void

監測播放元件狀態回呼

參數

e

LivePlayerStateChange

回傳值

void


setStatics()

setStatics(statics): void

設定統計參數

參數

statics

PlayerStatisticsSetting

統計參數

回傳值

void

說明

播放中途如設定暱稱,可以透過setStatics更新統計參數。一般param1用於設定使用者唯一Id,param2用於設定使用者暱稱等資訊

範例

player.setStatics({
  param2: '昵称',
});

setUp()

setUp(): Promise<void>

播放器初始化

回傳值

Promise<void>

說明

初始化播放器,包括鑑權、解析目前狀態等操作

联系客服,在线咨询