-
-
Notifications
You must be signed in to change notification settings - Fork 806
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b65cade
commit 5ac397f
Showing
7 changed files
with
46 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,7 @@ | ||
/** | ||
* This is the public API of the web version of Ruffle. | ||
* | ||
* Types should only be exported here if they are intended to be part of that public API, not internal. | ||
*/ | ||
|
||
export * as Setup from "./public/setup"; | ||
|
||
export * as Config from "./public/config"; | ||
|
||
export * as Player from "./public/player"; | ||
|
||
export * from "./build-info"; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,11 @@ | ||
/** | ||
* The Config module contains all the types that Ruffle uses for movie configs. | ||
* | ||
* The main interface of interest here is {@link BaseLoadOptions}, which you can apply to `window.RufflePlayer.config` | ||
* to set the default configuration of all players. | ||
* | ||
* @module | ||
*/ | ||
|
||
export * from "./default"; | ||
export * from "./load-options"; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,20 @@ | ||
/** | ||
* The Setup module contains the interfaces and methods needed to install Ruffle onto a page, | ||
* and create a {@link 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 {@link 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.latest()` (for example) to grab the latest {@link SourceAPI}, | ||
* from which you can create a {@link PlayerElement} via {@link SourceAPI.createPlayer}. | ||
* | ||
* @module | ||
*/ | ||
|
||
export * from "./public-api"; | ||
export * from "./source-api"; | ||
export * from "./install"; |