@glomex/integration-web-component 1.1496.1 → 1.1498.0

package/dist/index.d.ts

@@ -234,14 +234,15 @@ export declare interface ExtendedVideoPlaybackQuality extends VideoPlaybackQuali
 export declare const EXTERNAL_PLAYER_NAME = "turbo-player";
 
 /**
- * A media item web component that allows to define an external media item. It can be placed
- * inside the integration element. For more complex use cases, see {@link MediaItemElement}.
+ * A media item web component that allows to define external media items via inline JSON.
+ * It can be placed inside the integration element as a child.
+ * For more complex use cases, see {@link MediaItemElement}.
  *
  * @tagname glomex-external-media-item
  *
- * @slot - (optional) Slot for inline JSON of type `application/glomex-external-media-item+json`
+ * @slot - Slot for inline JSON of type `application/glomex-external-media-item+json`
  *
- * @example the most simple glomex-external-media-item
+ * @example single media item with inline JSON
  *
  * This only works when no `playlist-id` is assigned to `glomex-integration`
  *
@@ -249,26 +250,6 @@ export declare const EXTERNAL_PLAYER_NAME = "turbo-player";
  * <glomex-integration
  *   integration-id="REPLACE_WITH_INTEGRATION_ID"
  * >
- *   <glomex-external-media-item
- *     id="SOME_ID"
- *     src="SOME_VIDEO_URL"
- *     duration="LENGTH_OF_VIDEO"
- *     poster="POSTER_URL"
- *     title="VIDEO_TITLE"
- *   ></glomex-external-media-item>
- *  <!-- further media items -->
- * </glomex-integration>
- * ```
- *
- * @example the most simple glomex-external-media-item with inline JSON
- *
- * It is possible to use {@link MediaItem} or array of {@link MediaItem}
- * in JSON format.
- *
- * ```html
- * <glomex-integration
- *   integration-id="REPLACE_WITH_INTEGRATION_ID"
- * >
  *   <glomex-external-media-item>
  *     <script type="application/glomex-external-media-item+json">
  *       {
@@ -279,7 +260,7 @@ export declare const EXTERNAL_PLAYER_NAME = "turbo-player";
  *             "mimetype": "video/mp4"
  *           }
  *         ],
- *         "duration": "LENGTH_OF_VIDEO",
+ *         "duration": 120,
  *         "poster": "POSTER_URL",
  *         "title": "VIDEO_TITLE"
  *       }
@@ -287,70 +268,41 @@ export declare const EXTERNAL_PLAYER_NAME = "turbo-player";
  *   </glomex-external-media-item>
  * </glomex-integration>
  * ```
+ *
+ * @example multiple media items with inline JSON array
+ *
+ * You can also pass an array of {@link MediaItem} objects to define a playlist.
+ *
+ * ```html
+ * <glomex-integration
+ *   integration-id="REPLACE_WITH_INTEGRATION_ID"
+ * >
+ *   <glomex-external-media-item>
+ *     <script type="application/glomex-external-media-item+json">
+ *       [
+ *         {
+ *           "id": "VIDEO_1",
+ *           "sources": [{ "src": "VIDEO_1_URL", "mimetype": "video/mp4" }],
+ *           "duration": 120,
+ *           "poster": "POSTER_1_URL",
+ *           "title": "First Video"
+ *         },
+ *         {
+ *           "id": "VIDEO_2",
+ *           "sources": [{ "src": "VIDEO_2_URL", "mimetype": "video/mp4" }],
+ *           "duration": 180,
+ *           "poster": "POSTER_2_URL",
+ *           "title": "Second Video"
+ *         }
+ *       ]
+ *     </script>
+ *   </glomex-external-media-item>
+ * </glomex-integration>
+ * ```
  */
 export declare class ExternalMediaItemElement extends HTMLElement implements MediaItemElement {
     #private;
-    /**
-     * {@inheritDoc MediaItem#id}
-     */
-    id: string;
-    /**
-     * {@inheritDoc MediaSourceBase#src}
-     */
-    src: string;
-    /**
-     * {@inheritDoc MediaSourceBase#mimetype}
-     */
-    mimetype?: MediaSource_2['mimetype'];
-    /**
-     * {@inheritDoc MediaSourceBase#playbackMode}
-     */
-    playbackMode?: MediaSourceBase['playbackMode'];
-    /**
-     * {@inheritDoc MediaItem#duration}
-     */
-    duration?: number;
-    /**
-     * {@inheritDoc MediaItem#poster}
-     */
-    poster: string;
-    /**
-     * {@inheritDoc MediaItem#title}
-     */
-    title: string;
-    /**
-     * {@inheritDoc MediaItem#description}
-     */
-    description?: string;
-    /**
-     * {@inheritDoc Channel#logo}
-     */
-    channelLogo?: string;
-    /**
-     * {@inheritDoc Channel#name}
-     */
-    channelName?: string;
-    /**
-     * {@inheritDoc MediaItem#aspectRatio}
-     */
-    aspectRatio?: string;
-    /**
-     * {@inheritDoc MediaItem#minimumAge}
-     */
-    minimumAge?: number;
-    /**
-     * {@inheritDoc MediaItem#releaseDate}
-     */
-    releaseDate?: number;
-    /**
-     * {@inheritDoc MediaItem#endDate}
-     */
-    endDate?: number;
-    /**
-     * {@inheritDoc MediaItem#hasProductPlacement}
-     */
-    hasProductPlacement?: boolean;
-    get data(): MediaItem;
+    get data(): MediaItem | MediaItem[];
 }
 
 /**
@@ -1370,6 +1322,9 @@ export declare interface MediaItem {
     /**
      * Array of text tracks for subtitles, captions, etc.
      * These tracks apply to the whole media item, not to individual sources.
+     *
+     * Note: This is only useful for progressive sources or when the adaptive stream
+     * (HLS/DASH) does not deliver the text tracks / subtitles within the manifest.
      */
     textTracks?: MediaItemTextTrack[];
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@glomex/integration-web-component",
-  "version": "1.1496.1",
+  "version": "1.1498.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.1496.1",
+    "@glomex/integration": "1.1498.0",
     "@microsoft/api-extractor": "catalog:",
     "@rslib/core": "catalog:",
     "npm-run-all": "catalog:",
@@ -42,5 +42,5 @@
     "access": "public"
   },
   "license": "MIT",
-  "gitHead": "24affa3b0391e08269ce20e92baf6f31eb3ca7b0"
+  "gitHead": "c3da9e882be30c8d6f4fbe1c92b71b5b871df001"
 }