Properties and Interface Description

Player Properties

Pass all parameters as an object to the player. The configurable properties include:

Static Properties

Accessible via PlvAudioPlayer[key].

Instance Properties

Each player instance has the following properties:

Player API

APIs must be called after the player initialization is complete, for example:

plvAudioPlayer.on('ready', function() {
  console.info('播放器初始化完毕');
  plvAudioPlayer.seek(100); // seek到第100秒
});
```

The player API list is as follows:

| Name               | Parameter Type  | Description                                                  |
| ------------------ | --------------- | ------------------------------------------------------------ |
| play               | /               | Start playback.                                              |
| pause              | /               | Pause playback.                                              |
| (async) changeVid  | (String\|Object)| Switch media files. Can pass a `vid` string, or an object containing `playsafe`, `sign`, `ts`, and `vid` properties. |
| seek               | Number          | Jump to a specified position for playback. Parameter unit: seconds. |
| setLoop            | Boolean         | Whether to loop playback.                                    |
| setSpeed           | Number          | Set playback speed. Parameter range: (0, 16]. Invalid values will be set to 1. |
| setVolume          | Number          | Set volume. Parameter range: [0, 1]. Invalid values will be set to 1. |
| stop               | /               | Stop playback.                                               |
| (async) updateParam| /               | Update player parameters. Audio will stop playing and reload. Supports the player property parameters listed in this document. |
| destroy            | /               | Destroy the current player instance.                         |

## Player Events

The player provides some common event callbacks. Usage example:

```js
plvAudioPlayer.on('ready', function() {
  console.info('ready');
});
```

The event list is as follows:

| Name        | Description                                                  |
| ----------- | ------------------------------------------------------------ |
| ready       | Fired when the player initialization is complete. Player methods can only be called after this event. The callback returns a `data` object containing audio information. Audio-related details can be obtained via `data.audioInfo`. |
| loadstart   | Fired when the media starts loading.                         |
| play        | Fired when media playback starts.                            |
| playing     | Fired during playback, may trigger multiple times.           |
| pause       | Fired when playback is paused.                               |
| seeking     | Fired when a seek operation starts.                          |
| seeked      | Fired when a seek operation completes.                       |
| ratechange  | Fired when the playback rate changes.                        |
| timeupdate  | Fired when the current playback time (`currentTime` property) changes. |
| waiting     | Fired when a pending operation (e.g., play) is delayed due to waiting for another operation (e.g., seek or load). |
| ended       | Fired when playback ends.                                    |
| stop        | Fired after the `stop` method completes.                     |
| hlsError    | Fired when an error occurs while playing an HLS file.        |
| serverError | Fired when a playback error occurs. The callback returns a `data` object containing error information. The error code can be obtained via `data.code`. |