Custom Player Web SDK
This guide is for integrating the JavaScript-based MediaMelon Custom Player Web SDK
Step 1: Add the MediaMelon SDK Files
Add the following lines to the web page before player files are loaded.
Step 2: Register and Initialize the MediaMelon Player SDK
<customer_id> as your MediaMelon-assigned Customer ID. If you do not know your Customer ID contact MediaMelon at support@mediamelon.com
After the player instance has been created, create a new Plugin object, register, report player Info, and then initialize the plugin as shown below:
Note: Presentation Info API
This API should send all the available video and audio qualities and it requires two parameters:
presentationType
andpresentationArray
. VariablepresentationType
is a Enum which describes whether the data is of Video or Audio.Presentation Array Structure:
Enum values and their descriptions for the presentationType
variable are as below;
Step 3: API to Report Video Progress
This API should be triggered every 1 second. It requires an object as a parameter that contains information like playback position, current bitrate, and resolution in the form of width & height. The same API should be used for content progress reporting and Ad progress reporting.
Step 4: APIs that can be Triggered when Required
Report State:
Trigger this API when a state change occurs in the player. This API requires an Enum value as a parameter that represents the current state of the player or the action that happened to the player.
Enum values that can be sent as a parameter in the reportStateChange API as described below;
Report Ad Data:
Trigger this API to report the Ad data before an Ad break. This API requires a adTimelineArray
parameter that should contain all the Ad details of the upcoming Ad break.
If the upcoming Ad break contains 4 Ads then the adTimelineArray should contain all 4 ad details.
Enum values and descriptions for ADPOSITION are mentioned below;
Report Error:
Trigger this API when an error occurs in the player, content, Ad, or application. This API requires three parameters that are error message, error code, and error type.
Enum values and their descriptions for the error type variable are as below;
Report Track:
Trigger this API when a track change occurs in Audio, Video, or Subsitle tracks. This API requires two parameters: track type and current track.
Also, trigger this API when the video starts playing to report initial Audio, Video, and Subtitle tracks.
Enum values and their descriptions for the track type variable are as below;
Report Volume:
Trigger this API when a volume change occurs in the player. Send the volume value in percentage as shown below;
Last updated