@glomex/integration-web-component 1.1477.0 → 1.1478.0

package/dist/index.d.ts

@@ -1279,7 +1279,7 @@ export declare interface Marker {
     type: MarkerType;
     /**
      * Threshold for the marker:
-     * - {@link MarkerType.TIME_IN_SECONDS}: seconds
+     * - {@link MarkerType.TIME_IN_SECONDS}: seconds (use negative values to calculate position from end of content, e.g., -10 means 10 seconds before the end; only valid for VoD content)
      * - {@link MarkerType.PERCENT}: percent as fraction (0-1)
      * - {@link MarkerType.TIME_IN_SECONDS_RECURRING}: seconds
      */
@@ -1405,7 +1405,52 @@ export declare interface MediaItem {
      */
     channel?: Channel;
     /**
-     * Markers of the media item.
+     * Markers control ad breaks and custom time-based events during playback.
+     *
+     * **⚠️ Important:** When providing custom markers, the default PREROLL is **not** added automatically.
+     * You must explicitly include a PREROLL marker if you want ads to play.
+     *
+     * **Reserved marker names:** Only `PREROLL`, `MIDROLL`, and `POSTROLL` from {@link KnownMarkerName}
+     * can be used for ad markers. All other `KnownMarkerName` values are reserved for internal use.
+     * Use custom string names (e.g., `'halfwayPoint'`) for your own markers.
+     *
+     * **Listening for custom markers:** When a custom marker is reached, the player dispatches
+     * an {@link IntegrationEvent.CONTENT_MARKER_REACHED} event. Listen for this event to react
+     * to your custom markers:
+     *
+     * ```js
+     * player.addEventListener('contentmarkerreached', (event) => {
+     *   const { markerName, markerData } = event.detail;
+     *   if (markerName === 'showEndCreditsOverlay') {
+     *     // Show your overlay
+     *   }
+     * });
+     * ```
+     *
+     * @example
+     * // Default: pre-roll ads only (same as omitting markers)
+     * markers: [{ name: KnownMarkerName.PREROLL, type: MarkerType.TIME_IN_SECONDS, threshold: 0 }]
+     *
+     * @example
+     * // Pre-roll + mid-roll at 60 seconds
+     * markers: [
+     *   { name: KnownMarkerName.PREROLL, type: MarkerType.TIME_IN_SECONDS, threshold: 0 },
+     *   { name: KnownMarkerName.MIDROLL, type: MarkerType.TIME_IN_SECONDS, threshold: 60 }
+     * ]
+     *
+     * @example
+     * // Custom marker at 50% of content
+     * markers: [
+     *   { name: KnownMarkerName.PREROLL, type: MarkerType.TIME_IN_SECONDS, threshold: 0 },
+     *   { name: 'halfwayPoint', type: MarkerType.PERCENT, threshold: 0.5 }
+     * ]
+     *
+     * @example
+     * // Custom marker 15 seconds before end (e.g., for end credits overlay)
+     * markers: [
+     *   { name: KnownMarkerName.PREROLL, type: MarkerType.TIME_IN_SECONDS, threshold: 0 },
+     *   { name: 'showEndCreditsOverlay', type: MarkerType.TIME_IN_SECONDS, threshold: -15 }
+     * ]
      *
      * @defaultValue `[{ name: KnownMarkerName.PREROLL, type: MarkerType.TIME_IN_SECONDS, threshold: 0 }]`
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@glomex/integration-web-component",
-  "version": "1.1477.0",
+  "version": "1.1478.0",
   "description": "Web component and types to integrate the glomex player",
   "documentation": "https://docs.glomex.com",
   "homepage": "https://glomex.com",
@@ -32,7 +32,7 @@
   },
   "devDependencies": {
     "@biomejs/biome": "catalog:",
-    "@glomex/integration": "1.1477.0",
+    "@glomex/integration": "1.1478.0",
     "@microsoft/api-extractor": "catalog:",
     "@rslib/core": "catalog:",
     "npm-run-all": "catalog:",
@@ -42,5 +42,5 @@
     "access": "public"
   },
   "license": "MIT",
-  "gitHead": "a44bcafd89f97e5adaefe7a0680b4f256a3e1e95"
+  "gitHead": "5c4af5f5c3f822a09675e6fb49b3bcc01a93853c"
 }