Event Reference for Cincopa

Cincopa provides various events that enable developers to customize the player experience and respond to user interactions or system states. Below is a comprehensive list of events categorized for clarity.

Player and Video Playback Events

Event	Description
`video.play`	Triggered when the video begins playing.
`video.pause`	Fired when the video is paused.
`video.seeked`	Fired when the user seeks to a new position.
`video.timeupdate`	Triggered periodically to provide playback progress updates.
`video.change`	Fired when a new video is loaded or selected.
`video.load`	Triggered when a video is loaded into the player.
`video.unload`	Fired when a video is unloaded.
`video.ended`	Triggered when the video playback ends.
`video.error`	Fired when an error occurs during video playback.
`video.fullscreenenter`	Triggered when the player enters fullscreen.
`video.fullscreenexit`	Fired when the player exits fullscreen.
`player.failed`	Triggered when the player fails to load or initialize.

Playlist and Chapter Events

Event	Description
`playlist.next`	Triggered when the next item in the playlist is selected.
`playlist.prev`	Triggered when the previous item in the playlist is selected.
`chapter.click`	Triggered when a chapter is clicked by the user.
`chapter.hide`	Fired when a chapter is hidden.
`chapter.show`	Triggered when a chapter is shown.
`chapter.view`	Fired when a chapter is viewed.

API and Runtime Events

Event	Description
`api.ready`	Fired when the API is ready for interaction.
`runtime.on-args`	Triggered during runtime argument handling.
`runtime.after-on-args`	Fired after `on-args` events are executed.
`runtime.on-html-loaded`	Fired when HTML is loaded during runtime.
`runtime.on-load-html`	Triggered when HTML is loaded.
`runtime.on-media-json`	Fired when media JSON is loaded.
`runtime.on-password-shown`	Triggered when a password-protected video password is shown.
`runtime.on-thumbnail-shown`	Fired when a thumbnail is displayed.

Interaction and UI Events

Event	Description
`share.hide`	Triggered when the share menu is hidden.
`share.show`	Fired when the share menu is displayed.
`overlay.hide`	Triggered when an overlay is hidden.
`overlay.show`	Triggered when an overlay is displayed.
`annotation.hide`	Triggered when an annotation is hidden.
`annotation.show`	Triggered when an annotation is shown.
`annotation.skip`	Fired when an annotation is skipped.
`cta.hide`	Triggered when a CTA is hidden.
`cta.show`	Triggered when a CTA is displayed.
`cta.skip`	Fired when a CTA is skipped by the user.

Miscellaneous Events

Event	Description
`chromecast.detected`	Fired when a Chromecast device is detected.
`chromecast.error`	Triggered when an error occurs with Chromecast.
`chromecast.start`	Triggered when casting to Chromecast starts.
`chromecast.stop`	Fired when casting to Chromecast stops.
`emailgate.show`	Triggered when an email gate is shown.
`emailgate.skip`	Fired when an email gate is skipped by the user.
`emailgate.submit`	Triggered when an email gate is submitted.
`item.download`	Fired when an item is downloaded.
`live.m3u8parsed`	Triggered when an M3U8 file for live streaming is parsed.
`live.token`	Fired when a live token is obtained.
`live.watching-count`	Triggered to update the live stream viewer count.
`context_menu.init`	Triggered when the context menu is initialized.

Notes

Event Customization: These events allow developers to respond to specific actions or states within the player, enabling deep customization.

Example Usage:

cincopa.registeredFunctions = cincopa.registeredFunctions || [];
cincopa.registeredFunctions.push({
    func: function (eventName, data, gallery) {
        console.log("Event triggered:", eventName);
        console.log("Event data:", data);
    },
    filter: "video.play,video.pause"
});

Another way of attaching and listening to events:

cincopa.registerEvent(FUNCTION_NAME, EVENT_NAME, PRIORITY);
cincopa.registerEvent("videoEventsHandler", "video.*", 0);
function videoEventsHandler(eventName, data, gallery){
    console.log("Event triggered:", eventName);
    console.log("Event data:", data);
}