HbbTV Video-On-Demand Player

HbbTV Video-On-Demand Player

Introduction to VOD PLAYER FOR HBBTV

1
2
3
4
var vod = new VOD (serverUrl, organizationId, organizationSecret, containerId);
vod.initialize (function () {
     vod.playWithAds (assetId, vastUrl, onPlayStateChange, onControlStateChange);
});

Name 
Type 
Optional 
Info 
serverUrl 
string 
 
 
organizationId
number 
 
 
organizationSecret 
string 
 
 
containerId 
string 
yes 
 
 
 
 
 
 
 
 
 
 
 
 
 
assetId
number/string
 
 
vastUrl 
string 
 
 
onPlayStateChange 
function 
yes 
gets current plays state as parameter 
onControlStateChange 
function 
yes 
gets current control state as parameter

FUNCTIONS

initialize (callback)

  • creates container if one does not already exist with the containerId specified in constructor
  • initializes keyset and registers key event listener
  • callback is called whenever the dependencies are loaded

show ()

  • if player container is hidden this will make it visible

hide ()

  • hides the player container

play (asset, vast, onplaystatechange, onplaybackcontrolchange)

  • parameters
    • asset
      • type
        • string
        •  number
      • if type of asset is number, player is going make request to suite to get video url
      • if type is string and vast is false, player will start playing video
      • if type is string and vast is true, player will parse vast data and it will play advertisement
    • vast
      • type
        • bool
    • onplaystatechange
      • type
        • function
      • this function will be called with player state as parameter whenever player state changes
    • onplaybackcontrolchange
      • type
        • function
      • this function will be called with control state as parameter when ever control state changes
  • starts playing asset

playWithAds (asset, vast, onplaystatechange, onplaybackcontrolchange)

  • parameters
    • asset
      • type
        • string, number
    • vast
      • type
        • string
    • onplaystatechange
      • type
        • function
    • onplaybackcontrolchange
      • type
        • function
  • stores value of asset and will pass the vast and function callbacks to play function, after playing the advertisement player will start playing the asset

disableControls (disable)

  • parameters
    • disable
      • type
        • bool
  • if disable is true, key events are ignored and control bar is hidden all the time



    • Related Articles

    • Video-On-Demand Analytics

      Introduction In contrast to the analytics of live streams and events, real-time is not as important in the analytics of streaming or on-demand videos. It can be used in OVP, OTT and Event uses cases, but also with HbbTV and Smart TV environments when ...

    • On-Demand Video Transcoding and Video Qualities from SD to 4K

      Introduction Icareus Suite can transcode all on-demand content using its integrated transcoding system. Alternatively it is possible for you to pre-transcode all your on-demand files and add them to a Icareus Suite Asset manually. This document ...

    • Managing the In-Stream Video Ads

      Introduction to In-Stream Video Ads In-stream video ads are: Pre-roll Mid-roll Post-roll Those can be configured to be used with both live and on-demand content on different Icareus Suite video players: Live video player VOD (video-on-demand) player ...

    • Event & Webinar Player

      Introduction The theme of the event or webinar page is configured under Players. Webinar players provide versatile, easy way to customize the look & feel of the video event. Options to use Custom Event & Webinar UX There are four options: Event & ...

    • Event & Webinar Player

      Themes for an event or webinar page are defined under Events -> Event themes. Themes provide a versatile and easy way to customise the look and feel of your event. Options for customizing an event There are four options: Event and webinar player as a ...