@flowplayer/player 3.27.0 → 3.28.0-rc.1

package/plugins/ads.d.ts

@@ -119,6 +119,7 @@ declare interface Adapter {
     contentComplete(): Promise<void>;
     onResize(_obj: ResizeInfo): void;
     isUiDisabled(): boolean;
+    onAdRequestEnd(): void;
     isAdPod(): boolean;
     canDismissNonLinear(): boolean;
     setAdBreakTime: (time: number) => void;
@@ -907,17 +908,6 @@ ERROR = "error";
 
 declare const ERRORED = "is-error";
 
-/**
- * @public
- */
-declare type ErrorEventDetail = {
-    src?: string;
-    type?: string;
-    code?: number | string;
-};
-
-/* Excluded from this release type: _ErrorEventDetail */
-
 declare class EventBus {
     private _bus;
     private _listeners;
@@ -986,7 +976,8 @@ declare namespace events {
         RECOVER,
         CUEPOINTS,
         CUEPOINT_START,
-        CUEPOINT_END
+        CUEPOINT_END,
+        FLOWPLAYER_ERROR
     }
 }
 
@@ -1050,11 +1041,307 @@ declare namespace Flags_2 {
     }
 }
 
+/**
+ * @public
+ *  emitted to handle playback related errors
+ */
+declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ *  emitted to handle playback related errors
+ */
+FLOWPLAYER_ERROR = "flowplayer:error";
+
 /**
  * @public
  */
 declare type FlowplayerCustomElementRegistry = Map<string, string>;
 
