Skip to main content

Embed Parameters

Newer version available

You are seeing documentation of an older player version. Check the embed code for newer player v2. The new player has shorter load-times, more customisable and has a lot of new features. There are many more API methods & events also supported. See how to connect API to v2 player. And the full list of HTML5-like APIs and more APIs.

Static Public Summary

embedInfoType: Object

Properties

NameTypeAttributeDescription
playbackInfostringmedia information
otpstring
  • optional
API generated token
signaturestring
  • optional
cryptographically generated signature
containerHTML Elementvideo will be appendChild to this element
themestringuuid of theplayerio theme
ccLangstring
  • optional
Can be set to the language code (iso-3166 alpha2) that you want the captions to start with. For example, to start with the English subtitle, set ccLang to "en". Leave this undefined to start with no active captions.
themeDebugboolean
  • optional
  • default: false
use un-cached URLs for theme assets useful when editing themes
noCssResetboolean
  • optional
  • default: false
do not unset all styles inside vdoplayer. default behaviour is to unset styles to make the player compatible with any website CSS. If you are editing the player elements or styles, you might want to set this to true. This must to set to true if you want to apply external styles to elements inside the player
autoplayboolean
  • optional
  • default: false
start playing on load. Note that autoplay no longer works. Apple and Google have blocked this. More information here and here
startTimenumber
  • optional
playback should start from this point
loopboolean
  • optional
  • default: false
loop this video
techoverridestring[]
  • optional
  • default: []
override the technical preference order
pluginsPluginSpec[]
  • optional
  • default: []
plugins to be loaded
bufferingGoalnumber
  • optional
  • default: 300
The number of seconds of content that the player will attempt to buffer ahead of the playhead. This value must be greater than or equal to 5. The actual buffered also depend on segment size available. This value will be used as a minimum possible value
defaultEstimateKbpsnumber
  • optional
  • default: 100
Applies to HTML5 player only. This is the bitrate with which player will start. After start, it will get the network speed and adapt to the better fitting variant for that network. Keeping this low improves load times , keeping this higher means video will not start with low quality