How do I use my embed code?¶
The following is the basic outline for the Akademia embed code:
This is the unique identifier for your Akademia player allowing control of the content available in the player and to record MI (management information) specific to that player.
This will be set when the code is supplied to you and will either be 'UK' or 'US' depending on your location.
this can be set to anything you wish providing you update the div id at the end of the above code to match it. You may wish to alter this if other objects on the page have already used player for it's ID.
This variable specifies which video should be played when the site loads - this should be included with your embed code when supplied.
This lets the player know if it should start the content once loaded, or wait for the viewer to click to view. It can be toggled between 'true' (will play once loaded) or 'false' (await user interaction).
Most browsers have changed the way that autoplayed media is handled, as such most content will start playing but the sound will be muted if autoplayed.
The skipTo property allows the content to begin at a specific point within the video. The value of skipTo defines the amount of seconds that is to be skipped. For example, skipTo: 120; would start the video 2 minutes in. This property can be overridden in the URL with
?skipTo=30 meaning you can provide links that take the viewer to exact moments in the video you wanted to highlight.
Size - width, height (optional)¶
This allows you to override the player dimensions. By default our player will fill the container in which it is placed.
If you don't wish to change any of the optional settings (i.e. size, autoplay etc.) you can simple remove or comment out that line of code.
- First, you need to place the embed script that was supplied to you within the
<head></head>tag of your webpage.
- Then, you need to create a div with an
<body></body>tags at the location you would like this video to appear. The script will reference the div ID name. e.g
- Next you need to set the containerID in the script we placed in the
<head>tag to the same as the div id. For example, we set
<div id="player"></div>- therefore we need to set
containerID = 'player';in your embed code.
The following is an example embed code with the videoID
####. Please note, if you do not follow the format shown below your media may not display properly.