+declare class FlowplayerError extends Error {
+    readonly message: string;
+    readonly flowplayerErrorCode: FlowplayerErrorCode;
+    readonly config: FlowplayerErrorConfig;
+    static getErrorKey(code: FlowplayerErrorCode): FlowplayerErrorCodeName;
+    readonly id: string;
+    readonly fatal: boolean;
+    readonly errorKey: string;
+    constructor(message: string, flowplayerErrorCode: FlowplayerErrorCode, config?: FlowplayerErrorConfig);
+    toJSON(): {
+        message: string;
+        flowplayer_error_code: FlowplayerErrorCode;
+        id: string;
+        root_error_id: string | undefined;
+        resource: string | undefined;
+        fatal: boolean;
+    };
+}
+
+declare type FlowplayerErrorCode = (typeof FlowplayerErrorCodeMap)[keyof typeof FlowplayerErrorCodeMap];
+
+declare const FlowplayerErrorCodeMap: {
+    /** Unknown */
+    readonly Unknown: "00-00";
+    /** Media Section */
+    readonly MediaUnknown: "01-00";
+    readonly MediaUnavailable: "01-01";
+    readonly MediaUnsupportedVideoFormat: "01-02";
+    readonly MediaUnsupportedAudioFormat: "01-03";
+    readonly MediaBitrateExceeded: "01-04";
+    readonly MediaBufferOverread: "01-05";
+    readonly MediaIntegerOverflow: "01-06";
+    readonly MediaQuotaExceeded: "01-07";
+    readonly MediaInvalidCompositionDuration: "01-08";
+    readonly MediaInvalidCompositionSourceDuration: "01-09";
+    readonly MediaInvalidCompositionSourceStartTime: "01-10";
+    readonly MediaMalformedDepth: "01-11";
+    /** Playback Section */
+    readonly PlaybackUnknown: "02-00";
+    readonly PlaybackVideoBufferUnderRun: "02-01";
+    readonly PlaybackAudioBufferUnderRun: "02-02";
+    readonly PlaybackVideoBufferingTimeout: "02-03";
+    readonly PlaybackAudioBufferingTimeout: "02-04";
+    readonly PlaybackManifestParseError: "02-05";
+    readonly PlaybackVideoDecodeError: "02-06";
+    readonly PlaybackAudioDecodeError: "02-07";
+    readonly PlaybackDroppedFramesExceeded: "02-08";
+    readonly PlaybackPlayheadExceedsDuration: "02-09";
+    readonly PlaybackUnsupportedDevice: "02-10";
+    readonly PlaybackManifestLoadError: "02-11";
+    readonly PlaybackManifestLoadTimeout: "02-12";
+    readonly PlaybackManifestParsingError: "02-13";
+    readonly PlaybackManifestIncompatibleCodecs: "02-14";
+    readonly PlaybackLevelEmptyError: "02-15";
+    readonly PlaybackLevelLoadError: "02-16";
+    readonly PlaybackLevelLoadTimeout: "02-17";
+    readonly PlaybackLevelSwitchError: "02-18";
+    readonly PlaybackAudioTrackLoadError: "02-19";
+    readonly PlaybackAudioTrackLoadTimeout: "02-20";
+    readonly PlaybackFragLoadError: "02-21";
+    readonly PlaybackFragLoadTimeout: "02-22";
+    readonly PlaybackFragDecryptError: "02-23";
+    readonly PlaybackFragParsingError: "02-24";
+    readonly PlaybackFragGap: "02-25";
+    readonly PlaybackRemuxAllocError: "02-26";
+    readonly PlaybackBufferAddCodecError: "02-27";
+    readonly PlaybackBufferIncompatibleCodecs: "02-28";
+    readonly PlaybackBufferAppendError: "02-29";
+    readonly PlaybackBufferStalledError: "02-30";
+    readonly PlaybackBufferFullError: "02-31";
+    readonly PlaybackBufferSeekOverHole: "02-32";
+    readonly PlaybackBufferNudgeOnStall: "02-33";
+    readonly PlaybackInternalException: "02-34";
+    readonly PlaybackInternalAborted: "02-35";
+    readonly PlaybackManifestLoaderFailure: "02-36";
+    readonly PlaybackSegmentBaseLoaderError: "02-37";
+    readonly PlaybackTimeSyncFailed: "02-38";
+    readonly PlaybackFragmentLoaderFailure: "02-39";
+    readonly PlaybackAppendError: "02-40";
+    readonly PlaybackRemoveError: "02-41";
+    readonly PlaybackDataUpdateFailed: "02-42";
+    readonly PlaybackManifestNoStreams: "02-43";
+    readonly PlaybackUnknownManifestType: "02-44";
+    readonly PlaybackDashInsufficientSegmentInfo: "02-45";
+    readonly PlaybackDashNoRepresentations: "02-46";
+    readonly PlaybackDashNoAdaptationSets: "02-47";
+    readonly PlaybackDashNoInitSegment: "02-48";
+    readonly PlaybackDashUnsupportedContainerFormat: "02-49";
+    readonly PlaybackDashKeySystemMismatch: "02-50";
+    readonly PlaybackMultipleKeyIDs: "02-51";
+    readonly PlaybackDashConflictingKeyIDs: "02-52";
+    readonly PlaybackRestrictedStreams: "02-53";
+    readonly PlaybackHlsMasterAndMediaTags: "02-54";
+    readonly PlaybackRepresentationIdConflict: "02-55";
+    readonly PlaybackHlsUnsupportedKeyFormats: "02-56";
+    readonly PlaybackManifestNoVariants: "02-57";
+    readonly PlaybackHlsUndeclaredVariables: "02-58";
+    readonly PlaybackAes128InvalidKeyLength: "02-59";
+    readonly PlaybackDashConflictingAes128Keys: "02-60";
+    readonly PlaybackDashUnsupportedAes128Encryption: "02-61";
+    readonly PlaybackManifestPatchMismatch: "02-62";
+    readonly PlaybackEmptyMediaPlaylist: "02-63";
+    readonly PlaybackNonContiguousCompositionTrack: "02-64";
+    readonly PlaybackDecoderNotFound: "02-65";
+    readonly PlaybackDecoderTemporarilyUnavailable: "02-66";
+    readonly PlaybackIncompatibleAsset: "02-67";
+    readonly PlaybackNoCompatibleExternalDisplay: "02-69";
+    readonly PlaybackOutOfMemory: "02-70";
+    readonly PlaybackToneMappingFailed: "02-71";
+    readonly PlaybackVideoCompositorFailed: "02-72";
+    /** Network Section */
+    readonly NetworkUnknown: "03-00";
+    readonly NetworkNoInternet: "03-01";
+    readonly NetworkRequestTimeout: "03-02";
+    readonly NetworkUnableToResolveHost: "03-03";
+    readonly NetworkResourceNotFound: "03-04";
+    readonly NetworkExpiredUrl: "03-05";
+    readonly NetworkUrlResolutionFailed: "03-06";
+    readonly NetworkDownloadErrorIdManifest: "03-07";
+    readonly NetworkDownloadErrorIdSidx: "03-08";
+    readonly NetworkDownloadErrorIdContent: "03-09";
+    readonly NetworkDownloadErrorIdInitialization: "03-10";
+    readonly NetworkDownloadErrorIdXlink: "03-11";
+    readonly NetworkHttpRequestFailed: "03-12";
+    readonly NetworkMaxRetriesExceeded: "03-13";
+    readonly NetworkSegmentMissing: "03-14";
+    /** HTTP Error Codes */
+    readonly NetworkHttp400BadRequest: "03-400";
+    readonly NetworkHttp401Unauthorized: "03-401";
+    readonly NetworkHttp402PaymentRequired: "03-402";
+    readonly NetworkHttp403Forbidden: "03-403";
+    readonly NetworkHttp404NotFound: "03-404";
+    readonly NetworkHttp405MethodNotAllowed: "03-405";
+    readonly NetworkHttp406NotAcceptable: "03-406";
+    readonly NetworkHttp407ProxyAuthenticationRequired: "03-407";
+    readonly NetworkHttp408RequestTimeout: "03-408";
+    readonly NetworkHttp409Conflict: "03-409";
+    readonly NetworkHttp410Gone: "03-410";
+    readonly NetworkHttp411LengthRequired: "03-411";
+    readonly NetworkHttp412PreconditionFailed: "03-412";
+    readonly NetworkHttp413PayloadTooLarge: "03-413";
+    readonly NetworkHttp414URITooLong: "03-414";
+    readonly NetworkHttp415UnsupportedMediaType: "03-415";
+    readonly NetworkHttp416RangeNotSatisfiable: "03-416";
+    readonly NetworkHttp417ExpectationFailed: "03-417";
+    readonly NetworkHttp418ImATeapot: "03-418";
+    readonly NetworkHttp421MisdirectedRequest: "03-421";
+    readonly NetworkHttp422UnprocessableEntity: "03-422";
+    readonly NetworkHttp423Locked: "03-423";
+    readonly NetworkHttp424FailedDependency: "03-424";
+    readonly NetworkHttp425TooEarly: "03-425";
+    readonly NetworkHttp426UpgradeRequired: "03-426";
+    readonly NetworkHttp428PreconditionRequired: "03-428";
+    readonly NetworkHttp429TooManyRequests: "03-429";
+    readonly NetworkHttp431RequestHeaderFieldsTooLarge: "03-431";
+    readonly NetworkHttp451UnavailableForLegalReasons: "03-451";
+    readonly NetworkHttp500InternalServerError: "03-500";
+    readonly NetworkHttp501NotImplemented: "03-501";
+    readonly NetworkHttp502BadGateway: "03-502";
+    readonly NetworkHttp503ServiceUnavailable: "03-503";
+    readonly NetworkHttp504GatewayTimeout: "03-504";
+    readonly NetworkHttp505HTTPVersionNotSupported: "03-505";
+    readonly NetworkHttp506VariantAlsoNegotiates: "03-506";
+    readonly NetworkHttp507InsufficientStorage: "03-507";
+    readonly NetworkHttp508LoopDetected: "03-508";
+    readonly NetworkHttp510NotExtended: "03-510";
+    readonly NetworkHttp511NetworkAuthenticationRequired: "03-511";
+    /** Content Protection Section */
+    readonly ContentProtectionUnknown: "04-00";
+    readonly ContentProtectionConcurrentStreamLimitExceeded: "04-01";
+    readonly ContentProtectionEntitlementRefused: "04-02";
+    readonly ContentProtectionLicenseExpired: "04-03";
+    readonly ContentProtectionBadLicenseRequest: "04-04";
+    readonly ContentProtectionLicenseServerTimeout: "04-05";
+    readonly ContentProtectionInsufficientHDCPSupport: "04-06";
+    readonly ContentProtectionGeoRestricted: "04-07";
+    readonly ContentProtectionParentalControlRestricted: "04-08";
+    readonly ContentProtectionCDNUnauthorized: "04-09";
+    readonly ContentProtectionInvalidAccessToken: "04-10";
+    readonly ContentProtectionKeySystemNoKeys: "04-11";
+    readonly ContentProtectionKeySystemNoAccess: "04-12";
+    readonly ContentProtectionKeySystemNoSession: "04-13";
+    readonly ContentProtectionKeySystemNoConfiguredLicense: "04-14";
+    readonly ContentProtectionKeySystemCertificateRequestFailed: "04-15";
+    readonly ContentProtectionKeySystemCertificateUpdateFailed: "04-16";
+    /** Key System: Session update failed */
+    readonly ContentProtectionKeySystemSessionUpdateFailed: "04-17";
+    /** Key System: Status output restricted */
+    readonly ContentProtectionKeySystemStatusOutputRestricted: "04-18";
+    /** Key System: Status internal error */
+    readonly ContentProtectionKeySystemStatusInternalError: "04-19";
+    /** Key Load Error */
+    readonly ContentProtectionKeyLoadError: "04-20";
+    /** Key Load Timeout */
+    readonly ContentProtectionKeyLoadTimeout: "04-21";
+    /** Capability MediaKeys Error */
+    readonly ContentProtectionCapabilityMediaKeysError: "04-22";
+    /** Manifest indicated protected content, but unable to determine key systems */
+    readonly ContentProtectionManifestKeySystemUnknown: "04-23";
+    /**
+     * None of the requested key system configurations are available.
+     * Possible reasons:
+     * - Key system not supported
+     * - Requested features (e.g., persistent state) not supported
+     * - User denied access in prompt
+     * - Key system unavailable in insecure contexts (requires HTTPS)
+     */
+    readonly ContentProtectionKeySystemUnavailable: "04-24";
+    /** Browser found requested key system, but failed to create CDM instance */
+    readonly ContentProtectionCDMCreationFailed: "04-25";
+    /** Browser created CDM instance but failed to attach it to the video */
+    readonly ContentProtectionCDMAttachFailed: "04-26";
+    /** CDM rejected the server certificate (malformed or unsupported format) */
+    readonly ContentProtectionCDMServerCertificateRejected: "04-27";
+    /** CDM refused to create a session for unknown reasons */
+    readonly ContentProtectionCDMSessionCreationFailed: "04-28";
+    /** CDM unable to generate a license request due to malformed or unsupported init data */
+    readonly ContentProtectionCDMLicenseRequestFailed: "04-29";
+    /** License response rejected by the CDM (invalid/malformed response) */
+    readonly ContentProtectionCDMLicenseResponseRejected: "04-30";
+    /** Manifest does not specify DRM info, but content is encrypted */
+    readonly ContentProtectionManifestMissingDRMInfo: "04-31";
+    /** No license server was provided for the key system signaled by the manifest */
+    readonly ContentProtectionLicenseServerMissing: "04-32";
+    /** A required offline session was removed, affecting playback */
+    readonly ContentProtectionOfflineSessionRemoved: "04-33";
+    /** Error while executing init data transformation */
+    readonly ContentProtectionInitDataTransformationError: "04-34";
+    /** Server certificate request failed */
+    readonly ContentProtectionServerCertificateRequestFailed: "04-35";
+    /** HDCP version does not meet the requirements */
+    readonly ContentProtectionInsufficientHDCPVersion: "04-36";
+    /** Error when checking HDCP version */
+    readonly ContentProtectionHDCPVersionCheckFailed: "04-37";
+    /** Ads Section */
+    readonly AdsUnknown: "08-00";
+    readonly AdsVastParseError: "08-100";
+    readonly AdsInvalidVastSchema: "08-101";
+    readonly AdsVastVersionNotSupported: "08-102";
+    readonly AdsUnexpectedAdType: "08-200";
+    readonly AdsCreativeLinearityMismatch: "08-201";
+    readonly AdsCreativeDurationMismatch: "08-202";
+    readonly AdsCreativeSizeMismatch: "08-203";
+    readonly AdsWrapperVastError: "08-300";
+    readonly AdsVastResponseRedirectTimeout: "08-301";
+    readonly AdsWrapperLimitReached: "08-302";
+    readonly AdsVastResponseEmpty: "08-303";
+    readonly AdsLinearAdDisplayError: "08-400";
+    readonly AdsMediaFileNotFound: "08-401";
+    readonly AdsMediaFileUnavailable: "08-402";
+    readonly AdsUnsupportedMimeType: "08-403";
+    readonly AdsUnableToDisplayMediaFile: "08-405";
+    readonly AdsMezzanineFileMissing: "08-406";
+    readonly AdsMezzanineFileDownloaded: "08-407";
+    readonly AdsRejectedAd: "08-408";
+    readonly AdsInteractiveCreativeError: "08-409";
+    readonly AdsVerificationNodeExecutionError: "08-410";
+    readonly AdsNonLinearAdDisplayError: "08-500";
+    readonly AdsNonLinearAdSizeMismatch: "08-501";
+    readonly AdsNonLinearAdFetchError: "08-502";
+    readonly AdsNonLinearUnsupportedType: "08-503";
+    readonly AdsCompanionAdDisplayError: "08-600";
+    readonly AdsCompanionAdSizeMismatch: "08-601";
+    readonly AdsRequiredCompanionAdError: "08-602";
+    readonly AdsCompanionAdFetchError: "08-603";
+    readonly AdsUndefinedVastError: "08-900";
+    readonly AdsUnknownVpaidError: "08-901";
+    readonly AdsVastDocumentEmpty: "08-999";
+};
+
+declare type FlowplayerErrorCodeName = keyof typeof FlowplayerErrorCodeMap;
+
+declare type FlowplayerErrorConfig = Partial<{
+    fatal: boolean;
+    resource: string;
+    rootErrorId: string;
+    preventRetry: boolean;
+}>;
+
+declare type FlowplayerErrorEventDetail = {
+    error: FlowplayerError;
+};
+
 /**
  * @public
  */
