文档中心

方法

最近更新时间：2024.04.12 15:38:55

首次发布时间：2024.04.12 15:38:55

VePlayer

类型：class

属性

属性	类型	描述
player	PlayerCore	播放器内核实例，详情参考播放器内核。
src	any	返回当前视频的地址
musicMode	PlayModeType	获取音乐播放模式
musicTimeScale	number	获取音乐播放快进快退时间跨度
musicList	IMusicListItem[]	获取音乐播放列表
region	TRegionType	`只读` 获取当前配置的region
`static` sdkVersion	string	sdk版本

new VePlayer()

构造函数

类型

constructor(configs: IPlayerConfig)

参数

名称	类型	必选	默认值	描述
configs	IPlayerConfig	是	无	sdk配置

on()

监听事件。

类型

(action: string, func: (...args: any[]) => void) => void

参数

名称	类型	必选	默认值	描述
action	string	是	无	事件名。
...func	(...args: any[]) => void	是	无	回调函数。

emit()

触发事件。

类型

(action: string, payload?: any) => void

参数

名称	类型	必选	默认值	描述
action	string	是	无	事件名。
payload	any	是	无	事件数据。

once()

监听事件。事件处理函数只执行一次。

类型

(action: string, func: (...args: any[]) => void) => void

参数

名称	类型	必选	默认值	描述
action	string	是	无	事件名。
...func	(...args: any[]) => void	是	无	回调函数。

off()

解绑事件监听。

类型

(action: string, func: (...args: any[]) => void) => void

参数

名称	类型	必选	默认值	描述
action	string	是	无	事件名。
...func	(...args: any[]) => void	是	无	回调函数。

switchAuthToken()

播放时更换 playAuthToken，以更换视频源。

类型

(config: IPlayAuthTokenConfig, isNewVideo?: boolean) => Promise<void>

参数

名称	类型	必选	默认值	描述
config	IPlayAuthTokenConfig	是	无	`playAuthToken` 配置。
isNewVideo	boolean	是	`'true'`	是否为新视频。为 `false` 时，更换后，会从更换前的时间点继续播放。

返回值

Promise<void>

updateAuthToken()

更新 playAuthToken。

注意

播放前 playAuthToken 过期（收到 play_auth_token_expired 事件或者 onTokenExpired 回调触发）时，调用此方法更新 playAuthToken。

类型

(config: IPlayAuthTokenConfig) => Promise<void>

参数

名称	类型	必选	默认值	描述
config	IPlayAuthTokenConfig	是	无	`playAuthToken` 配置。

返回值

Promise<void>

switchURL()

播放时更换视频 URL，以更换视频源。

注意

更换后，会从更换前的时间点继续播放。

类型

(url: string) => Promise<void>

参数

名称	类型	必选	默认值	描述
url	string	是	无	视频播放地址。

返回值

Promise<void>

playNext()

播放下一视频。

注意

成功更换视频源后，默认是暂停状态，如果设置了自动播放，则会自动播放。

类型

(config: IPlayerConfig, isNewVideo?: boolean) => Promise<any>

参数

名称	类型	必选	默认值	描述
config	IPlayerConfig	是	无	播放器实例化配置。
isNewVideo	boolean	是	`'true'`	是否为新视频。为 `false` 时，更换后，会从更换前的时间点继续播放。

返回值

Promise<any>

musicAdd()

向播放列表中加入歌曲。

注意

仅音乐播放模式开启时（isMusic 为 true 时）有效。

类型

(meta: IMusicListItem) => void

参数

名称	类型	必选	默认值	描述
meta	IMusicListItem	是	无	歌曲信息。

musicRandom()

随机获取播放列表中的一首歌曲。

注意

仅音乐播放模式开启时（isMusic 为 true 时）有效。

类型

() => IMusicListItem

返回值

IMusicListItem 歌曲信息

musicNext()

播放播放列表中的下一首歌曲。

注意

仅音乐播放模式开启时（isMusic 为 true 时）有效。

类型

() => void

musicPrev()

播放播放列表中的上一首歌曲。

注意

仅音乐播放模式开启时（isMusic 为 true 时）有效。

类型

() => void

musicSetIndex()

播放播放列表中的指定歌曲。

注意

仅音乐播放模式开启时（isMusic 为 true 时）有效。

类型

(index: number) => void

参数

名称	类型	必选	默认值	描述
index	number	是	无	播放列表中的序号。

musicForward()

歌曲快进。

注意

仅音乐播放模式开启时（isMusic 为 true 时）有效。

类型

() => void

musicBackward()

歌曲后退。

注意

仅音乐播放模式开启时（isMusic 为 true 时）有效。

类型

() => void

musicRemove()

移除播放列表中的指定歌曲。

注意

仅音乐播放模式开启时（isMusic 为 true 时）有效。

类型

(vid: string | number) => void

参数

名称	类型	必选	默认值	描述
vid	string \| number	是	无	待移除歌曲的 `vid`。

musicSetAbCycle()

设置 AB 循环，即设置播放区域任意位置循环播放。

注意

仅音乐播放模式开启时（isMusic 为 true 时）有效。

类型

(start: number | IABCycle, end?: number, loop?: boolean, ext?: { [propName: string]: any; } | undefined) => void

参数

名称	类型	必选	默认值	描述
start	number \| IABCycle	是	无	AB 循环段起始位置，单位为秒。
end	number \| undefined	否	无	AB 循环段结束位置，单位为秒。
loop	boolean \| undefined	否	无	是否循环播放。
ext	{ [propName: string]: any; } \| undefined	否	无

musicRemoveAbCycle()

移除 AB 循环。

类型

() => void

getLogUserId()

获取质量日志上报的用户 ID。

注意

获取用户 ID 后，您可进入视频点播控制台单点追查页面，根据用户 ID 查询该用户的播放日志。

类型

() => string

返回值

string

getPlugin()

获取插件实例。

类型

(pluginName: string) => null | BasePlugin

参数

名称	类型	必选	默认值	描述
pluginName	string	是	无	插件名。

返回值

null | BasePlugin

destroy()

销毁当前播放器实例。

类型

() => Promise<void>

返回值

Promise<void>