Events

1. Overview

The ZWPlayer player provides an event callback mechanism that allows developers to listen to player status changes and user interaction behaviors.

2. onmediaevent

  • Type: function
  • Description: Media event callback function, used to listen to player media status changes
  • Callback Function Prototype: function onmediaevent(event)
  • Parameters:
    • event: Event object, containing event type and related data

2.1 Event Types (event.type)

Event Type Description
play Triggered when playback starts or resumes
playing Triggered when playing
pause Triggered when playback is paused
seeking Triggered when a seek operation starts
seeked Triggered when a seek operation completes
waiting Triggered when waiting for media data
ended Triggered when media playback ends
error Triggered when an error occurs

2.2 Usage Example

function onmediaevent(event) {
    switch (event.type) {
        case 'play':
            console.log('Playback started');
            break;
        case 'pause':
            console.log('Playback paused');
            break;
        case 'ended':
            console.log('Playback ended');
            break;
        case 'error':
            console.error('Playback error:');
            break;
    }
}

3. onready

  • Type: function
  • Description: Player initialization completion event callback
  • Callback Function Prototype: function onready()
  • Trigger Timing: Triggered when the player creation is complete and ready for use

3.1 Usage Example

function onready() {
    console.log('Player initialization complete');
    // You can start operating the player here
}

4. Complete Example

4.1 Example Code

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <script type="text/javascript" charset="utf-8" src="https://cdn.zwplayer.com/v3/zwplayer/zwplayer.js"></script>
</head>
<body>
<div id="mse" style="width: 800px; height: 450px;  margin: 0 auto;"></div>
<script type="text/javascript">
    var info = {
        playerElm: 'mse',
        url: 'https://d2zihajmogu5jn.cloudfront.net/elephantsdream/ed_hd.mp4',
        infoButton: true,
        optionButton: true,
        snapshotButton: true,
        controlbar: true,
        autoplay: true,
        onready: function () {
            console.log("Player onready");
        },
        onmediaevent: function (event) {
            console.log(event)
            switch (event.type) {
                case 'play':
                    console.log('Playback started');
                    break;
                case 'playing':
                    console.log('Playing');
                    break;
                case 'pause':
                    console.log('Playback paused');
                    break;
                case 'seeking':
                    console.log('Seeking');
                    break;
                case 'seeked':
                    console.log('Seek ended');
                    break;
                case 'waiting':
                    console.log('Waiting');
                    break;
                case 'ended':
                    console.log('Playback ended');
                    break;
                case 'error':
                    console.error('Playback error:');
                    break;
            }

        },
    };
    new ZWPlayer(info);
</script>
</body>
</html>

4.2 Notes

  1. The onmediaevent callback function must be a valid JavaScript function
  2. The event object in the event callback function contains detailed event information; it is recommended to use event.type for type checking
  3. Other methods and properties of the player can be safely called after the onready event is triggered