API 参考

LwlPlayer 是 Lwlplayer Docs 的核心类，提供了基于 FFmpeg 和 OHAudio 的多媒体播放能力，支持 OpenHarmony 环境下的流媒体、HTTP 视频以及本地文件播放。

枚举定义

LwlPlayerType

播放器类型。

名称	值	描述
STREAM	-	直播流播放器
HTTP	-	网络 HTTP 播放器
FILE	-	本地文件播放器

LwlVideoRate

播放倍速配置。

名称	值	描述
DEFAULT	1	正常倍速
DOUBLE	2	二倍速播放

状态枚举

用于回调函数中的状态识别：

• LwlPlayerAudioStatus: 音频相关状态（播放/录像/错误）。
• LwlPlayerStreamStatus: 直播流相关状态（成功/失败/网络异常）。
• LwlPlayerFileStatus: 本地文件相关状态（打开/播放状态）。

---

核心类：LwlPlayer

1. 初始化方法

initLwlPlayerXComponentController

初始化渲染控制层。

• 参数:
  • isMain: boolean: 是否为主显示区域。
  • position: number: 定位信息（0:全部, 1:上, 2:下, ...）。
• 返回: XComponentController。

createPlayer

创建播放器实例并初始化音频设备。

• 参数: type: LwlPlayerType。
• 返回: number (播放器索引 ptr，失败返回 -1)。

---

2. 播放控制

playStream

开始播放直播流。

• 参数:
  • ptr: number: 播放器索引。
  • path: string: 直播流地址。
• 返回: >=0 成功。

play

开始播放视频文件。

• 参数:
  • ptr: number: 播放器索引。
  • path: string: 文件路径。
  • seek: number: 起始播放位置（秒）。

stop / stopStream

停止播放。

• 参数: ptr: number。

---

3. 功能调节

setRate

设置视频播放倍速。

• 参数:
  • ptr: number: 播放器索引。
  • type: LwlPlayerType: 播放器类型。
  • rate: LwlVideoRate: 倍速值。

isMute

设置静音或开启声音。

• 参数:
  • mute: boolean: true 开启声音，false 静音。

setProgress / setStreamProgress

跳转到指定进度。

• 参数: time: number (单位：秒)。

---

4. 资源销毁

destroy

彻底销毁播放器实例、音频设备及渲染器。

• 注意: 为了避免下次初始化失败，必须在组件销毁时调用。
• 参数:
  • ptr: number: 播放器索引。
  • type: LwlPlayerType: 播放器类型。

---

代码示例

import { LwlPlayer, LwlPlayerType } from '../api/LwlPlayer';

const playerInstance = new LwlPlayer();
let playerPtr = playerInstance.createPlayer(LwlPlayerType.HTTP);

if (playerPtr >= 0) {
  playerInstance.play(playerPtr, "[https://example.com/video.mp4](https://example.com/video.mp4)");
}