Library Events - Storm JavaScript Library
The library events are related to the player behaviors (not the playback/stream).
| Event name | Additional data | Description | Can be fired more than once? |
|---|---|---|---|
| serverConnectionInitiate | serverURL: string | This event is fired when a library instance initiates a connection with a Storm Streaming Server/Cloud instance. | yes (once per connection) |
| serverConnect | serverURL: string | This event is triggered when a library instance successfully establishes a connection with a Storm Streaming Server/Cloud instance. | yes (once per connection) |
| serverDisconnect | serverURL: string | This event is called when a library instance is disconnected from the Storm Streaming Server/Cloud (after a connection was previously established), which may occur due to viewer networking issues or Storm Streaming Server/Cloud problems. | yes (once per connection) |
| serverConnectionError | serverURL: string | This event is triggered when a library instance fails to establish a connection with a Storm Streaming Server/Cloud instance, possibly due to networking issues. If there are additional servers on the configuration list and the "restartOnError" parameter is set to true, the library will attempt to connect to a different server instead. | yes (once per connection) |
| allConnectionsFailed | no | This event is associated with serverConnectionError. If a library instance is unable to connect to any of the servers provided in the configuration list, this event indicates that no further action can be taken. | no |
| playerCoreReady | no | This event is called when a library instance is prepared to accept API calls (using different methods). No playback-related methods should be invoked on the library before this event is registered. | no |
| compatibilityError | no | This event is triggered if a browser or device does not support any of the provided sources. Please note that the library will attempt all possible measures (switching between various modes) to ensure maximum compatibility with a given device. However, there may be instances where it is simply impossible to initiate a video. | yes |
| interactionRequired | no | Certain browsers and devices do not permit a video element to initiate on its own and necessitate direct user interaction, such as a mouse click or a touch gesture. This event signifies that such an engagement is required. | no |
| SSLError | no | If an SSL layer is required for specific sources and the browser does not provide it, this event will be triggered. | no |
| videoElementCreate | no | This event is triggered whenever a video element within a library instance is either created or recreated. | no |
| streamSourceAdd | ISourceItem | This event is activated whenever a new video source is added to the library (check addSourceItem in the API section). | yes |
| authorizationError | no | This event is fired when a library instance fails to authorize with a server application on Storm Streaming Server/Cloud instance (e.g. incorrect token). | yes |
| authorizationComplete | no | This event is called when a library instance successfully authorizes with a server application on Storm Streaming Server/Cloud instance. | yes |
| invalidLicense | no | Whenever a Storm Streaming Server/Cloud license expires, a library instance will fire this event. | no |
| streamConfigChange | StormStreamConfig | This event notifies that basic stream configuration has been updated. | yes |
Table 1. Library events table
On this page