W Player API Developer Guide
The W Player API is a JavaScript library (wplayer-api.1.0.0.js) that web content elements import to interact with the player at runtime through the $wp namespace. With it, web content can respond to life-cycle state events (ready, play, pageChanged, stop), read and change the properties of page elements, obtain device and local environment information, and consume external data received over UDP or from a Datalink Server. This guide is for web developers building interactive content for W Player in combination with Web Author.
What's in this section
- Tutorials — the starting point for developing with the W Player API, covering the API reference and key-function code examples.
- W Player API Reference — the
$wp,$wp.content,$wp.device,$wp.local, and$wp.utilityinterfaces. - Code examples:
- Changing the font color — change an element property on the current page with
setProperty(). - Receiving user data — use user data set in Web Author, delivered through the state event.
- Receiving UDP data — use data received via the UDP port in web content.
- Receiving Datalink table data — use table data sent from a Datalink Server.
- Downloading a sample and learning key actions — import a sample LFD file into Web Author to explore the key action functions.
- Changing the font color — change an element property on the current page with
- W Player API Reference — the
- FAQ — solutions to common issues such as
setProperty()changes not applying, key input focus, UDP and Datalink delivery failures, memory leaks in long-running content, and video playback restrictions.
tip
When authoring in Web Author, enable the relevant External Data listener properties (UDP Listener, Datalink Listener) for content that consumes external data — the corresponding APIs do not receive data without them.