Class: PolyvLive
Polyv Wx Live Player Component
Polyv Wx Live Player Component / modules/plv-live-player-core/polyv-live-player / PolyvLive
Class: PolyvLive
Constructors
Constructor
new PolyvLive(
config):PolyvLive
Parameters
config
Returns
PolyvLive
Methods
changeLevel()
changeLevel(
level):void
Switch clarity level
Parameters
level
number
Clarity index, 0 represents smooth
Returns
void
Description
Switch clarity level. After switching, the UPDATE_MEDIA_INFO event will be triggered.
Example
<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
Switch stream line
Parameters
line
number
Line index, 0 represents line 1
Returns
void
Description
Switch stream line. After switching, the UPDATE_MEDIA_INFO event will be triggered.
Example
<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
Switch latency core
Parameters
playCore
number
Latency core index, 0 represents normal latency, 1 represents no latency
Returns
void
Description
Switch latency core. After switching, the UPDATE_MEDIA_INFO event will be triggered.
destroy()
destroy():
void
Destroy the player instance
Returns
void
getPlayType()
getPlayType():
PlayType
Get the playback type
Returns
Playback type
Description
You can actively retrieve the current playback type via getPlayType.
Example
const playType = player.getPlayType();
if (playType === PlayType.WAIT_START) {
console.log('当前暂无直播, 显示暂未直播盖图');
}}
off()
off<
K>(event,listener):void
Remove event listener
Type Parameters
K
K extends keyof PlayerEventMap
Parameters
event
K
listener
Returns
void
on()
on<
K>(event,listener):void
Event listener
Type Parameters
K
K extends keyof PlayerEventMap
Parameters
event
K
listener
Returns
void
refresh()
refresh():
void
Refresh the current playback stream
Returns
void
Description
Typically used during live streaming when encountering buffering or lag, to actively refresh the current playback stream.
Example
<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
Monitor playback component state callback
Parameters
e
LivePlayerStateChange
Returns
void
setStatics()
setStatics(
statics):void
Set statistics parameters
Parameters
statics
Statistics parameters
Returns
void
Description
If you need to set a nickname during playback, you can update the statistics parameters via setStatics. Typically, param1 is used to set the user's unique ID, and param2 is used to set the user's nickname and other information.
Example
player.setStatics({
param2: '昵称',
});
setUp()
setUp():
Promise<void>
Initialize the player
Returns
Promise<void>
Description
Initialize the player, including authentication, parsing the current state, and other operations.
