Skip to main content
View as Markdown

Iframe Embed - Kaltura Player

Kaltura Player Iframe Embed​

Use the Kaltura iframe endpoint and pass parameters via query string. This form accepts entry_id, uiconf_id, optional ks, and most common initial config and playback flags.

<!-- Responsive container -->
<div style="position:relative;max-width:100%;aspect-ratio:16/9;">
  <iframe
    id="kaltura_player"
    title="Kaltura video"
    src="https://cdnapisec.kaltura.com/p/\{PARTNER_ID\}/embedPlaykitJs/partner_id/\{PARTNER_ID\}/uiconf_id/\{PLAYER_INSTANCE_ID\}?iframeembed=true&ks=\{KALTURA_SESSION\}&entry_id=\{ENTRY_ID\}&kalturaSeekFrom=\{CLIP_START_SECONDS\}&kalturaClipTo=\{CLIP_END_SECONDS\}&config[playback]={&quot;autoplay&quot;:true,&quot;mutedAutoPlay&quot;:true,&quot;muted&quot;:true}"
    allowfullscreen="" 
    allow="autoplay *; fullscreen *; encrypted-media *" 
    style="width: 100%; height: 100%; aspect-ratio: 16 / 9; min-width: 100%; background-color: black; border: 0px; border-radius: 0.5rem; overflow: hidden;" >
  </iframe>
</div>

iframe Params Replacement Tokens​

  • {PARTNER_ID} - is your Kaltura account ID.
  • {PLAYER_INSTANCE_ID} - is your Player Instance ID (uiConfId). Find it in the Kaltura Management Console (KMC) under Studio > TV Platform or Studio > Player — each player configuration has a numeric ID displayed in the list or detail view.
  • {KALTURA_SESSION} - is a valid Kaltura Session that can be used to access the video Kaltura Entry ID to be played in this session (if playback is anonymous and the entry id open to public, this param can be skipped).
  • {ENTRY_ID} - The ID of the video to be played.
  • {CLIP_START_SECONDS} - will clip the video from that particular start second. if skipped - video will begin from the start.
  • {CLIP_END_SECONDS} - will clip the video to that second. if skipped, the video will play to its full duration.
config[playback] params:​
  • autoplay - set to true to begin playback automatically or false to begin at paused state.
  • muted - set to true to begin playback muted (volume=0).
  • mutedAutoPlay - set to true to ensure autoplay always begin playback muted.

Other iframe Embed Notes​

  • To make the iframe responsive ensure a wrapping div is set and the iframe has a defined aspect-ratio.
  • Set a meaningful title for accessibility and SEO.
  • Ensure to include allow and allowfullscreen attributes for autoplay/PiP/encrypted-playback/fullscreen.

Note: we're using cdnapisec.kaltura.com in this example, but your account region/deployment may differ. Make sure to use the correct base URL of your Kaltura account.