Interface: Options
Interface representing player options.
Properties
aspectRatio
aspectRatio:
number
Aspect ratio of the player
Defined in
modules/options/options.dto.ts:65 (opens in a new tab)
autoPlay
autoPlay:
boolean
Whether to autoplay the media
Defined in
modules/options/options.dto.ts:77 (opens in a new tab)
bridgeAdapter?
optionalbridgeAdapter:Constructor<IPlatformBridgeAdapter>
Constructor for the platform bridge adapter (optional)
Defined in
modules/options/options.dto.ts:92 (opens in a new tab)
closedCaptions
closedCaptions:
string|string[]
Closed captions source or sources
Defined in
modules/options/options.dto.ts:95 (opens in a new tab)
controls
controls:
boolean
Whether to show controls
Defined in
modules/options/options.dto.ts:71 (opens in a new tab)
crossOrigin
crossOrigin:
string
CORS setting for the media
Defined in
modules/options/options.dto.ts:47 (opens in a new tab)
debug
debug:
boolean
Whether debug mode is enabled
Defined in
modules/options/options.dto.ts:62 (opens in a new tab)
keyboardNavigation
keyboardNavigation:
string
Keyboard navigation settings
Defined in
modules/options/options.dto.ts:68 (opens in a new tab)
language
language:
SupportedLanguage
Language setting for the player
Defined in
modules/options/options.dto.ts:59 (opens in a new tab)
loop
loop:
boolean
Whether the media should loop
Defined in
modules/options/options.dto.ts:44 (opens in a new tab)
muted
muted:
boolean
Whether the media is muted
Defined in
modules/options/options.dto.ts:41 (opens in a new tab)
nativeControls
nativeControls:
boolean
Whether to use native controls
Defined in
modules/options/options.dto.ts:74 (opens in a new tab)
playbackAdapter?
optionalplaybackAdapter:Constructor<Playback<any>>
Constructor for the playback adapter (optional)
Defined in
modules/options/options.dto.ts:89 (opens in a new tab)
playsInline
playsInline:
boolean
Whether the media should play inline on mobile devices
Defined in
modules/options/options.dto.ts:50 (opens in a new tab)
plugins
plugins:
PluginOptions
Plugin options
Defined in
modules/options/options.dto.ts:86 (opens in a new tab)
poster?
optionalposter:string
URL of the poster image (optional)
Defined in
modules/options/options.dto.ts:38 (opens in a new tab)
preload
preload:
PreloadValue
Preload behavior for the media
Defined in
modules/options/options.dto.ts:56 (opens in a new tab)
showUI
showUI:
boolean
Whether to show the user interface
Defined in
modules/options/options.dto.ts:53 (opens in a new tab)
source
source:
string
Source URL of the media
Defined in
modules/options/options.dto.ts:32 (opens in a new tab)
startTime?
optionalstartTime:number
Start time of the media in seconds (optional)
Defined in
modules/options/options.dto.ts:83 (opens in a new tab)
thumbnails?
optionalthumbnails:string
URL of the thumbnails (optional)
Defined in
modules/options/options.dto.ts:35 (opens in a new tab)
volume
volume:
number
Volume level of the media