Class UIInstanceManager

Encapsulates functionality to manage a UI instance. Used by the UIManager to manage multiple UI instances.

Index

Constructors

Accessors

onComponentHide onComponentShow onComponentViewModeChanged onConfigured onControlsHide onControlsShow onPreviewControlsHide onRelease onSeek onSeekPreview onSeeked

Methods

getConfig getPlayer getSubtitleSettingsManager getUI

Constructors

constructor

new UIInstanceManager(player, ui, config, subtitleSettingsManager, spatialNavigation?): UIInstanceManager
Parameters
- player: PlayerAPI
- ui: UIContainer
- config: InternalUIConfig
- subtitleSettingsManager: SubtitleSettingsManager
- OptionalspatialNavigation: SpatialNavigation
Returns UIInstanceManager
- Defined in src/ts/uimanager.ts:637

Accessors

onComponentHide

get onComponentHide(): EventDispatcher<Component<ComponentConfig>, NoArgs>
Fires when a component is hiding.

Returns EventDispatcher<Component<ComponentConfig>, NoArgs>
- Defined in src/ts/uimanager.ts:705

onComponentShow

get onComponentShow(): EventDispatcher<Component<ComponentConfig>, NoArgs>
Fires when a component is showing.

Returns EventDispatcher<Component<ComponentConfig>, NoArgs>
- Defined in src/ts/uimanager.ts:697

onComponentViewModeChanged

get onComponentViewModeChanged(): EventDispatcher<Component<ComponentConfig>, ViewModeChangedEventArgs>
Returns EventDispatcher<Component<ComponentConfig>, ViewModeChangedEventArgs>
- Defined in src/ts/uimanager.ts:741

onConfigured

get onConfigured(): EventDispatcher<UIContainer, NoArgs>
Fires when the UI is fully configured and added to the DOM.

Returns EventDispatcher<UIContainer, NoArgs>
- Defined in src/ts/uimanager.ts:665

onControlsHide

get onControlsHide(): EventDispatcher<UIContainer, NoArgs>
Fires when the UI controls are hiding.

Returns EventDispatcher<UIContainer, NoArgs>
- Defined in src/ts/uimanager.ts:729

onControlsShow

get onControlsShow(): EventDispatcher<UIContainer, NoArgs>
Fires when the UI controls are showing.

Returns EventDispatcher<UIContainer, NoArgs>
- Defined in src/ts/uimanager.ts:713

onPreviewControlsHide

get onPreviewControlsHide(): EventDispatcher<UIContainer, CancelEventArgs>
Fires before the UI controls are hiding to check if they are allowed to hide.

Returns EventDispatcher<UIContainer, CancelEventArgs>
- Defined in src/ts/uimanager.ts:721

onRelease

get onRelease(): EventDispatcher<UIContainer, NoArgs>
Fires when the UI controls are released.

Returns EventDispatcher<UIContainer, NoArgs>
- Defined in src/ts/uimanager.ts:737

onSeek

get onSeek(): EventDispatcher<SeekBar, NoArgs>
Fires when a seek starts.

Returns EventDispatcher<SeekBar, NoArgs>
- Defined in src/ts/uimanager.ts:673

onSeekPreview

get onSeekPreview(): EventDispatcher<SeekBar, SeekPreviewArgs>
Fires when the seek timeline is scrubbed.

Returns EventDispatcher<SeekBar, SeekPreviewArgs>
- Defined in src/ts/uimanager.ts:681

onSeeked

get onSeeked(): EventDispatcher<SeekBar, NoArgs>
Fires when a seek is finished.

Returns EventDispatcher<SeekBar, NoArgs>
- Defined in src/ts/uimanager.ts:689

Methods

getConfig

getConfig(): InternalUIConfig
Returns InternalUIConfig
- Defined in src/ts/uimanager.ts:649

getPlayer

getPlayer(): PlayerAPI
Returns PlayerAPI
- Defined in src/ts/uimanager.ts:657

getSubtitleSettingsManager

getSubtitleSettingsManager(): SubtitleSettingsManager
Returns SubtitleSettingsManager
- Defined in src/ts/uimanager.ts:645

getUI

getUI(): UIContainer
Returns UIContainer
- Defined in src/ts/uimanager.ts:653