Merge pull request #681 from bitmovin/feature/remove-watermark-per-de…

…fault Remove Watermark per default
bitmovin · Jan 17, 2025 · 061b523 · 061b523
2 parents 08382a3 + a7c4c8d
commit 061b523
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 7 deletions.
diff --git a/assets/images/logo.svg b/assets/images/logo.svg
diff --git a/src/html/index.html b/src/html/index.html
@@ -263,6 +263,7 @@ <h4 class="card-title">
 //      {title: 'Recommendation 12: Ain\'t no better video than this', url: 'http://bitmovin.com', thumbnail: 'http://placehold.it/300x300', duration: 34}
 //    ],
 //      seekbarSnappingRange: 0,
+    includeWatermark: true,
   };
 
   var player;

diff --git a/src/html/simple.html b/src/html/simple.html
@@ -59,7 +59,7 @@
     };
 
     var player = new bitmovin.player.Player(document.getElementById('player'), conf);
-    var uiManager = bitmovin.playerui.UIFactory.buildDefaultUI(player, {});
+    var uiManager = bitmovin.playerui.UIFactory.buildUI(player, { includeWatermark: true });
     player.load(source);
 </script>
 </body>

diff --git a/src/ts/UIConfig.ts b/src/ts/UIConfig.ts
@@ -131,4 +131,11 @@ export interface UIConfig {
    * Specifies if the `EcoModeToggleButton` should be displayed within the `SettingsPanel`
    */
   ecoMode?: boolean;
+  /**
+   * Specifies if the Watermark element should be included in the UI.
+   * Per default, the Watermark shows the Bitmovin Logo.
+   *
+   * Default: false
+   */
+  includeWatermark?: boolean;
 }
diff --git a/src/ts/UIFactory.ts b/src/ts/UIFactory.ts
@@ -173,7 +173,7 @@ export namespace UIFactory {
    * @param config The UIConfig object
    */
   export function buildCastReceiverUI(player: PlayerAPI, config: UIConfig = {}): UIManager {
-    return new UIManager(player, castReceiverUILayout(), config);
+    return new UIManager(player, castReceiverUILayout(config), config);
   }
 
   /**
@@ -309,6 +309,10 @@ function uiLayout(config: UIConfig) {
     ],
   });
 
+  const conditionalComponents = [
+    config.includeWatermark ? new Watermark() : null,
+  ].filter((e) => e);
+
   return new UIContainer({
     components: [
       subtitleOverlay,
@@ -318,8 +322,8 @@ function uiLayout(config: UIConfig) {
       controlBar,
       new TitleBar(),
       new RecommendationOverlay(),
-      new Watermark(),
       settingsPanel,
+      ...conditionalComponents,
       new ErrorMessageOverlay(),
     ],
     hideDelay: 2000,
@@ -543,7 +547,7 @@ function smallScreenAdsUILayout() {
   });
 }
 
-function castReceiverUILayout() {
+function castReceiverUILayout(config: UIConfig) {
   let controlBar = new ControlBar({
     components: [
       new Container({
@@ -563,14 +567,18 @@ function castReceiverUILayout() {
     ],
   });
 
+  const conditionalComponents = [
+    config.includeWatermark ? new Watermark() : null,
+  ].filter((e) => e);
+
   return new CastUIContainer({
     components: [
       new SubtitleOverlay(),
       new BufferingOverlay(),
       new PlaybackToggleOverlay(),
-      new Watermark(),
       controlBar,
       new TitleBar({ keepHiddenWithoutMetadata: true }),
+      ...conditionalComponents,
       new ErrorMessageOverlay(),
     ],
     cssClasses: ['ui-cast-receiver'],