VePlayerLive #

类型：class

属性 #

openLog() #

调用此方法开启直播日志上报。

类型

() => void

closeLog() #

调用此方法关闭直播日志上报。

类型

() => void

openInfoPanel() #

调用此方法将打开直播信息面板，面板将展示拉流格式、帧率、码率、GOP、视频分辨率、编码方式、Buffer 水位、播放进度等基础信息。如果当前是软解，还会显示软解解码效率和解码消耗。

类型

() => void

closeInfoPanel() #

调用此方法关闭直播信息面板。

类型

() => void

openAbr() #

打开码率自适应（ABR）切换功能。

类型

() => void

closeAbr() #

关闭码率自适应（ABR）切换功能。

类型

() => void

updateDrmConfig() #

调用此方法更新 DRM 配置。

类型

(config: Drm) => Promise<void | undefined>

参数

返回值

Promise<void | undefined>

switchAbr() #

修改 ABR 配置，包含修改是否开启 ABR 功能，和修改其他清晰度。

类型

(options: { enable: boolean; bitrate: number;}) => void

参数

返回值

getRTMNetWorkInfo() #

获取 RTM 拉流的网络评估信息。

类型

() => RTMNetWorkInfo

返回值

RTMNetWorkInfo

getRTMStats() #

获取 RTM 拉流的播放信息。

类型

() => Promise<StatsSnapShoot>

返回值

Promise<StatsSnapShoot>

getFLVStats() #

获取 FLV 拉流的播放信息。

类型

() => FlvStats

返回值

FlvStats

updatePlaylist() #

调用此方法更新播放列表，支持更新源、清晰度等相关信息。

类型

(playlist: Source[], target?: string | { definition?: string; source?: string;}, needUpdateProtocol?: boolean) => Promise<void>

参数

返回值

Promise<void>

switch() #

调用此方法切换拉流地址、线路、清晰度。

类型

(target: string | { definition?: string; source?: string;}, options?: { fallbackToFirstDefinition?: boolean; seamless?: boolean;}) => Promise<ExposedDefinition>

参数

返回值

Promise<ExposedDefinition>

once() #

调用此方法监听指定事件，事件处理函数只执行一次。

类型

(event: string, callback: (data?: any) => any) => void

参数

off() #

调用此方法解绑或移除指定事件的事件监听。

类型

(event: string, callback: (data?: any) => any) => void

参数

emit() #

调用此方法触发指定事件。

类型

(event: string, data?: any) => void

参数

offAll() #

调用此方法解绑或移除指定事件的所有事件监听。

类型

() => void

on() #

调用此方法监听指定事件。

类型

(event: string, callback: (data?: any) => any) => void

参数

play() #

调用此方法开始播放。

类型

() => any

返回值

any

pause() #

调用此方法暂停播放。

类型

() => void

requestPIP() #

调用此方法打开画中画。

类型

() => void

exitPIP() #

调用此方法关闭画中画。

类型

() => void

retry() #

调用此方法重新拉流。

类型

() => void

focus() #

播放器获取焦点，调用该方法 veplayer.isFocused 将会变为 true，并触发 PLAYER_FOCUS 事件。

类型

(data?: { autoHide?: boolean; delay?: number;}) => void

参数

blur() #

播放器失去焦点，调用该方法 veplayer.isFocused 将会变为 false，并触发 PLAYER_BLUR 事件。

类型

(data?: { ignorePaused?: boolean;}) => void

参数

canPlayType() #

判断浏览器是否支持播放格式。

类型

(type: string) => boolean

参数

返回值

boolean

requestFullscreen() #

调用此方法进入系统全屏状态。如果该方法调用的时候处于网页全屏状态会自动退出网页全屏，下发事件 Events.FULLSCREEN_CHANGE。

类型

(el?: HTMLElement) => Promise<void>

参数

返回值

Promise<void>

exitFullscreen() #

调用此方法退出系统全屏状态，调用该方法 veplayer.isFullscreen 将会变为 false，并触发 Events.FULLSCREEN_CHANGE 事件。

类型

(el?: HTMLElement) => Promise<void>

参数

返回值

Promise<void>

requestCssFullscreen() #

调用此方法进入网页样式全屏状态，播放器进入网页全屏，利用 CSS 模拟实现全屏效果。如果该接口调用的时候处于全屏状态，会自动退出全屏，下发事件 Events.CSS_FULLSCREEN_CHANGE。

类型

(el?: HTMLElement) => void

参数

exitCssFullscreen() #

调用此方法退出网页样式全屏状态。 调用该方法 veplayer.isFullscreen 将会变为 false，并触发 Events.CSS_FULLSCREEN_CHANGE 事件。

类型

() => void

registerPlugin() #

调用此方法在当前播放器上注册指定插件。

类型

(plugin: Function | { plugin: Function; options: object;}, config?: { [propName: string]: any; } | undefined) => any

参数

返回值

any

unRegisterPlugin() #

调用此方法在当前播放器上销毁/注销指定插件。

类型

(plugin: any) => void

参数

showIcon() #

调用此接口显示指定插件图标。

类型

(pluginNames: string[]) => void

参数

hideIcon() #

调用此接口隐藏指定插件图标。

类型

(pluginNames: string[]) => void

参数

destroy() #

调用此方法销毁播放器实例。

类型

() => void

createLivePlayer() #

创建直播播放器。

类型

(options?: LiveVePlayerOptions) => Promise<VePlayerLive>

参数

返回值

Promise<VePlayerLive> 播放器实例。

示例

VePlayer.createLivePlayer({
 height: 360,
 url: options.url,
}).then(function (veplayer) {
 veplayer.on(VePlayer.live.Events.CANPLAY, function () {
   console.log('监听到 canplay 事件')
 });
}).catch(error => {
 console.log('创建播放器失败，报错信息:', error);
});;

prepare() #

初始化播放器策略。

类型

(options: PrepareOptions) => Promise<VeStrategyManager | undefined>

参数

返回值

Promise<VeStrategyManager | undefined>

示例

live.prepare({
 appId: '***',
 userId: '***',
 strategies: {
  rtmAdaptiveBuffer: true,
 },
}).then(function () {
 VePlayer.createLivePlayer({
  height: '300px',
  url: 'https://pulldomain.com/appname/streamname.sdp',
  logger: {
    userId: '***',
    appId: '***',
  },
 });
});

isRTMSupported() #

当前浏览器是否支持 RTM 流播放。

类型

() => Promise<boolean>

返回值

Promise<boolean>

isRTMSupportCodec() #

当前浏览器是否支持 H264 RTM 流播放。

类型

(codec?: string) => Promise<boolean>

参数