Fork me on GitHub

Developer Resources

Kaltura Players Framework Developer Resources. Learn how to build plugins, customize the player, use the API, test and tweak performance. Check us out on GitHub and join the project.

Getting Started » Report an Issue » Questions & Feedback » Readme »

Kaltura HTML5 Library Docs & Guides

Kaltura Knowledge Center»

Getting Started

To get started with player v2 please read the skin and component guide.

Setup and Embed

  • The Kaltura Management Console ( KMC ) provides four embedding options:
    • AutoEmbed: Single line of script! Great for quickly getting a player on the page.
    • Dynamic Embed: Great for code integration in web apps. Responsive web-design friendly. Cleaner configuration.
    • Thumbnail embed: Fast loading, great for pages with lots of players. Best used in video-blogs.
    • Iframe: Single line of HTML! Great for when JS is not allowed. Best option for Share/Embed players.

Overview

  • Complete API and Player integration overview doc ( PDF )
  • Unified Flash and HTML5 API
  • Intelligent per-platform player selection
  • Open Source and Widely Used.

Kaltura Player Toolkit ( v2 )

  • Kaltura Player Toolkit; HTML5 first player across platforms
    • JSON config
    • CSS based skins with state classes
    • Simple plugins with extended base component classes
    • Native iOS and Android components

Legacy: Kaltura Flash Player� aka KDP3

  • Kaltura Dynamic Player is a Flash based media player
  • An XML configuration file defines its layout, behavior and visual elements/skin. The XML is dubbed uiConf
  • Flash KDP is based Open Source Standards:
    • Adobe OSMF
    • PureMVC
    • Yahoo! Astra
    • Fl Components
    • Kaltura ActionScript 3 Client Library

kWidget API

  • kWidget.embed – Dynamic Embed
  • kWidget.thumbEmbed – Thumbnail Embed
  • kWidget.getKalturaThumbUrl – Get thumbnail URL
  • kWidget.addReadyCallback – Add event listener, listen to when players on the page are ready for JS binding
  • kWidget.destory – Removes the player from the DOM

Player JavaScript API - Basic Example

Log Player Id to Console, once Player is Ready to Play
  1. kWidget.embed({
  2. 'targetId': 'myVideoTarget',
  3. 'wid': '_243342',
  4. 'uiconf_id' : '12905712',
  5. 'entry_id' : '0_uka1msg4',
  6. 'readyCallback': function( playerId ){
  7. console.log( "Hello World, playerId: " + playerId );
  8. }
  9. });

HTML5Video.org Blog

Learn more about html5video on html5video.org

HTML5Video.org Blog»

Player Framework Performance Tools

Compare performance of the kaltura html5 library with other popular html5 libraries

Performance page »

Kaltura and Open Source

Learn more about kaltura and open source

Kaltura.org »

Automated Testing

loading ...

View automated tests»

Recent Commits

Commits on github »