VeLivePlayer

类型：class

直播播放器。

setConfig()

初始化播放器，用于设置是否开启 SEI 消息、是否开启硬件解码和是否开启本地 DNS 预解析等配置信息。

注意

需要在调用 play 开始播放之前，调用本方法进行播放器的初始化。

类型

(config: VeLivePlayerConfiguration) => void

参数

setObserver()

设置播放器回调，用于监听播放器 VeLivePlayer 的播放错误、播放状态、音视频首帧渲染状态和清晰度档位信息等回调事件。

注意

需要在调用 play 开始播放之前，调用本方法设置回调。

类型

(observer: VeLivePlayerObserver) => void

参数

setRenderFillMode()

设置播放器画面的填充模式。

注意

• 如果用于起播设置，需要在调用 play 开始播放之前，调用本方法设置视频的填充模式。
• 如果用于调节填充模式，可以在播放过程中调用本方法动态调节视频的填充模式。

类型

(fillMode: VeLivePlayerFillMode) => Promise<void>

参数

返回值

Promise<void>

setPlayUrl()

设置单个直播播放地址。

注意

需要在调用 play 开始播放之前，调用本方法设置单个直播播放地址。

类型

(url: string) => void

参数

setPlayStreamData()

多路流信息配置。例如，您需要使用 ABR、手动切档和主备流等依赖多路流的功能，可以调用本方法进行配置。

注意

需要在调用 play 开始播放之前，调用本方法设置多路流信息。

类型

(streamData: VeLivePlayerStreamData) => void

参数

play()

开始/恢复播放。

注意

调用本方法，在播放器完成拉流准备和首帧渲染播放后，都会触发 onPlayerStatusUpdate 播放器状态回调。

类型

() => Promise<void>

返回值

Promise<void>

pause()

暂停播放。

注意

调用本方法暂停播放后，会触发 onPlayerStatusUpdate 播放器状态回调。

类型

() => Promise<void>

返回值

Promise<void>

stop()

停止播放，不销毁播放器。

注意

调用本方法停止播放后，会触发 onPlayerStatusUpdate 播放器状态回调。

类型

() => Promise<void>

返回值

Promise<void>

destroy()

停止播放，并销毁播放器。

类型

() => void

switchResolution()

切换播放的清晰度档位。

注意

• 需要在调用 setPlayStreamData 设置多档位后，调用本方法切换播放器的清晰度档位。
• 调用本方法成功切换档位后，会触发清晰度档位变化 onResolutionSwitch 回调。

类型

(resolution: VeLivePlayerResolution) => void

参数

返回值

• true：成功；
• false：失败。

isPlaying()

检查播放器是否正在播放。

类型

() => boolean

返回值

boolean 是否正在播放。

• true：正在播放；
• false：未播放。

setPlayerVolume()

设置播放器音量。

类型

(volume: number) => void

参数

setMute()

设置是否静音播放。

类型

(mute: boolean) => void

参数

isMute()

获取是否处于静音状态。

类型

() => boolean

返回值

boolean 是否处于静音状态。

• true：静音；
• false：未静音。

setProperty()

设置播放器高级配置。高级配置包括离屏渲染设置、缓冲区最大时长、ABR 码率自适应算法类型等，如需了解详细信息，请联系火山引擎技术支持。

类型

(key: string, value: Object) => void

参数

setRenderRotation()

设置视频顺时针旋转角度。

注意

• 支持在播放前和播放中动态修改视频旋转角度。
• 每次调用本方法，播放器都将基于图像的原始角度进行旋转。
• 当同时使用旋转和镜像功能，播放器会先进行镜像，再进行旋转。

类型

(rotation: VeLivePlayerRotation) => Promise<void>

参数

返回值

Promise<void>

setRenderMirror()

设置视频镜像。

注意

• 支持在播放前和播放中动态修改视频镜像方式。
• 每次调用本方法，播放器都将基于原始图像进行镜像。
• 当同时使用旋转和镜像功能，播放器会先进行镜像，再进行旋转。

类型

(mirror: VeLivePlayerMirror) => Promise<void>

参数

返回值

Promise<void>

setEnableSuperResolution()

设置是否开启超分。您需要联系火山引擎技术支持开通超分功能后才可使用该功能。

注意

• 在首帧回调后，调用该接口开启超分。
• 支持播放中调用该接口动态开启和关闭超分。
• 如果机型、分辨率和帧率不符合限制，将无法开启超分，并触发 onStreamFailedOpenSuperResolution 回调。

类型

(enable: boolean) => void

参数

static getVersion()

获取播放器 SDK 的版本号。

类型

() => string

返回值

string 播放器 SDK 版本号。

static setLogLevel()

设置打印的日志级别。

类型

(logLevel: VeLivePlayerLogLevel) => void

参数