Namespace Setup

The Setup module contains the interfaces and methods needed to install Ruffle onto a page, and create a Player.PlayerElement with the latest version of Ruffle available.

This is primarily relevant to users of ruffle-core as a npm module, as the "selfhosted" version of Ruffle preinstalls itself, and without type checking the interfaces here are of limited use.

For users of ruffle-core as a npm module, you are encouraged to call installRuffle once during page load to make the ruffle-core library register itself as a version of Ruffle on the page.

Multiple sources of Ruffle may exist - for example, the Ruffle browser extension also installs itself on page load. For this reason, you are required to call window.RufflePlayer.newest() (for example) to grab the latest SourceAPI, from which you can create a Player.PlayerElement via SourceAPI.createPlayer.

Classes

PublicAPI

Interfaces

PublicAPILike
SourceAPI
InstallationOptions

Functions

installRuffle