Getting Started

Search…
Getting Started
If you are looking to integrate Annoto as a widget without influencing website layout, as an overlay on top your existing video player, you are in the right place :)
At the moment we support the following players:
Wistia
YouTube
Vimeo
Kaltura
JwPlayer
VideoJS
FlowPlayer
H5P
OpenEdx
HTML5
Custom Player
Setup
Simply add the following script:
1
<script src="https://app.annoto.net/annoto-bootstrap.js"></script>
Copied!
And bootstrap Annoto with the desired Application configuration:
1
<script>
2
  // Application configuration
3
  var config = {
4
​
5
    /* Below are the only Mandatory configuration options */
6
    clientId: '', /* set to your client id after registration. */
7
    widgets: [
8
      {
9
        player: {
10
          type:    'youtube', /* type of the player */
11
          element: 'player-element' /* DOM element or id of the player */
12
        }
13
      }
14
    ],
15
    demoMode: true, /* set to false when you have your clientId */
16
​
17
  };
18
​
19
  window.Annoto.boot(config);
20
</script>
Copied!
If you are using a javascript module loader such as RequireJS. Annoto exposes a standard UMD. For example for requireJS:
1
requirejs(["https://app.annoto.net/annoto-bootstrap.js"], function(Annoto) {
2
    //This function is called when annoto-bootstrap.js is loaded.
3
    Annoto.boot(config);
4
});
Copied!
Configuration
Annoto application providers flexibility in how it integrates in the website. For full configuration options, please refer to the Config Reference. Annoto API Typescript interfaces is available via the @annoto/widget-api package.
Using the API
Annoto application exposes an API. To get access to the API use the "ready" event.
For example to load new application configuration attaching the widget to new dynamically loaded video, or just switching to another video on the page:
Typescript
Javascript
1
  import { Annoto, AnnotoApi, AnnotoConfig } from '@annoto/widget-api';
2
  
3
  interface Global extends Window {
4
    Annoto: Annoto;
5
  }
6
  const global = window as Global;
7
  
8
  const config: AnnotoConfig = {
9
    /* ... */
10
  };
11
​
12
  let annotoAPI: AnnotoApi;
13
  global.Annoto.on('ready', (api: AnnotoApi) => {
14
    annotoAPI = api;
15
  });
16
  global.Annoto.boot(config);
17
​
18
  function yourTrigger(newConfiguration) {
19
    annotoAPI.load(newConfiguration).then(() => {
20
        console.log('Loaded new Configuration!');
21
    }).catch((err) => {
22
      console.error(err);
23
    });
24
  }
Copied!
1
  // Application configuration
2
  var config = {
3
    /* ... */
4
  };
5
  
6
  var annotoAPI;
7
  window.Annoto.on('ready', function (api: AnnotoApi) {
8
    annotoAPI = api;
9
  });
10
  window.Annoto.boot(config);
11
​
12
  function yourTrigger(newAnnotoApplicationConfiguration) {
13
    annotoAPI.load(newAnnotoApplicationConfiguration, function(err) {
14
        if (err) {
15
            // error while loading the new configuration
16
          return;
17
        }
18
        console.log('Loaded new Configuration!');
19
    });
20
  }
Copied!
For full documentation, please refer to the AnnotoApi Reference.
Annoto Timeline
Annoto Timeline allows users to spot points of interest. The timeline can be embedded in the player or it can be positioned below the player. Lets explore the timeline configuration options:
By default, the timeline will be positioned under the player:
If overlayVideo is true, the timeline will be positioned inside the controls of the player:
1
timeline: {
2
    overlayVideo: true
3
}
Copied!
Browser Compatibility
Annoto is compatible with all major evergreen browsers (Edge, Chrome, Mozilla, Safari). IE11 is supported as well.
Chrome usually gives best user experience.
​
Introduction
Next - Widget
Advanced Workflows
Last modified 4mo ago
Export as PDF
Copy link
Contents
Browser Compatibility