@glomex/integration-web-component 1.1497.0 → 1.1499.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist/index.d.ts +41 -86
  2. package/package.json +3 -3
package/dist/index.d.ts CHANGED
@@ -234,14 +234,15 @@ export declare interface ExtendedVideoPlaybackQuality extends VideoPlaybackQuali
234
234
  export declare const EXTERNAL_PLAYER_NAME = "turbo-player";
235
235
 
236
236
  /**
237
- * A media item web component that allows to define an external media item. It can be placed
238
- * inside the integration element. For more complex use cases, see {@link MediaItemElement}.
237
+ * A media item web component that allows to define external media items via inline JSON.
238
+ * It can be placed inside the integration element as a child.
239
+ * For more complex use cases, see {@link MediaItemElement}.
239
240
  *
240
241
  * @tagname glomex-external-media-item
241
242
  *
242
- * @slot - (optional) Slot for inline JSON of type `application/glomex-external-media-item+json`
243
+ * @slot - Slot for inline JSON of type `application/glomex-external-media-item+json`
243
244
  *
244
- * @example the most simple glomex-external-media-item
245
+ * @example single media item with inline JSON
245
246
  *
246
247
  * This only works when no `playlist-id` is assigned to `glomex-integration`
247
248
  *
@@ -249,26 +250,6 @@ export declare const EXTERNAL_PLAYER_NAME = "turbo-player";
249
250
  * <glomex-integration
250
251
  * integration-id="REPLACE_WITH_INTEGRATION_ID"
251
252
  * >
252
- * <glomex-external-media-item
253
- * id="SOME_ID"
254
- * src="SOME_VIDEO_URL"
255
- * duration="LENGTH_OF_VIDEO"
256
- * poster="POSTER_URL"
257
- * title="VIDEO_TITLE"
258
- * ></glomex-external-media-item>
259
- * <!-- further media items -->
260
- * </glomex-integration>
261
- * ```
262
- *
263
- * @example the most simple glomex-external-media-item with inline JSON
264
- *
265
- * It is possible to use {@link MediaItem} or array of {@link MediaItem}
266
- * in JSON format.
267
- *
268
- * ```html
269
- * <glomex-integration
270
- * integration-id="REPLACE_WITH_INTEGRATION_ID"
271
- * >
272
253
  * <glomex-external-media-item>
273
254
  * <script type="application/glomex-external-media-item+json">
274
255
  * {
@@ -279,7 +260,7 @@ export declare const EXTERNAL_PLAYER_NAME = "turbo-player";
279
260
  * "mimetype": "video/mp4"
280
261
  * }
281
262
  * ],
282
- * "duration": "LENGTH_OF_VIDEO",
263
+ * "duration": 120,
283
264
  * "poster": "POSTER_URL",
284
265
  * "title": "VIDEO_TITLE"
285
266
  * }
@@ -287,70 +268,41 @@ export declare const EXTERNAL_PLAYER_NAME = "turbo-player";
287
268
  * </glomex-external-media-item>
288
269
  * </glomex-integration>
289
270
  * ```
271
+ *
272
+ * @example multiple media items with inline JSON array
273
+ *
274
+ * You can also pass an array of {@link MediaItem} objects to define a playlist.
275
+ *
276
+ * ```html
277
+ * <glomex-integration
278
+ * integration-id="REPLACE_WITH_INTEGRATION_ID"
279
+ * >
280
+ * <glomex-external-media-item>
281
+ * <script type="application/glomex-external-media-item+json">
282
+ * [
283
+ * {
284
+ * "id": "VIDEO_1",
285
+ * "sources": [{ "src": "VIDEO_1_URL", "mimetype": "video/mp4" }],
286
+ * "duration": 120,
287
+ * "poster": "POSTER_1_URL",
288
+ * "title": "First Video"
289
+ * },
290
+ * {
291
+ * "id": "VIDEO_2",
292
+ * "sources": [{ "src": "VIDEO_2_URL", "mimetype": "video/mp4" }],
293
+ * "duration": 180,
294
+ * "poster": "POSTER_2_URL",
295
+ * "title": "Second Video"
296
+ * }
297
+ * ]
298
+ * </script>
299
+ * </glomex-external-media-item>
300
+ * </glomex-integration>
301
+ * ```
290
302
  */
