Collections documentation

Getting started

As well as embedding the player directly from the dashboard you can use our JS player plugin to display media on your site. The plugin also gives you greater control over the player and allows interaction with elements on the page. To use the player plugin you will need to add the script reference below to any pages of your site that require the player:

Uncompressed
<script src="http://static.kenseimedia.com/js/kenseicollection.js"></script>
Minified
<script src="http://static.kenseimedia.com/js/kenseicollection.min.js"></script>
Note: This version of the plugin (with no version number) will always be kept upto date and will contain the latest version of the js code. For specific versions see the release sections below.

Download

If you would like to host the collections plugin yourself instead of referencing the version from our CDN you can download it here: Uncompressed or Minified


Configuration

When you have included kenseicollection.js in your page, you have the kensei.createCollection() function available.  


A collection is created by calling kensei.createCollection() with the required configuration data.  


The configuration can be specified using a json object.  


Required Configuration Properties

  • apiKey: Your api key. You can retrieve this from the dashboard.
  • collectionId: The ID of the collection you wish to embed.
  • thumbnailsContainer: This is the ID of the element that will contain the video thumbnails.
  • playerContainer: This is the ID of the element that will contain the video player.


Example showing only required config properties.

kensei.createCollection({
	apiKey: "apikey",
	collectionId: "collectionId",
	thumbnailsContainer: "thumbnailsContainerDivId",
	playerContainer: "playerContainerDivId"
});
				

Optional Configuration Properties

  • apiVersion: Specify the api version. This can be useful for legacy applications targeting an older version of the api.
  • apiURL: The url of the kensei api you are using (without the version number). Such as http://test.api.kenseimedia.com.


Example showing all configuration properties.

kensei.createCollection({
	apiKey: "apikey",
	apiVersion: 1.0,
	collectionId: "collectionId",
	apiURL: "https://api.kenseimedia.com",
	thumbnailsContainer: "thumbnailsContainerDivId",
	playerContainer: "playerContainerDivId"
});
				

Demo

View a demo of the collections plugin in action here


Current Release

v1.8 - Uncompressed or Minified

  • Fixed the thing with the doodaa
  • Added the wotsit for the thingemy

Uncompressed
<script src="http://static.kenseimedia.com/js/kenseicollection-1.8.js"></script>
Minified
<script src="http://static.kenseimedia.com/js/kenseicollection-1.8.min.js"></script>

Past Releases

v1.7 - Uncompressed or Minified

Uncompressed
<script src="http://static.kenseimedia.com/js/kenseicollection-1.7.js"></script>
Minified
<script src="http://static.kenseimedia.com/js/kenseicollection-1.7.min.js"></script>

v1.6 - Uncompressed or Minified

Uncompressed
<script src="http://static.kenseimedia.com/js/kenseicollection-1.6.js"></script>
Minified
<script src="http://static.kenseimedia.com/js/kenseicollection-1.6.min.js"></script>