- This guide refers only to KDP version 2.5 and 2.6.
- For first time integration, please read this Playback Guide first.
Introduction
The KDP provides an API to its wrapper (JavaScript in most implementations) that enables calling to public KDP methods and registering to events triggered by the KDP that control KDP behavior and actions (implemented using the ExternalInterface).
While the ExternalInterface API is discussed in the KDP APIs - about JavaScript integration guide, this guide will describe the benefits of using flashVars to control and modify the KDP behavior.
KDP initialization, identifying the Ready state
There are 2 events the KDP uses to indicate that initialization has finished and it is ready to be used (Ready State).
- readyF - The KDP was fully initialized and loaded with a valid entry/url and the media was successfully loaded.
- emptyF - The KDP was fully initialized, but did not load any media (like in gallery mode where the player is loaded with no content, and waits for user interaction to load the media).
For more in-depth javaScript integration and KDP initialization states description, please refer to the KDP APIs - about JavaScript integration guide.
KDP flashVars
The following list describes the various flashVars exposed by the KDP and its default package modules.
| Name | Type | Description | Comments |
|---|---|---|---|
| widget | String | An ID representing the player instance to load from the Kaltura server | |
| ks | String | The kaltura session key | If specified overrides the default ks generated from the widget ID |
| uid | String | The user ID to use | This should be a unique ID to identify the users in your environment |
| pid | int | The Partner ID created on registration or installation | |
| uiConfId | String | An ID representing a player instance UI (layout/design/configuration) to load | |
| autoPlay | Boolean | If true, playback will start automatically after metadata is loaded | |
| host | String | The URL of the Kaltura Server that the KDP should work with | Always pass the base URL without leading protocol (e.g. www.kaltura.com) |
| kdpUrl | String | The URL of the KDP swf to load | Used by the widget wrapper |
| debugMode | Boolean | If true, when loading a mix, all plugins (overlays,transitions,effects) will be loaded from a local folder instead of the server | Don't turn this to true unless specifically needed for debugging purposes |
| finishF | String | Name of the ExternalInterface function handler that will be called when the KDP finishes playback of current entry | |
| localUiFunc | String/XML(Valid uiConf) | This is used to override the uiConf received from the widget.get service | Use for local debugging purposes only |
| mute | Boolean | Start the player muted | Also sets the volume bar to 0 |
| fullscreenFaultMessage | String | A message that will appear in alert when the fullscreen is not allowed | |
| tooltipShowDelay | Number | In milisec | |
| kdp_loadingMessageText | String | The message that will be shown when the KDP loads and initializes | |
| k_backgroundColor | String | The background color of the loading screen when the KDP loads and initializes | 0xAAAAAA format (Hex 16bit color value) |
KDP - Adap.tv module flashVars
| Name | Type | Description | Comments |
|---|---|---|---|
| k_adaptv_zone | String | The zone defines the configuration of ads that will be loaded (to be configured on Adap.tv site) | |
| k_adaptv_key | String | The partner key assigned by Adap.tv | |
| k_adaptv_debug | Boolean | Turn on/off the Adap.tv debug mode | |
| k_adaptv_timeout | Number | Timeout for failure test and unhooking of the Adap.tv module | In seconds |
KDP - Gigya module flashVars
| Name | Type | Description | Comments |
|---|---|---|---|
| k_gigya_partner_key | String | A unique Gigya partner (for statistics) | If not set - uses Kaltura |
| k_share_email_subject | String | The subject for the emails that will be sent from Gigya | |
| k_share_email_body | String | The body text of the emails that will be sent from Gigya | Due to has special characters - must be url-encoded/td> |
| k_share_email_link | String | Link that will be on the landing page of the email sent by Gigya if provided | |
| referer | String | For the bookmarks, the landing page |
KDP - credits module flashVars
| Name | Type | Description | Comments |
|---|---|---|---|
| k_credits_title | String | Title of credits window |
KDP - report (moderation) module flashVars
| Name | Type | Description | Comments |
|---|---|---|---|
| k_report_form_title | String | Title of report window | |
| k_report_form_message | String | Description of reporting window | |
| k_report_cancel_label | String | Label of cancel button | |
| k_report_submit_label | String | Label of submit button | |
| k_success_report_message | String | Text apears in case of successful report sending | |
| k_failed_report_message | String | Text apears in case of failed sending | |
| k_message_timeout | int | The time to wait until the window closes itself (after presenting the message) | in seconds |
KDP - watermark component flashVars
| Name | Type | Description | Comments |
|---|---|---|---|
| k_watermark_path | String | The URL where the watermark image is located | |
| k_watermark_position | String | ||
| k_watermark_click_path | String | on watermark click URL |
For Playlist related flashVars, please refer to the "Player with playlist module (and playlist API)" guide
Under the "Playlist Parameters - flashVars" section.
