Interface SourceAPI

Represents this particular version of Ruffle.

Multiple APIs can be instantiated from different sources; e.g. an "extension" version, versus a "local" version. This expresses to the Public API negotiator (see PublicAPI) what this particular version of Ruffle is and how to control it.

interface SourceAPI {
    version: string;
    polyfill(): void;
    pluginPolyfill(): void;
    createPlayer(): PlayerElement;
}

Index

Properties

Methods

polyfill pluginPolyfill createPlayer

Properties

version

version: string

The version of this particular API, as a string in a semver compatible format.

Methods

polyfill

polyfill(): void
Start up the polyfills.

Do not run polyfills for more than one Ruffle source at a time.

Returns void
- Defined in public/setup/source-api.ts:22

pluginPolyfill

pluginPolyfill(): void
Polyfill the plugin detection.

This needs to run before any plugin detection script does.

Returns void
- Defined in public/setup/source-api.ts:29

createPlayer

createPlayer(): PlayerElement
Create a Ruffle player element using this particular version of Ruffle.

Returns PlayerElement
The player element. This is a DOM element that may be inserted into the current page as you wish.
- Defined in public/setup/source-api.ts:37