VePlayer #

类型：class

属性 #

new VePlayer() #

构造函数。

类型

constructor(configs: IPlayerConfig)

参数

on() #

监听事件。

类型

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

参数

emit() #

触发事件。

类型

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

参数

once() #

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

类型

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

参数

off() #

解绑事件监听。

类型

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

参数

updateMediaSource() #

更新播放源。您可在视频播放地址过期前调用此方法更新地址及过期时间戳。

类型

(source: SourceConfig) => Promise<void>

参数

返回值

Promise<void>

switchAuthToken() #

播放时更换临时播放 Token，以更换视频源。

注意

此接口不支持切换火山引擎私有加密 Token。

类型

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

参数

返回值

Promise<void>

updateAuthToken() #

更新临时播放 Token。

注意

• 播放前临时播放 Token 过期（收到 play_auth_token_expired 事件或者 onTokenExpired 回调触发）时，调用此方法更新临时播放 Token。
• 此接口不支持切换火山引擎私有加密 Token。

类型

(config: IPlayAuthTokenConfig) => Promise<void>

参数

返回值

Promise<void>

playNext() #

播放下一视频。

注意

• 成功更换视频源后，默认是暂停状态。如果设置了自动播放，则会自动播放。
• 此接口不支持切换火山引擎私有加密视频。

类型

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

参数

返回值

Promise<any>

changeDefinition() #

切换清晰度

注意

如果传的清晰度不存在，则不处理。可以通过api: getDefinitionList()获取当前的清晰度列表

类型

(definition: string) => void

参数

getDefinitionList() #

获取当前的清晰度列表，列表项中包含definition、url和selected，selected为true时表示当前被选中的清晰度

类型

() => { [propName: string]: any; definition: string; url: IUrl; selected: boolean; }[]

返回值

Array<{ definition: string; url: IUrl; selected: boolean; [propName: string]: any; }>

getAudioTracks() #

获取音频轨道列表。HLS 流通过 hls.js 获取，iOS 原生播放通过 HTMLMediaElement.audioTracks 获取。

注意

每项包含 id、name、lang、channels、default、selected 字段；轨道数量 ≤ 1 时返回空数组。

类型

() => AudioTrackInfo[]

返回值

AudioTrackInfo[]

getCurrentAudioTrack() #

获取当前激活的音频轨道。

注意

HLS 流通过 hls.js 获取，iOS 原生播放通过 HTMLMediaElement.audioTracks 获取；无激活轨道时返回 null。

类型

() => AudioTrackInfo | null

返回值

AudioTrackInfo | null

switchAudioTrack() #

切换音频轨道。

注意

切换完成后会触发 Events.AUDIO_TRACK_CHANGE 事件；
同时 PC 端和移动端音频轨道插件的选中状态会自动更新。

类型

(track: AudioTrackInfo) => void

参数

musicAdd() #

向播放列表中加入歌曲。

注意

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

类型

(meta: IMusicListItem) => void

参数

musicRandom() #

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

注意

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

类型

() => IMusicListItem

返回值

IMusicListItem 歌曲信息

musicNext() #

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

注意

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

类型

() => void

musicPrev() #

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

注意

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

类型

() => void

musicSetIndex() #

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

注意

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

类型

(index: number) => void

参数

musicForward() #

歌曲快进。

注意

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

类型

() => void

musicBackward() #

歌曲后退。

注意

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

类型

() => void

musicRemove() #

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

注意

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

类型

(vid: string | number) => void

参数

musicSetAbCycle() #

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

注意

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

类型

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

参数

musicRemoveAbCycle() #

移除 AB 循环。

类型

() => void

getLogUserId() #

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

注意

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

类型

() => string

返回值

string

getPlugin() #

获取插件实例。

类型

(pluginName: string) => null | BasePlugin

参数

返回值

null | BasePlugin

destroy() #

销毁当前播放器实例。

类型

() => Promise<void>

返回值

Promise<void>

static prepare() #

播放策略预初始化配置

类型

(options: StrategyInitOptions) => Promise<void>

参数

返回值

Promise<void>

static setPreloadScene() #

设置预加载模式

类型

(preloadScene: PreloadScene, options?: IPreloadUpdateConfig) => void

参数

static addPreloadList() #

添加待预加载视频列表

类型

(list: IPreloadStream[]) => void

参数

static setPreloadList() #

设置待预加载视频列表，替换当前已设置的待预加载列表

类型

(list: IPreloadStream[]) => Promise<void>

参数

返回值

Promise<void>

static setLicenseConfig() #

类型

(config: ILicenseConfig) => Promise<void>

参数

返回值

Promise<void>

static checkLicense() #

类型

() => Promise<LicenseEdition>

返回值

Promise<LicenseEdition>

static checkModuleList() #

类型

() => Promise<string[]>

返回值

Promise<string[]>

static checkLicenseStatus() #

类型

() => Promise<LicenseStatus>

返回值

Promise<LicenseStatus>

static checkLicenseModuleAuth() #

类型

(module: string, featureName: LicenseFeature) => Promise<boolean>

参数

返回值

Promise<boolean>

static generateEncryptInfo() #

生成私有加密播放的必要信息

类型

(unionId: string, streamType: 'hls' | 'mp4' | 'dash') => Promise<EncryptInfo | undefined>

参数

返回值

Promise<EncryptInfo | undefined>