Skip to content

Commit

Permalink
improve documentation for UIFactory methods
Browse files Browse the repository at this point in the history
  • Loading branch information
stonko1994 committed Jan 13, 2025
1 parent 57a46cb commit 9f3d78c
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions src/ts/uifactory.ts
Original file line number Diff line number Diff line change
Expand Up @@ -52,22 +52,21 @@ import { TouchControlOverlay } from './components/touchcontroloverlay';
import { AdStatusOverlay } from './components/adstatusoverlay';

/**
* Provides factory methods to create different UI layouts.
* Provides factory methods to create Bitmovin provided UIs.
*/
export namespace UIFactory {
/**
* Builds a fully featured UI with all basic layouts for all platforms.
* Builds a fully featured UI with all Bitmovin provided variants.
* The UI will automatically switch between the different variants based on the current context.
*
* This UI includes variants for:
* - Default
* - Default UI (without additional context checks)
* - Ads
* - Small Screens (e.g. mobile devices)
* - Small Screen Ads
* - TVs
* - Cast Receivers
*
* The UI will automatically switch between the different layouts based on the current context.
*
* @param player The player instance used to build the UI
* @param config The UIConfig object
*/
Expand Down Expand Up @@ -116,7 +115,7 @@ export namespace UIFactory {

/**
* Builds a UI for small screens (e.g. mobile devices) only.
* This layout is optimized for small screens and touch input.
* This UI is optimized for small screens and touch input.
*
* This UI includes variants for:
* - Small Screens (e.g. mobile devices)
Expand Down

0 comments on commit 9f3d78c

Please sign in to comment.