291
303
  export declare class ExternalMediaItemElement extends HTMLElement implements MediaItemElement {
292
304
  #private;
293
- /**
294
- * {@inheritDoc MediaItem#id}
295
- */
296
- id: string;
297
- /**
298
- * {@inheritDoc MediaSourceBase#src}
299
- */
300
- src: string;
301
- /**
302
- * {@inheritDoc MediaSourceBase#mimetype}
303
- */
304
- mimetype?: MediaSource_2['mimetype'];
305
- /**
306
- * {@inheritDoc MediaSourceBase#playbackMode}
307
- */
308
- playbackMode?: MediaSourceBase['playbackMode'];
309
- /**
310
- * {@inheritDoc MediaItem#duration}
311
- */
312
- duration?: number;
313
- /**
314
- * {@inheritDoc MediaItem#poster}
315
- */
316
- poster: string;
317
- /**
318
- * {@inheritDoc MediaItem#title}
319
- */
320
- title: string;
321
- /**
322
- * {@inheritDoc MediaItem#description}
323
- */
324
- description?: string;
325
- /**
326
- * {@inheritDoc Channel#logo}
327
- */
328
- channelLogo?: string;
329
- /**
330
- * {@inheritDoc Channel#name}
331
- */
332
- channelName?: string;
333
- /**
334
- * {@inheritDoc MediaItem#aspectRatio}
335
- */
336
- aspectRatio?: string;
337
- /**
338
- * {@inheritDoc MediaItem#minimumAge}
339
- */
340
- minimumAge?: number;
341
- /**
342
- * {@inheritDoc MediaItem#releaseDate}
343
- */
344
- releaseDate?: number;
345
- /**
346
- * {@inheritDoc MediaItem#endDate}
347
- */
348
- endDate?: number;
349
- /**
350
- * {@inheritDoc MediaItem#hasProductPlacement}
351
- */
352
- hasProductPlacement?: boolean;
353
- get data(): MediaItem;
305
+ get data(): MediaItem | MediaItem[];
354
306
  }
355
307
 
356
308
  /**
@@ -1370,6 +1322,9 @@ export declare interface MediaItem {
1370
1322
  /**
1371
1323
  * Array of text tracks for subtitles, captions, etc.
1372
1324
  * These tracks apply to the whole media item, not to individual sources.
1325
+ *
1326
+ * Note: This is only useful for progressive sources or when the adaptive stream
1327
+ * (HLS/DASH) does not deliver the text tracks / subtitles within the manifest.
1373
1328
  */
1374
1329
  textTracks?: MediaItemTextTrack[];
1375
1330
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@glomex/integration-web-component",
3
- "version": "1.1497.0",
3
+ "version": "1.1499.0",
4
4
  "description": "Web component and types to integrate the glomex player",
5
5
  "documentation": "https://docs.glomex.com",
6
6
  "homepage": "https://glomex.com",
@@ -32,7 +32,7 @@
32
32
  },
33
33
  "devDependencies": {
34
34
  "@biomejs/biome": "catalog:",
35
- "@glomex/integration": "1.1497.0",
35
+ "@glomex/integration": "1.1499.0",
36
36
  "@microsoft/api-extractor": "catalog:",
37
37
  "@rslib/core": "catalog:",
38
38
  "npm-run-all": "catalog:",
@@ -42,5 +42,5 @@
42
42
  "access": "public"
43
43
  },
44
44
  "license": "MIT",
45
- "gitHead": "a45dcf40b3d6ca0c60676231df283b769b253b20"
45
+ "gitHead": "95888edaf5aecef9a192e803e9eb0452a0da5031"
46
46
  }