Optional
abrThe player's ABR configuration.
- Available since v3.1.0.
- Used for DASH and LL-HLS streams.
Optional
adsThe ads configuration for the player.
Optional
allowWhether mixed HTTP/HTTPS content is allowed.
- Available since 2.22.0.
- By default, the player assumes that it cannot load HTTP URLs when inside a HTTPS page because of mixed content restrictions. Therefore, the player will automatically convert HTTP URLs to HTTPS before loading them.
- When this option is set to true, the player may assume that mixed content is allowed on the current platform, and will not automatically convert HTTP URLs to HTTPS.
false
Optional
allowWhether the native video element's fullscreen should be used whenever THEOplayer's fullscreen is unsupported.
- Available since 2.21.0.
- It should be considered for older Android devices and iOS.
- It is limited to the platform's controls, custom UI and interactions are not possible.
- Together with the Google IMA integration, media preloading is unavailable on iOS devices.
- Together with the Google IMA integration, the current time is set to the live point when returning to the content after an ad.
false
Optional
analyticsList of analytics configurations for the player.
Multiple integrations can be enabled at once.
Optional
castThe cast configuration for the player.
Optional
fluiduse ui.fluid
Optional
heightuse ui.height
Optional
hlsWhether date ranges will be parsed from HLS manifests.
Available since 2.61.
false
Optional
isWhether THEOplayer will be used in an iframe.
false
Optional
libraryThe directory in which the THEOplayer library worker files are located. These worker files are theoplayer.d.js, theoplayer.e.js, theoplayer.p.js.
- This parameter is required when using a HLS source and has no default.
`'/lib/theoplayer/'`
Optional
licenseThe license for the player
Optional
licenseThe url to fetch the license for the player
Optional
liveThe offset in seconds used to determine the live point. This live point is the end of the manifest minus the provided offset.
- Available since v2.35.0.
Three times the target duration of a segment, as specified by the manifest.
Optional
mutedThe muted autoplay policy.
- The muted autoplay policy is impacted by this property and SourceConfiguration.mutedAutoplay.
'none'
.
Optional
persistWhether volume preferences will be persisted across player sessions.
Available since 2.27.0.
false
Optional
pipThe picture-in-picture configuration.
Optional
retainWhether playbackRate
is retained across sources. When false
, playbackRate
will be reset to 1 on each source change.
Defaults to false
.
Optional
uiThe user interface configuration.
Optional
verizonThe Verizon Media configuration for the player.
Optional
vrThe vr configuration for the player.
Optional
widthuse ui.width
Generated using TypeDoc
Describes the UI related configuration of the player.