JavaScript Api For HSEditor
Content
Overview
Requirements
Operation
Examples
LiveDemos
Embedding code in html Page
Overview:
The javascript api allows users to integrate the HSEditor right into their web pages without much coding work.
The basic loading functionality of the SDK can be written using this SDK
Requirements:
The end user needs to have Flash Player 9 or above to have this sdk properly working.
Operation:
Function:
The api supports only one function which will allow the user to load the HSEditor into the site
loadFivePEditor()
The function loads the HSEditor. The following are the arguements to be given to the function
- Video Url: The url of the video to be played by the HSPlayer.
- Annotation XML Url: The url of to the XML file which contains the annotations
- Annotations API path: The full path of the annotations handling api.
- Linker XML url : The url of the xml file containing the linking information between advertisements and annotations.
- Linker Api Path : The url of the linker handling api
- Advertisement Url: The url of the XML file which contains advertisement details
- Advt Api path: The full path of the advertisement api
- Enable FiveP : If value is given, the FiveP view will be set. Else it will not be shown on the player window
- Container Div: The name of the division where the swf needs to be loaded
- Player Div: The name of the division where the player needs to be loaded
- Navigation Url: The url of the page where the editor is to be embedded
- VideoType : The type of video being loaded into the player. If the video link is from youtube, specify as "youTube" or else leave as "other".
You will need the following javascript file to include the above function which is available here
Examples:
Live Demo:
You can see the live demo of the Editor using javascript function here..
Embedding code into html page:To embedd the code into a html page, simply copy paste the two import js files and add the function loadFivepEditor call to the javascript.