From 9f3d78c8e3d96d7396dff1e1e7f7381828d515a9 Mon Sep 17 00:00:00 2001 From: David Steinacher Date: Mon, 13 Jan 2025 18:25:25 +0100 Subject: [PATCH] improve documentation for UIFactory methods --- src/ts/uifactory.ts | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/src/ts/uifactory.ts b/src/ts/uifactory.ts index 201b3fc85..e4445fde9 100644 --- a/src/ts/uifactory.ts +++ b/src/ts/uifactory.ts @@ -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 */ @@ -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)