WIREWAX iframe API is designed for iframe embed solution.
Breaking Change (Oct 26, 2020): WIREWAX has updated iframe API CDN for Player5, please reference to our CDN for an up-to-date version as below.
If you are using Player5(embed link is
embedder.wirewax.com), you could safely switch to the new CDN without change any code.
If you are using Player4(embed link is
embed.wirewax.com ), please keep using the old CDN to avoid breaking changes.
No more new features will be added for Player4 iframe API.
The user's browser must support the HTML 5
postMessage feature. Most browsers support this feature, we recommend using the latest Chrome browser for development and test.
WIREWAX iframe API is designed and developed to pair with WIREWAX player iframe embed solution. Currently it doesn't support WIREWAX third party player plugins or third party player JS embed.
- Insert plugin script to the HTML head of your site.
- Set an
idto your WIREWAX iframe element. The default is
wirewax-player, you can change this by setting the
WIREWAX currently has two versions of player being used by clients:
- Player 4 (Old Player): embed src URL starts with
- Player 5 (New Player): embed src URL starts with
Player 5 script is backwards compatible with Player 4 iframe API.
triggerEvent functions allow you to control WIREWAX video playback and interactions.
eventName: string, a full list of eventName interfaces can be found in API reference: Trigger events.
data(optional): varies based on the event
WIREWAX Player will only start accepting events once it is ready. You can check this by listening for the "PLAYER_READY" event.
addEventListener functions allow you to listen for the WIREWAX player states change and interaction events, and add event handlers.
eventName: string, a list of eventNames can be found in API reference: Listener events.
To enable gyro for 360 videos you can call
window.wirewax.enableGyro() which will save you the work to listen to all the device events and call our triggers.
This method is used for Player 4 customization projects only, and deprecated in Player 5.