Class UIManager

Index

Constructors

Accessors

activeUi onActiveUiChanged onUiVariantResolve

Methods

addTimelineMarker getConfig getSubtitleSettingsManager getTimelineMarkers getUiVariants release removeTimelineMarker resolveUiVariant switchToUiVariant localize setLocalizationConfig

Constructors

constructor

new UIManager(
    player: PlayerAPI,
    ui: UIContainer,
    uiconfig?: UIConfig,
): UIManager
Creates a UI manager with a single UI variant that will be permanently shown.
Parameters
- player: PlayerAPI
  the associated player of this UI
- ui: UIContainer
  the UI to add to the player
- Optionaluiconfig: UIConfig
  optional UI configuration
Returns UIManager
- Defined in src/ts/UIManager.ts:143
new UIManager(
    player: PlayerAPI,
    uiVariants: UIVariant[],
    uiconfig?: UIConfig,
): UIManager
Creates a UI manager with a list of UI variants that will be dynamically selected and switched according to the context of the UI.

Every time the UI context changes, the conditions of the UI variants will be sequentially resolved and the first UI, whose condition evaluates to true, will be selected and displayed. The last variant in the list might omit the condition resolver and will be selected as default/fallback UI when all other conditions fail. If there is no fallback UI and all conditions fail, no UI will be displayed.
Parameters
- player: PlayerAPI
  the associated player of this UI
- uiVariants: UIVariant[]
  a list of UI variants that will be dynamically switched
- Optionaluiconfig: UIConfig
  optional UI configuration
Returns UIManager
- Defined in src/ts/UIManager.ts:157

Accessors

activeUi

get activeUi(): UIInstanceManager
The current active UIInstanceManager.

Returns UIInstanceManager
- Defined in src/ts/UIManager.ts:598

onActiveUiChanged

get onActiveUiChanged(): EventDispatcher<UIManager, ActiveUiChangedArgs>
Fires after the UIManager has switched to a different UI variant.

Returns EventDispatcher<UIManager, ActiveUiChangedArgs>
- Defined in src/ts/UIManager.ts:591

onUiVariantResolve

get onUiVariantResolve(): EventDispatcher<UIManager, UIConditionContext>
Fires just before UI variants are about to be resolved and the UI variant is possibly switched. It is fired when the switch is triggered from an automatic switch and when calling resolveUiVariant. Can be used to modify the UIConditionContext before resolving is done.

Returns EventDispatcher<UIManager, UIConditionContext>
- Defined in src/ts/UIManager.ts:583

Methods

addTimelineMarker

addTimelineMarker(timelineMarker: TimelineMarker): void
Adds a marker to the timeline. Does not check for duplicates/overlaps at the time.
Parameters
- timelineMarker: TimelineMarker
Returns void
- Defined in src/ts/UIManager.ts:612

getConfig

getConfig(): UIConfig
Returns UIConfig
- Defined in src/ts/UIManager.ts:421

getSubtitleSettingsManager

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

getTimelineMarkers

getTimelineMarkers(): TimelineMarker[]
Returns the list of all added markers in undefined order.

Returns TimelineMarker[]
- Defined in src/ts/UIManager.ts:605

getUiVariants

getUiVariants(): UIVariant[]
Returns the list of UI variants as passed into the constructor of UIManager.

Returns UIVariant[]
the list of available UI variants
- Defined in src/ts/UIManager.ts:429

release

release(): void
Returns void
- Defined in src/ts/UIManager.ts:569

removeTimelineMarker

removeTimelineMarker(timelineMarker: TimelineMarker): boolean
Removes a marker from the timeline (by reference) and returns true if the marker has been part of the timeline and successfully removed, or false if the marker could not be found and thus not removed.
Parameters
- timelineMarker: TimelineMarker
Returns boolean
- Defined in src/ts/UIManager.ts:622

resolveUiVariant

resolveUiVariant(
context?: Partial<UIConditionContext>,
onShow?: (context: UIConditionContext) => void,
): void
Triggers a UI variant switch as triggered by events when automatic switching is enabled. It allows to overwrite properties of the UIConditionContext.
Parameters
- context: Partial<UIConditionContext> = {}
  an optional set of properties that overwrite properties of the automatically determined context
- OptionalonShow: (context: UIConditionContext) => void
  a callback that is executed just before the new UI variant is shown (if a switch is happening)
Returns void
- Defined in src/ts/UIManager.ts:487

switchToUiVariant

switchToUiVariant(uiVariant: UIVariant, onShow?: () => void): void
Switches to a UI variant from the list returned by getUiVariants.
Parameters
- uiVariant: UIVariant
  the UI variant to switch to
- OptionalonShow: () => void
  a callback that is executed just before the new UI variant is shown
Returns void
- Defined in src/ts/UIManager.ts:438

`Static`localize

localize<V extends CustomVocabulary<Record<string, string>>>(
key: keyof V,
): Localizer
Exposes i18n.getLocalizer() function
Type Parameters
- V extends CustomVocabulary<Record<string, string>>
Parameters
- key: keyof V
Returns Localizer
- Defined in src/ts/UIManager.ts:405

`Static`setLocalizationConfig

setLocalizationConfig(localizationConfig: LocalizationConfig): void
Provide configuration to support Custom UI languages default language: 'en'
Parameters
- localizationConfig: LocalizationConfig
Returns void
- Defined in src/ts/UIManager.ts:413

Class UIManager

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns UIManager

Parameters

Returns UIManager

Accessors

activeUi

Returns UIInstanceManager

onActiveUiChanged

Returns EventDispatcher<UIManager, ActiveUiChangedArgs>

onUiVariantResolve

Returns EventDispatcher<UIManager, UIConditionContext>

Methods

addTimelineMarker

Parameters

Returns void

getConfig

Returns UIConfig

getSubtitleSettingsManager

Returns SubtitleSettingsManager

getTimelineMarkers

Returns TimelineMarker[]

getUiVariants

Returns UIVariant[]

release

Returns void

removeTimelineMarker

Parameters

Returns boolean

resolveUiVariant

Parameters

Returns void

switchToUiVariant

Parameters

Returns void

Staticlocalize

Type Parameters

Parameters

Returns Localizer

StaticsetLocalizationConfig

Parameters

Returns void

Settings

On This Page

`Static`localize

`Static`setLocalizationConfig