Class UIInstanceManager

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

Index

Constructors

Accessors

onBufferingHide onBufferingShow onComponentHide onComponentShow onComponentViewModeChanged onConfigured onControlsHide onControlsShow onPreviewControlsHide onRelease onSeek onSeeked onSeekPreview

Methods

getConfig getPlayer getSubtitleSettingsManager getUI

Constructors

constructor

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

Accessors

onBufferingHide

get onBufferingHide(): EventDispatcher<BufferingOverlay, NoArgs>
Fires when the BufferingOverlay hides.

Returns EventDispatcher<BufferingOverlay, NoArgs>
- Defined in src/ts/UIManager.ts:783

onBufferingShow

get onBufferingShow(): EventDispatcher<BufferingOverlay, NoArgs>
Fires when the BufferingOverlay shows.

Returns EventDispatcher<BufferingOverlay, NoArgs>
- Defined in src/ts/UIManager.ts:775

onComponentHide

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

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

onComponentShow

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

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

onComponentViewModeChanged

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

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:703

onControlsHide

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

Returns EventDispatcher<UIContainer, NoArgs>
- Defined in src/ts/UIManager.ts:767

onControlsShow

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

Returns EventDispatcher<UIContainer, NoArgs>
- Defined in src/ts/UIManager.ts:751

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:759

onRelease

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

Returns EventDispatcher<UIContainer, NoArgs>
- Defined in src/ts/UIManager.ts:791

onSeek

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

Returns EventDispatcher<SeekBar, NoArgs>
- Defined in src/ts/UIManager.ts:711

onSeeked

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

Returns EventDispatcher<SeekBar, NoArgs>
- Defined in src/ts/UIManager.ts:727

onSeekPreview

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

Returns EventDispatcher<SeekBar, SeekPreviewArgs>
- Defined in src/ts/UIManager.ts:719

Methods

getConfig

getConfig(): InternalUIConfig
Returns InternalUIConfig
- Defined in src/ts/UIManager.ts:687

getPlayer

getPlayer(): PlayerAPI
Returns PlayerAPI
- Defined in src/ts/UIManager.ts:695

getSubtitleSettingsManager

getSubtitleSettingsManager(): SubtitleSettingsManager
Returns SubtitleSettingsManager
- Defined in src/ts/UIManager.ts:683

getUI

getUI(): UIContainer
Returns UIContainer
- Defined in src/ts/UIManager.ts:691

Class UIInstanceManager

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns UIInstanceManager

Accessors

onBufferingHide

Returns EventDispatcher<BufferingOverlay, NoArgs>

onBufferingShow

Returns EventDispatcher<BufferingOverlay, NoArgs>

onComponentHide

Returns EventDispatcher<Component<ComponentConfig>, NoArgs>

onComponentShow

Returns EventDispatcher<Component<ComponentConfig>, NoArgs>

onComponentViewModeChanged

Returns EventDispatcher<Component<ComponentConfig>, ViewModeChangedEventArgs>

onConfigured

Returns EventDispatcher<UIContainer, NoArgs>

onControlsHide

Returns EventDispatcher<UIContainer, NoArgs>

onControlsShow

Returns EventDispatcher<UIContainer, NoArgs>

onPreviewControlsHide

Returns EventDispatcher<UIContainer, CancelEventArgs>

onRelease

Returns EventDispatcher<UIContainer, NoArgs>

onSeek

Returns EventDispatcher<SeekBar, NoArgs>

onSeeked

Returns EventDispatcher<SeekBar, NoArgs>

onSeekPreview

Returns EventDispatcher<SeekBar, SeekPreviewArgs>

Methods

getConfig

Returns InternalUIConfig

getPlayer

Returns PlayerAPI

getSubtitleSettingsManager

Returns SubtitleSettingsManager

getUI

Returns UIContainer

Settings

On This Page