@glomex/integration-web-component 1.1414.2 → 1.1417.0

package/dist/index.d.ts

@@ -10,8 +10,21 @@ export declare interface Ad {
     breakName: string;
     mimetype: string;
     totalAds: number;
+    adUrl?: string;
     nonLinearWidth?: number;
     nonLinearHeight?: number;
+    title?: string;
+    advertiserName?: string;
+    width?: number;
+    height?: number;
+    adSystem?: string;
+    universalAdIds?: {
+        id: string;
+        registry: string;
+    }[];
+    creativeId?: string;
+    skippable: boolean;
+    clickThroughUrl?: string;
 }
 
 export declare const ALLOWED_UI_ACTIONS: readonly ["play", "pause", "openEpg"];
@@ -123,7 +136,7 @@ export declare interface Consent {
  * Selected source of the given content.
  */
 export declare interface ContentSource {
-    id: string;
+    id?: string;
     mimetype: Mimetype;
     src: string;
     playbackMode: PlaybackMode;
@@ -159,6 +172,16 @@ declare interface ExperimentVariant {
     contentOverride: Record<string, unknown>;
 }
 
+export declare interface ExtendedVideoPlaybackQuality extends VideoPlaybackQuality {
+    bitrate: number;
+    liveLatency: number;
+    throughput: number;
+    bytes: number;
+    bandwidth: number;
+    width: number;
+    height: number;
+}
+
 export declare const EXTERNAL_PLAYER_NAME = "turbo-player";
 
 /**
@@ -294,6 +317,10 @@ export declare interface ExtraContext {
      * The version of the app. When it is a website, fill in the deployed version of the website.
      */
     appVersion?: string;
+    /**
+     * The name of the app. When it is a website, fill in the name of the project.
+     */
+    appName?: string;
     userIds?: ExtraContextUserId[];
     /**
      * The bundle id of the app. Only required for iOS apps.
@@ -498,6 +525,26 @@ export declare class IntegrationElement extends HTMLElement implements Integrati
      * Snapshots current video frame. Requires {@link crossorigin} to be set to `anonymous`.
      */
     getCurrentVideoFrame(): Promise<ImageBitmap>;
+    /**
+     * Returns the current playback time (in seconds) of the media.
+     */
+    get currentTime(): number;
+    /**
+     * Returns the current extended playback quality.
+     */
+    getVideoPlaybackQuality(): {
+        droppedVideoFrames: number;
+        totalVideoFrames: number;
+        creationTime: number;
+        corruptedVideoFrames: number;
+        bitrate: number;
+        liveLatency: number;
+        throughput: number;
+        bytes: number;
+        bandwidth: number;
+        width: number;
+        height: number;
+    } | undefined;
     /**
      * Returns the current session ID.
      */
@@ -506,10 +553,6 @@ export declare class IntegrationElement extends HTMLElement implements Integrati
      * Returns the current wall clock time (UNIX timestamp in seconds). Useful for livestreams.
      */
     get wallClockTime(): number;
-    /**
-     * Returns the current playback time (in seconds) of the media.
-     */
-    get currentTime(): number;
     /**
      * Seeks the media to the specified time, updating the current playback time.
      * @param time - The time (in seconds) to seek to.
@@ -583,7 +626,11 @@ export declare class IntegrationElement extends HTMLElement implements Integrati
      */
     get content(): MediaItem | undefined;
     /**
-     * Retrieves the current playlist content items.
+     * Retrieves the currently selected source.
+     */
+    get source(): ContentSource | undefined;
+    /**
+     * Retrieves the current playlist.
      */
     get playlist(): MediaItem[] | undefined;
     /**
@@ -772,6 +819,11 @@ export declare interface IntegrationElementEventMap {
      * @eventProperty
      */
     [IntegrationEvent.CONTENT_ENDED]: CustomEvent<void> | HTMLElementEventMap['ended'];
+    /**
+     * @inheritdoc IntegrationEvent.AD_LOADED
+     * @eventProperty
+     */
+    [IntegrationEvent.AD_LOADED]: CustomEvent<void>;
     /**
      * @inheritdoc IntegrationEvent.AD_IMPRESSION
      * @eventProperty
@@ -954,6 +1006,12 @@ export declare enum IntegrationEvent {
      * @eventProperty
      */
     CONTENT_ENDED = "ended",
+    /**
+     * When an ad is loaded.
+     * See {@link IntegrationElement#currentAd} to get the loaded ad.
+     * @eventProperty
+     */
+    AD_LOADED = "adloaded",
     /**
      * When the first frame of the ad got played back.
      * See {@link IntegrationElement#currentAd} to get the current ad.
@@ -1510,6 +1568,14 @@ export declare interface MediaSourceJoyn {
      * Allowing to enforce stage environment
      */
     environment?: 'stg';
+    /**
+     * Distribution tenant name, could be JOYN, JOYN_AT, JOYN_CH
+     */
+    distributionTenant?: string;
+    /**
+     * User ID
+     */
+    userId?: string;
     /**
      * Shall the source be observed independent of business model?
      */

package/dist/index.js

@@ -1 +1 @@
-(r=R||(R={})).DEFAULT="turbo-integration",r.SCRIPT="turbo-script",r.IFRAME="turbo-iframe",r.FULLPAGE="turbo-fullpage",r.AMP_VIDEO_IFRAME="turbo-amp-video-iframe",r.AMP_IFRAME="turbo-amp-iframe",(T=m||(m={})).INTEGRATION="glomex-integration",T.EXTERNAL_MEDIA_ITEM="glomex-external-media-item",T.GLOMEX_MEDIA_ITEM="glomex-media-item",(_=C||(C={})).INTEGRATION_CONFIGS="application/glomex-integration-configs+json",_.EXTERNAL_MEDIA_ITEM="application/glomex-external-media-item+json";let e="turbo-player";(N=L||(L={})).HIDDEN="hidden",N.INLINE="inline",N.DOCK="dock",N.LIGHTBOX="lightbox",N.LIGHTBOX_EXTERNAL="lightbox-external",N.FULLSCREEN="fullscreen",N.AMP_DOCK="amp-dock",(I=u||(u={})).READY="ready",I.INTEGRATION_ABORT="integrationabort",I.INTEGRATION_AD_AVAILABLE="integrationadavailable",I.INTEGRATION_PASSBACK="integrationpassback",I.USER_UPDATE_CONSENT="userupdateconsent",I.PLAYLIST_UPDATE="playlistupdate",I.PLAYER_SET_PRESENTATION_MODE="playersetpresentationmode",I.CONTENT_SELECT="contentselect",I.CONTENT_START="contentstart",I.CONTENT_IMPRESSION="contentimpression",I.CONTENT_BUFFERING_START="contentbufferingstart",I.CONTENT_BUFFERING_END="contentbufferingend",I.CONTENT_STOP="contentstop",I.CONTENT_ERROR="contenterror",I.CONTENT_MARKER_REACHED="contentmarkerreached",I.CONTENT_TIME_UPDATE="timeupdate",I.CONTENT_SEEKING="seeking",I.CONTENT_SEEKED="seeked",I.CONTENT_PLAY="play",I.CONTENT_PAUSE="pause",I.CONTENT_VOLUME_CHANGE="volumechange",I.CONTENT_ENDED="ended",I.AD_IMPRESSION="adimpression",I.AD_BUFFERING_START="adbufferingstart",I.AD_BUFFERING_END="adbufferingend",I.AD_TIME_UPDATE="adtimeupdate",I.AD_VOLUME_CHANGE="advolumechange",I.AD_PAUSED="adpaused",I.AD_RESUMED="adresumed",I.AD_CLICK="adclick",I.AD_SKIPPED="adskipped",I.AD_COMPLETE="adcomplete",I.UI_INTERACTION="uiinteraction",(l=S||(S={})).TIME_IN_SECONDS="time",l.PERCENT="percent",l.TIME_IN_SECONDS_RECURRING="timeRecurring",(s=P||(P={})).PREROLL="preroll",s.MIDROLL="midroll",s.POSTROLL="postroll",s.FIRST_QUARTILE="contentFirstQuartile",s.MIDPOINT="contentMidpoint",s.THIRD_QUARTILE="contentThirdQuartile",s.COMPLETE="contentComplete",s.STILL_INTERESTING="stillInteresting",s.REQUEST_RECOMMENDATIONS="requestRecommendations",(p=D||(D={})).NOT_FOUND="NotFound",p.NOT_AVAILABLE="NotAvailable",p.GEOBLOCKED="Geoblocked",p.YOUTH_PROTECTED="YouthProtected",p.TERMINATED="Terminated",p.GENERIC="Generic",(c=M||(M={})).HLS="application/vnd.apple.mpegurl",c.HLS_LEGACY="application/x-mpegURL",c.DASH="application/dash+xml",c.MP4="video/mp4",c.OGG="video/ogg",c.WEBM="video/webm",c.MP3="audio/mp3",c.AAC="audio/aac",c.WAV="audio/wav",c.OGG_AUDIO="audio/ogg",c.MPEG_AUDIO="audio/mpeg",c.DYNAMIC_CONTENT="application/x-turbo-dynamic-content",c.JOYN="application/x-joyn-source",(A=g||(g={})).LIVE="live",A.VOD="vod",A.INTERACTIVE="interactive",A.EMBED="embed",(d=U||(U={})).PRE_CLICK="pre-click-to-play",d.CLICK="click-to-play",d.AUTOPLAY_SCROLL="autoplay-scroll",d.AUTOPLAY_SCROLL_OUT="autoplay-scroll-out",d.CLICK_NEXT="click-to-play-next",d.CLICK_REPLAY="click-to-play-replay",d.AUTOPLAY_NEXT="autoplay-next",(O=y||(y={})).CLEAR_PLAYLIST="clearPlaylist",O.SELECT_PLAYLIST_ITEM="selectPlaylistItem",O.ENDED="ended",O.CONTENT_ERROR="contentError",O.API_STOP="apiStop",O.LIVESTREAM_STOP="livestreamStop",O.PAGE_HIDE="pageHide";let t=["play","pause","openEpg"],n="player.glomex.com",a=`https://${n}/integration/1/integration.js`;function o(e){return`https://${n}/variant/${e}/variant.css`}function E(){if(window.customElements.get(m.INTEGRATION))return;let e=document.createElement("script");e.innerText=`import('${a}');`,e.type="module",(document.head||document.body).appendChild(e)}function i(e){if(document.querySelector(`link[href="${o(e)}"]`))return;let t=document.createElement("link");t.rel="stylesheet",t.href=o(e),(document.head||document.body).appendChild(t)}var r,T,_,N,I,l,s,p,c,A,d,O,R,m,C,L,u,S,P,D,M,g,U,y,G="turbo",b="glomex";export{t as ALLOWED_UI_ACTIONS,m as ComponentName,y as ContentStopReason,e as EXTERNAL_PLAYER_NAME,u as IntegrationEvent,P as KnownMarkerName,S as MarkerType,D as MediaItemErrorCode,M as Mimetype,R as Origin,g as PlaybackMode,L as PresentationMode,C as ScriptType,U as StartMethod,o as getIntegrationCssUrl,E as loadIntegrationComponent,i as loadIntegrationStyles,G as INTERNAL_PREFIX,b as PUBLIC_PREFIX};
+(r=R||(R={})).DEFAULT="turbo-integration",r.SCRIPT="turbo-script",r.IFRAME="turbo-iframe",r.FULLPAGE="turbo-fullpage",r.AMP_VIDEO_IFRAME="turbo-amp-video-iframe",r.AMP_IFRAME="turbo-amp-iframe",(T=m||(m={})).INTEGRATION="glomex-integration",T.EXTERNAL_MEDIA_ITEM="glomex-external-media-item",T.GLOMEX_MEDIA_ITEM="glomex-media-item",(_=C||(C={})).INTEGRATION_CONFIGS="application/glomex-integration-configs+json",_.EXTERNAL_MEDIA_ITEM="application/glomex-external-media-item+json";let e="turbo-player";(N=L||(L={})).HIDDEN="hidden",N.INLINE="inline",N.DOCK="dock",N.LIGHTBOX="lightbox",N.LIGHTBOX_EXTERNAL="lightbox-external",N.FULLSCREEN="fullscreen",N.AMP_DOCK="amp-dock",(I=u||(u={})).READY="ready",I.INTEGRATION_ABORT="integrationabort",I.INTEGRATION_AD_AVAILABLE="integrationadavailable",I.INTEGRATION_PASSBACK="integrationpassback",I.USER_UPDATE_CONSENT="userupdateconsent",I.PLAYLIST_UPDATE="playlistupdate",I.PLAYER_SET_PRESENTATION_MODE="playersetpresentationmode",I.CONTENT_SELECT="contentselect",I.CONTENT_START="contentstart",I.CONTENT_IMPRESSION="contentimpression",I.CONTENT_BUFFERING_START="contentbufferingstart",I.CONTENT_BUFFERING_END="contentbufferingend",I.CONTENT_STOP="contentstop",I.CONTENT_ERROR="contenterror",I.CONTENT_MARKER_REACHED="contentmarkerreached",I.CONTENT_TIME_UPDATE="timeupdate",I.CONTENT_SEEKING="seeking",I.CONTENT_SEEKED="seeked",I.CONTENT_PLAY="play",I.CONTENT_PAUSE="pause",I.CONTENT_VOLUME_CHANGE="volumechange",I.CONTENT_ENDED="ended",I.AD_LOADED="adloaded",I.AD_IMPRESSION="adimpression",I.AD_BUFFERING_START="adbufferingstart",I.AD_BUFFERING_END="adbufferingend",I.AD_TIME_UPDATE="adtimeupdate",I.AD_VOLUME_CHANGE="advolumechange",I.AD_PAUSED="adpaused",I.AD_RESUMED="adresumed",I.AD_CLICK="adclick",I.AD_SKIPPED="adskipped",I.AD_COMPLETE="adcomplete",I.UI_INTERACTION="uiinteraction",(l=D||(D={})).TIME_IN_SECONDS="time",l.PERCENT="percent",l.TIME_IN_SECONDS_RECURRING="timeRecurring",(s=S||(S={})).PREROLL="preroll",s.MIDROLL="midroll",s.POSTROLL="postroll",s.FIRST_QUARTILE="contentFirstQuartile",s.MIDPOINT="contentMidpoint",s.THIRD_QUARTILE="contentThirdQuartile",s.COMPLETE="contentComplete",s.STILL_INTERESTING="stillInteresting",s.REQUEST_RECOMMENDATIONS="requestRecommendations",(A=P||(P={})).NOT_FOUND="NotFound",A.NOT_AVAILABLE="NotAvailable",A.GEOBLOCKED="Geoblocked",A.YOUTH_PROTECTED="YouthProtected",A.TERMINATED="Terminated",A.GENERIC="Generic",(p=M||(M={})).HLS="application/vnd.apple.mpegurl",p.HLS_LEGACY="application/x-mpegURL",p.DASH="application/dash+xml",p.MP4="video/mp4",p.OGG="video/ogg",p.WEBM="video/webm",p.MP3="audio/mp3",p.AAC="audio/aac",p.WAV="audio/wav",p.OGG_AUDIO="audio/ogg",p.MPEG_AUDIO="audio/mpeg",p.DYNAMIC_CONTENT="application/x-turbo-dynamic-content",p.JOYN="application/x-joyn-source",(c=g||(g={})).LIVE="live",c.VOD="vod",c.INTERACTIVE="interactive",c.EMBED="embed",(d=U||(U={})).PRE_CLICK="pre-click-to-play",d.CLICK="click-to-play",d.AUTOPLAY_SCROLL="autoplay-scroll",d.AUTOPLAY_SCROLL_OUT="autoplay-scroll-out",d.CLICK_NEXT="click-to-play-next",d.CLICK_REPLAY="click-to-play-replay",d.AUTOPLAY_NEXT="autoplay-next",(O=y||(y={})).CLEAR_PLAYLIST="clearPlaylist",O.SELECT_PLAYLIST_ITEM="selectPlaylistItem",O.ENDED="ended",O.CONTENT_ERROR="contentError",O.API_STOP="apiStop",O.LIVESTREAM_STOP="livestreamStop",O.PAGE_HIDE="pageHide";let t=["play","pause","openEpg"],n="player.glomex.com",a=`https://${n}/integration/1/integration.js`;function o(e){return`https://${n}/variant/${e}/variant.css`}function E(){if(window.customElements.get(m.INTEGRATION))return;let e=document.createElement("script");e.innerText=`import('${a}');`,e.type="module",(document.head||document.body).appendChild(e)}function i(e){if(document.querySelector(`link[href="${o(e)}"]`))return;let t=document.createElement("link");t.rel="stylesheet",t.href=o(e),(document.head||document.body).appendChild(t)}var r,T,_,N,I,l,s,A,p,c,d,O,R,m,C,L,u,D,S,P,M,g,U,y,G="turbo",b="glomex";export{t as ALLOWED_UI_ACTIONS,m as ComponentName,y as ContentStopReason,e as EXTERNAL_PLAYER_NAME,u as IntegrationEvent,S as KnownMarkerName,D as MarkerType,P as MediaItemErrorCode,M as Mimetype,R as Origin,g as PlaybackMode,L as PresentationMode,C as ScriptType,U as StartMethod,o as getIntegrationCssUrl,E as loadIntegrationComponent,i as loadIntegrationStyles,G as INTERNAL_PREFIX,b as PUBLIC_PREFIX};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@glomex/integration-web-component",
-  "version": "1.1414.2",
+  "version": "1.1417.0",
   "description": "Web component and types to integrate the glomex player",
   "documentation": "https://docs.glomex.com",
   "homepage": "https://glomex.com",
@@ -31,7 +31,7 @@
     "watch": "npm-run-all --parallel \"build:* -- --watch\""
   },
   "devDependencies": {
-    "@glomex/integration": "^1.1414.2",
+    "@glomex/integration": "^1.1417.0",
     "@microsoft/api-extractor": "^7.52.13",
     "@rslib/core": "^0.13.3"
   },
@@ -39,5 +39,5 @@
     "access": "public"
   },
   "license": "MIT",
-  "gitHead": "6752976906fd37a6bc49a8214c08369f328f6aca"
+  "gitHead": "0d2cbc8aff882171f6cc6eca5aea5ea44b369d8f"
 }