The nexxPLAY SDK makes heavy Use of various Events. In order to react to them, the Page must add Listeners to those Event Types, it is interested in.
This is the most used Listeners and receives all Events, that are exposed by a nexxPLAY Player Instance.
The given Function will then be called for every Player related Event of every Player with a lot of Metadata. The Function will get an Object, that can easily be filtered by
object.typeto handle only the Events, the Page is interested in.
Please notice, that this Function will receive ALL Events of ALL Players. If that is not desired, dont use a global Listener, add a Player-specific Listener with the
Here is the current List of all emitted Events (that are related to Media Playback):
a new Player Instance has been added
the Player inited (or re-used) a Session
the Media Item Metadata has been loaded, parsed and verified
the Player is ready to start Playback
the Player is starting Playback (Content or Ad)
the Player is starting Playback of Content
the User clicked on the Player the first Time
the Player swaps to a new Media Item, that is not Part of the current List
the Player swaps to a new Media Item in the current List
the Player used virtual Prev/Next Controls, that have been activated (or the Playback has been finished and forcePrevNext is active OR ErrorExit has been disabled and the Player needs a new Media Item). This Event must be answered with a Call to one of the swapMedia Calls.
the Player opens the Overlay UI
the Player closes the Overlay UI
the Player enters Fullscreen
the Player exists Fullscreen
the Player enters PiP
the Player exits PiP
the Player enters PopOut Mode
the Player exits PopOut Mode
the Player enters a Remote Display (AirPlay, Chromecast)
the Player exists a Remote Display (AirPlay, Chromecast)
the Player changes Playback Speed
the Media Item is playing
the Playback starts again
the Media Item is pausing
every Second of Playback
every 15 Seconds of Playback
the Media Item has reached 25% of its Duration
the Media Item has reached 50% of its Duration
the Media Item has reached 75% of its Duration
the Media Item has reached 95% of its Duration
the Media Item has been played completely
there is no new Media Item in the Playback List
the Player is muted
the Player unmutes
the Player was muted due to muted AutoPlay, but is now allowed to use Sound
a HotSpot is shown
a HotSpot is removed
the Player is calling for Ads
an Ad starts
an Ad ends
ad Ad Error occured
an Ad has been clicked
a paused Ad is resuming
the Player found Ad Companions, that can be integrated
a Bumper has been clicked
a fatal Error has occured and the Player cannot continues
the Player is more/less visible than before
the Player is stopping, as the Media is a PayPreview Item, which
reached its free Duration
the Player was in PresentationMode and the User selected a Media Item
for Playback in a Detail View
the Download of an Attachment, Source File or localMedia Process has started
returns Information about a started Downloads Progress
a Download has been finished successfully
a Download has been finished with an Error
will be emitted, if the SDK received an App-related Command via MediaSession (only android/androidTV SDK)
Please notice, that on iOS, the Events (Notification) have a different Name, that is built by the following Rule: "nexxPlay" + EventName.camelCase() + "Notification". So for example, a "pause" Notification will become a "nexxPlayPauseNotification", and a "changeplaypos" Notification will become a "nexxPlayChangePlayPosNotification"
Every Event consists of a Data Object besides the Event Name. Accessing the Details varies between Player Technologies, but in General, the Events provide at least basic Information of the Media, that it refers to (EVENT.mediaID, EVENT.globalID, EVENT.streamtype).
These Events are also supported by nexxPLAY for iOS and nexxPLAY for android.
Although the PlaystateListener is the most used Listener, the nexxPLAY SDK offers a variety of other Listener Functionalities, that can be used in advanced Contexts.
//get notified for Addon Events
the Player rendered an Addon
a Player Addon could not be finished and removes itself
//get notified for Widget Events
the Widget has been Clicked
the Widget could not load the Feed
//get notified for LifeCycle Events like "freeze"
//get notified for Network Events like "online, offline"
//get notified for Geo (and Geo Permission) Events