JavaScript Library

From Ace Stream Wiki
Revision as of 08:30, 21 November 2018 by Anton (talk | contribs) (Guide)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Ace Stream JavaScript Library provides tools to embed video player on web-pages with minimum effort.


First, add javascript library on the page (inside the <head> tag):

<script src="//"></script>              

Then you can create the player with this code:

 var player = null;
 AceStream.createPlayer("#player", {
     onLoad: function (playerObj) {
         player = playerObj;
     onError: function(err) {
         console.log("init: error: " + err);

Player is created in the HTML-container with id "player".

Upon successful player creation onLoad callback is called and player object is passed as parameter. You should save player object to some variable to be able to call player methods later, for example, to switch to another content. Currently such method are available:

  • loadContentId(contentId) - load by Content ID (unique identified in Ace Stream system);
  • loadTransportFileUrl(url) - load by transport file URL;
  • loadInfohash(infohash) - load by infohash;
  • loadMagnet(magnetUri) - load by magnet link;
  • loadDirectUrl(url) - load by direct content URL (this can be direct link to some video file, HLS stream or link supported by Ace Stream plugins: youtube, twitch etc).

You can create more than one player on the same web page. To do this you need to provide a separate HTML container for each player and call AceStream.createPlayer() method on each container. You can find example on the demo page.


Working demo is available here

Additional features

If the user has a browser extension Ace Script with the activated userscript Ace Cast, the following additional features will be available:

  • Automatically start Ace Stream application for content playback (there is no need to manually start the application if it isn't running)
  • Select any installed desktop player for playback
  • Playback content on remote devices over protocols Ace Cast, Google Cast, AirPlay and others
  • Add content to user's playlist, in his Ace Stream personal media server
  • Convenient ways to share content

In order to inform the user about these features, the corresponding information block is shown after clicking on "menu" or "play" button.

Attention! The need to use a browser extension and a userscript to make additional features available is temporary, until we implement a solution that allows direct and secure communication between javascript code and the Ace Stream application.


New JS library consists of reusable javascript modules which are bundled with browserify. Currently only the bundled version is distributed, but we plan to prepare documentation for these modules and publish it along with the source code on github.

Modules will implement such functionality like:

  • checking engine status and version and running it if necessary
  • encapsulate all avaialble Ace Stream HTTP API methods
  • provide reusable markup
  • etc

Legacy JS Library

The old version of JS Library is still available. You can find test page and links here.