muxinc · cjpillsbury · Sep 17, 2024 · Sep 17, 2024 · Sep 17, 2024 · Sep 17, 2024
@@ -0,0 +1,73 @@
+<!doctype html>
+<html>
+  <head>
+    <meta name="viewport" content="width=device-width" />
+    <title>&lt;mux-player&gt; Google IMA CSAI example</title>
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/water.css@2/out/water.css" />
+    <link rel="stylesheet" href="./styles.css" />
+    <script type="module" src="./dist/mux-player.js"></script>
+    <script type="text/javascript" src="https://imasdk.googleapis.com/js/sdkloader/ima3.js"></script>
+    <style>
+      mux-player {
+        display: block;
+        width: 100%;
+        margin: 1rem 0 2rem;
+        background-color: #000;
+      }
+
+      mux-player:not([audio]) {
+        aspect-ratio: 16 / 9;
+      }
+    </style>
+  </head>
+  <body>
+    <header>
+      <div class="left-header">
+        <a class="mux-logo" href="https://www.mux.com/player" target="_blank">
+          <picture>
+            <source
+              media="(prefers-color-scheme: dark)"
+              srcset="
+                https://user-images.githubusercontent.com/360826/233653989-11cd8603-c20f-4008-8bf7-dc15b743c52b.svg
+              "
+            />
+            <source
+              media="(prefers-color-scheme: light)"
+              srcset="
+                https://user-images.githubusercontent.com/360826/233653583-50dda726-cbe7-4182-a113-059a91ae83e6.svg
+              "
+            />
+            <img
+              alt="Mux Logo"
+              src="https://user-images.githubusercontent.com/360826/233653583-50dda726-cbe7-4182-a113-059a91ae83e6.svg"
+            />
+          </picture>
+        </a>
+        <h1><a href="/">Elements</a></h1>
+      </div>
+      <div class="right-header">
+        <a class="github-logo" href="https://github.com/muxinc/elements" target="_blank">
+          <img width="32" height="32" src="./images/github-logo.svg" alt="Github logo" />
+        </a>
+      </div>
+    </header>
+
+    <!--
+    single preroll skippable
+    adtagurl="https://pubads.g.doubleclick.net/gampad/ads?iu=/21775744923/external/single_preroll_skippable&sz=640x480&ciu_szs=300x250%2C728x90&gdfp_req=1&output=vast&unviewed_position_start=1&env=vp&impl=s&correlator="
+
+    VMAP - Pre-roll Single Ad, Mid-roll Standard Pod with 3 ads, Post-roll Single Ad
+    adtagurl="https://pubads.g.doubleclick.net/gampad/ads?iu=/21775744923/external/vmap_ad_samples&sz=640x480&cust_params=sample_ar%3Dpremidpostpod&ciu_szs=300x250&gdfp_req=1&ad_rule=1&output=vmap&unviewed_position_start=1&env=vp&impl=s&cmsid=496&vid=short_onecue&correlator="
+    -->
+    <mux-player
+      id="muxPlayer"
+      title="Big Buck Bunny"
+      stream-type="on-demand"
+      playback-id="VcmKA6aqzIzlg3MayLJDnbF55kX00mds028Z65QxvBYaA"
+      muted
+      adtagurl="https://pubads.g.doubleclick.net/gampad/ads?iu=/21775744923/external/vmap_ad_samples&sz=640x480&cust_params=sample_ar%3Dpremidpostpod&ciu_szs=300x250&gdfp_req=1&ad_rule=1&output=vmap&unviewed_position_start=1&env=vp&impl=s&cmsid=496&vid=short_onecue&correlator="
+    ></mux-player>
+
+    <a href="../">Browse Elements</a>
+  </body>
+</html>
@@ -84,6 +84,8 @@ const PlayerAttributes = {
   NO_VOLUME_PREF: 'no-volume-pref',
   CAST_RECEIVER: 'cast-receiver',
   NO_TOOLTIPS: 'no-tooltips',
+  /** @TODO Move to separate/extended, ads-only impl/module? (CJP) */
+  AD_TAG_URL: 'adtagurl',
 };
 
 const ThemeAttributeNames = [
@@ -172,6 +174,14 @@ function getProps(el: MuxPlayerElement, state?: any): MuxTemplateProps {
     // NOTE: since the attribute value is used as the "source of truth" for the property getter,
     // moving this below the `...state` spread so it resolves to the default value when unset (CJP)
     extraSourceParams: el.extraSourceParams,
+    /** @TODO Move to separate/extended, ads-only impl/module? (CJP) */
+    adTagUrl: el.adTagUrl,
+    /** @TODO Move to separate/extended, ads-only impl/module? (CJP) */
+    adBreak: el.adBreak,
+    /** @TODO Move to separate/extended, ads-only impl/module? (CJP) */
+    adBreakTotalAds: el.adBreakTotalAds,
+    /** @TODO Move to separate/extended, ads-only impl/module? (CJP) */
+    adBreakAdPosition: el.adBreakAdPosition,
   };
 
   return props;
@@ -365,6 +375,35 @@ class MuxPlayerElement extends VideoApiElement implements MuxPlayerElement {
 
     // NOTE: Make sure we re-render when <source> tags are appended so hasSrc is updated.
     this.media?.addEventListener('loadstart', () => this.#render());
+
+    /** @TODO remove me when migrated to media chrome */
+    this.media?.addEventListener('adbreakchange', () => {
+      // MediaUIEvents.MEDIA_EXIT_PIP_REQUEST
+      this.mediaController?.dispatchEvent(new CustomEvent('mediaexitpiprequest'));
+      this.#render();
+    });
+    this.media?.addEventListener('adbreakadpositionchange', () => {
+      this.#render();
+    });
+    this.media?.addEventListener('adbreaktotaladschange', () => {
+      this.#render();
+    });
+    this.mediaController?.addEventListener('mediaisfullscreen', () => {
+      const { mediaIsFullscreen = false } = this.mediaController?.mediaStore.getState() ?? {};
+      /** @TODO Figure out API design (CJP) */
+      if (this.media) {
+        this.media.mediaIsFullscreen = mediaIsFullscreen;
+      }
+    });
+
+    /** @TODO Tests for user inactive crud. remove before merging (CJP) */
+    // this.media?.addEventListener('pointermove', () => {
+    //   console.log('POINTER MOVING MEDIA');
+    // });
+
+    // this.mediaController?.addEventListener('pointermove', () => {
+    //   console.log('POINTER MOVING MEDIA CONTROLLER');
+    // });
   }
 
   #setupCSSProperties() {
@@ -397,7 +436,7 @@ class MuxPlayerElement extends VideoApiElement implements MuxPlayerElement {
   }
 
   connectedCallback() {
-    const muxVideo = this.shadowRoot?.querySelector('mux-video') as MuxVideoElement;
+    const muxVideo = this.shadowRoot?.querySelector('mux-video') as unknown as MuxVideoElement;
     if (muxVideo) {
       muxVideo.metadata = getMetadataFromAttrs(this);
     }
@@ -1743,6 +1782,37 @@ class MuxPlayerElement extends VideoApiElement implements MuxPlayerElement {
     }
     this.setAttribute(PlayerAttributes.NO_TOOLTIPS, '');
   }
+
+  /** @TODO Move to separate/extended, ads-only impl/module? (CJP) */
+  get adTagUrl() {
+    return this.media?.adTagUrl ?? this.getAttribute(PlayerAttributes.AD_TAG_URL) ?? undefined;
+  }
+
+  /** @TODO Move to separate/extended, ads-only impl/module? (CJP) */
+  set adTagUrl(val: string | undefined) {
+    if (val === this.adTagUrl) return;
+
+    if (val) {
+      this.setAttribute(PlayerAttributes.AD_TAG_URL, val);
+    } else {
+      this.removeAttribute(PlayerAttributes.AD_TAG_URL);
+    }
+  }
+
+  /** @TODO Move to separate/extended, ads-only impl/module? (CJP) */
+  get adBreak() {
+    return this.media?.adBreak ?? false;
+  }
+
+  /** @TODO Move to separate/extended, ads-only impl/module? (CJP) */
+  get adBreakTotalAds() {
+    return this.media?.adBreakTotalAds;
+  }
+
+  /** @TODO Move to separate/extended, ads-only impl/module? (CJP) */
+  get adBreakAdPosition() {
+    return this.media?.adBreakAdPosition;
+  }
 }
 
 export function getVideoAttribute(el: MuxPlayerElement, name: string) {

@@ -0,0 +1,155 @@
+import { MediaTextDisplay } from 'media-chrome/dist/media-text-display.js';
+import { getNumericAttr, getStringAttr, setNumericAttr, setStringAttr } from 'media-chrome/dist/utils/element-utils.js';
+import { globalThis } from 'media-chrome/dist/utils/server-safe-globals.js';
+import { MediaUIAttributes as MediaUIAttributesBase } from 'media-chrome/dist/constants.js';
+// import { nouns } from 'media-chrome/dist/labels/labels.js';
+
+const MediaUIAttributes = {
+  ...MediaUIAttributesBase,
+  MEDIA_AD_BREAK_TOTAL_ADS: 'mediaadbreaktotalads',
+  MEDIA_AD_BREAK_AD_POSITION: 'mediaadbreakadposition',
+} as const;
+
+export const Attributes = {
+  PREFIX: 'prefix',
+};
+
+const CombinedAttributes = [
+  ...Object.values(Attributes),
+  MediaUIAttributes.MEDIA_AD_BREAK_TOTAL_ADS,
+  MediaUIAttributes.MEDIA_AD_BREAK_AD_POSITION,
+];
+
+// Todo: Use data locals: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toLocaleTimeString
+
+const DEFAULT_COUNT_SEP = 'of';
+const DEFAULT_PREFIX = 'Advertisement';
+
+const formatLabel = (el: MediaAdCountDisplay, { countSep = DEFAULT_COUNT_SEP } = {}): string => {
+  const prefixPart = el.prefix ? `${el.prefix}: ` : '';
+  return `${prefixPart}${el.mediaAdBreakAdPosition} ${countSep} ${el.mediaAdBreakTotalAds}`;
+};
+
+// const DEFAULT_MISSING_TIME_PHRASE = 'video not loaded, unknown time.';
+
+const updateAriaValueText = (el: MediaAdCountDisplay): void => {
+  const fullPhrase = formatLabel(el);
+  el.setAttribute('aria-valuetext', fullPhrase);
+};
+
+/**
+ * @attr {string} prefix - the prefix string for the display. 'Advertisement' by default.
+ * @attr {number} mediaadbreaktotalads - (read-only) total number of ads in the current ad break
+ * @attr {number} mediaadbreakadposition - (read-only) current ad index playing in the current ad break
+ */
+class MediaAdCountDisplay extends MediaTextDisplay {
+  #slot: HTMLSlotElement;
+
+  static get observedAttributes(): string[] {
+    return [...super.observedAttributes, ...CombinedAttributes, 'disabled'];
+  }
+
+  constructor() {
+    super();
+
+    this.#slot = this.shadowRoot?.querySelector('slot') as HTMLSlotElement;
+    this.#slot.innerHTML = `${formatLabel(this)}`;
+  }
+
+  connectedCallback(): void {
+    if (!this.hasAttribute('disabled')) {
+      this.enable();
+    }
+
+    /** @TODO Implement these */
+    this.setAttribute('role', 'progressbar');
+    this.setAttribute('aria-label', 'FILL ME IN');
+
+    super.connectedCallback();
+  }
+
+  disconnectedCallback(): void {
+    this.disable();
+    super.disconnectedCallback();
+  }
+
+  attributeChangedCallback(attrName: string, oldValue: string | null, newValue: string | null): void {
+    if (CombinedAttributes.includes(attrName)) {
+      this.update();
+    } else if (attrName === 'disabled' && newValue !== oldValue) {
+      if (newValue == null) {
+        this.enable();
+      } else {
+        this.disable();
+      }
+    }
+
+    super.attributeChangedCallback(attrName, oldValue, newValue);
+  }
+
+  enable(): void {
+    this.tabIndex = 0;
+  }
+
+  disable(): void {
+    this.tabIndex = -1;
+  }
+
+  // Own props
+
+  /**
+   * Describe me
+   */
+  get prefix(): string {
+    return getStringAttr(this, Attributes.PREFIX, DEFAULT_PREFIX);
+  }
+
+  set prefix(val: string | undefined) {
+    /** @TODO inaccurate type def in media chrome. Accepts/expects nullish. (CJP) */
+    /** @ts-ignore */
+    setStringAttr(this, Attributes.PREFIX, val);
+  }
+
+  // Props derived from media UI attributes
+
+  /**
+   * Describe me
+   */
+  get mediaAdBreakTotalAds(): number | undefined {
+    return getNumericAttr(this, MediaUIAttributes.MEDIA_AD_BREAK_TOTAL_ADS);
+  }
+
+  set mediaAdBreakTotalAds(val: number | undefined) {
+    /** @TODO inaccurate type def in media chrome. Accepts/expects nullish. (CJP) */
+    /** @ts-ignore */
+    setNumericAttr(this, MediaUIAttributes.MEDIA_AD_BREAK_TOTAL_ADS, val);
+  }
+
+  /**
+   * Describe me
+   */
+  get mediaAdBreakAdPosition(): number | undefined {
+    return getNumericAttr(this, MediaUIAttributes.MEDIA_AD_BREAK_AD_POSITION);
+  }
+
+  set mediaAdBreakAdPosition(val: number | undefined) {
+    /** @TODO inaccurate type def in media chrome. Accepts/expects nullish. (CJP) */
+    /** @ts-ignore */
+    setNumericAttr(this, MediaUIAttributes.MEDIA_AD_BREAK_AD_POSITION, val);
+  }
+
+  update(): void {
+    const label = formatLabel(this);
+    updateAriaValueText(this);
+    // Only update if it changed, timeupdate events are called a few times per second.
+    if (label !== this.#slot.innerHTML) {
+      this.#slot.innerHTML = label;
+    }
+  }
+}
+
+if (!globalThis.customElements.get('media-ad-count-display')) {
+  globalThis.customElements.define('media-ad-count-display', MediaAdCountDisplay);
+}
+
+export default MediaAdCountDisplay;
@@ -2,6 +2,7 @@ import 'media-chrome/dist/media-theme-element.js';
 // @ts-ignore
 import cssStr from './styles.css';
 import './dialog';
+import './media-chrome/ads/media-ad-count-display';
 import { getStreamTypeFromAttr } from './helpers';
 import { html } from './html';
 import { i18n, stylePropsToString } from './utils';
@@ -83,6 +84,13 @@ export const partsListStr = Object.values(Parts).join(', ');
 export const content = (props: MuxTemplateProps) => html`
   <media-theme
     template="${props.themeTemplate || false}"
+    mediaadbreak="${/** @TODO Move to separate/extended, ads-only impl/module? (CJP) */ props.adBreak ?? false}"
+    mediaadbreaktotalads="${
+      /** @TODO Move to separate/extended, ads-only impl/module? (CJP) */ props.adBreakTotalAds ?? false
+    }"
+    mediaadbreakadposition="${
+      /** @TODO Move to separate/extended, ads-only impl/module? (CJP) */ props.adBreakAdPosition ?? false
+    }"
     defaultstreamtype="${props.defaultStreamType ?? false}"
     hotkeys="${getHotKeys(props) || false}"
     nohotkeys="${props.noHotKeys || !props.hasSrc || props.isDialogOpen || false}"
@@ -131,6 +139,7 @@ export const content = (props: MuxTemplateProps) => html`
       cast-receiver="${props.castReceiver ?? false}"
       drm-token="${props.tokens?.drm ?? false}"
       exportparts="video"
+      adtagurl="${/** @TODO Move to separate/extended, ads-only impl/module? (CJP) */ props.adTagUrl ?? false}"
     >
       ${props.storyboard
         ? html`<track label="thumbnails" default kind="metadata" src="${props.storyboard}" />`