@@ -2521,6 +2808,7 @@ declare class IMA implements Adapter {
     private videoTag;
     private customPlaybackEnabled;
     private _paused;
+    private loadingController;
     private _all_ads_completed;
     private google;
     private _isInitialized;
@@ -2559,7 +2847,7 @@ declare class IMA implements Adapter {
      */
     waitForAdsManager(): Promise<unknown>;
     initAd(adTag: string, timeout?: number): Promise<void>;
-    requestAd(adTag: string, timeout: number): Promise<unknown>;
+    requestAd(adTag: string, timeout: number): Promise<any>;
     playAd(): Promise<void>;
     /**
      * returns a Promise of a completed Ad
@@ -2569,6 +2857,7 @@ declare class IMA implements Adapter {
     resume(): void;
     volume(level?: number): number | undefined;
     onResize({ width, height, linear, silent, resize_non_linear }: ResizeInfo): void;
+    onAdRequestEnd(): void;
     getAdInfo(): {
         duration: number;
         currentTime: number;
@@ -2667,6 +2956,7 @@ declare type IMAOpts = {
     autoplay: boolean;
     disable_non_linear_ads: boolean;
     media_timeout: number;
+    total_loading_timeout: number;
 };
 
 declare const IN_VIEWPORT = "is-in-viewport";
@@ -3117,6 +3407,7 @@ declare type PlayerCustomEventsDetailMap = PlayerEmittableCustomEventsDetailMap
     [RECOVER]: RecoverEventDetail;
     [QUALITIES]: QualitiesEventDetail;
     [QUALITY_CHANGE]: QualityChangeEventDetail;
+    [FLOWPLAYER_ERROR]: FlowplayerErrorEventDetail;
     /* Excluded from this release type: audioonlysource */
     /* Excluded from this release type: renderplugin */
     /* Excluded from this release type: "seek:queued" */
@@ -3138,7 +3429,6 @@ declare type PlayerCustomEventsOverloads = {
     /**
      * Sent when an error occurs. Learn more about error handling.
      */
-    on(event: typeof ERROR, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof ERROR]>) => void): Player;
     on(// FIXME - this event is in context-menu plugin
     event: typeof CONTEXT_MENU, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof CONTEXT_MENU]>) => void): Player;
     /* Excluded from this release type: on */
@@ -3177,6 +3467,10 @@ declare type PlayerCustomEventsOverloads = {
      * Emitted when the media changes quality.
      */
     on(event: typeof QUALITY_CHANGE, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof QUALITY_CHANGE]>) => void): Player;
+    /**
+     * Emitted when a standard FlowplayerError is encountered
+     */
+    on(event: typeof FLOWPLAYER_ERROR, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof FLOWPLAYER_ERROR]>) => void): Player;
     /* Excluded from this release type: on */
     /**
      * Listen to this event to create a recommendations grid using the data passed with the event.
@@ -3229,12 +3523,9 @@ declare type PlayerCustomEventsOverloads = {
     emit(event: never, data?: never): Player;
     /* Excluded from this release type: emit */
     /* Excluded from this release type: emit */
-    /* Excluded from this release type: emit */
-    /* Excluded from this release type: emit */
 };
 
 declare type PlayerEmittableCustomEventsDetailMap = {
-    [ERROR]: ErrorEventDetail;
     [CONTEXT_MENU]: ContextMenuEventDetail;
     [VIEW_ENTER]: ViewEnterEventDetail;
     [VIEW_LEAVE]: ViewLeaveEventDetail;
@@ -3259,6 +3550,10 @@ export declare type PlayerIMAConfig = {
      * Defines how long to wait for ad response from the network in milliseconds. Default value is 5000.
      */
     timeout?: number;
+    /**
+     * Defines how long to wait for both the ad response and the loading of the video ad in milliseconds. Default value is undefined.
+     */
+    total_loading_timeout?: number;
     /**
      * Shows all ad breaks between current time and new seek position when the viewer seeks ahead in the timeline. Default value is true.
      */
@@ -3268,7 +3563,7 @@ export declare type PlayerIMAConfig = {
      */
     ads: TimeBasedAd[];
     /**
-     * Sets the locale. This is proxied to to the {@link https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/js/google.ima.ImaSdkSettings#setLocale|setLocale()} method
+     * Sets the locale. This is proxied to the {@link https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/js/google.ima.ImaSdkSettings#setLocale|setLocale()} method
      */
     Locale?: string;
     /**
@@ -3283,7 +3578,7 @@ export declare type PlayerIMAConfig = {
 
 declare type PlayerNativeEventName = keyof PlayerNativeEventsDetailMap;
 
-declare type PlayerNativeEventsDetailMap = Omit<HTMLVideoElementEventMap, "error">;
+declare type PlayerNativeEventsDetailMap = HTMLVideoElementEventMap;
 
 declare type PlayerNativeEventsOverloads = {
     on<K extends keyof PlayerNativeEventsDetailMap>(event: K, handler: (ev: PlayerNativeEventsDetailMap[K]) => void): Player;