@npo/player 1.10.0 → 1.10.1

package/lib/js/playeractions/handlers/processplayerconfig.d.ts

@@ -1,11 +1,3 @@
-/**
- * @function processPlayerConfig
- * @description This function is called by the NpoPlayer constructor to enrich the player configuration object
- * with default values where none were set by the user.
- * @param {NpoPlayer} npoplayer - The NpoPlayer instance
- * @param {PlayerConfig} playerConfig - The player configuration object that was created by the user
- * @returns The processed player configuration object
- */
 import { type PlayerConfig } from "bitmovin-player";
 import NpoPlayer from "npoplayer";
 export declare function processPlayerConfig(npoplayer: NpoPlayer, playerConfig: PlayerConfig): PlayerConfig;

package/lib/js/tracking/handlers/eventbinding.d.ts

@@ -1,10 +1,3 @@
 import { type PlayerAPI } from 'bitmovin-player';
 import type NpoPlayer from '../../../npoplayer';
-/**
-* @function bindPlayerEvents
-* @description Binds the player events to the event logging function.
-* @param {NpoPlayer} npoplayer - The NpoPlayer instance.
-* @param {PlayerAPI} player - The Bitmovin player instance.
-* @returns {void}
-*/
 export declare function bindPlayerEvents(npoplayer: NpoPlayer, player: PlayerAPI): void;

package/lib/js/tracking/handlers/eventlogging.d.ts

@@ -1,11 +1,2 @@
-/**
-* @function logEvent
-* @description Logs an event to the NPO Tag StreamTracker
-* @param {Object} npoplayer - The NpoPlayer instance
-* @param {string} event - The event name
-* @param {Object} data - The event data, this is optional and currently only used for seek events,
-* because the tag SDK does not export SeekEventProps as a type the type for data is set to any.
-* @returns {void}
-*/
 import NpoPlayer from "../../../npoplayer";
 export declare function logEvent(npoplayer: NpoPlayer, event: string, data?: any): void;

package/lib/js/tracking/handlers/playertrackerinit.d.ts

@@ -1,13 +1,4 @@
 import { type NPOTag } from '@npotag/tag';
 import { type InitialisationProps } from '@npotag/tag/dist/types/src/npoTag';
 import type NpoPlayer from '../../../npoplayer';
-/**
-* @function initPlayerTracker
-* @description: This function initializes the NPO Tag instance and page tracker.
-* The page tracker is a required prerequisite for the stream tracker to function.
-* @param {NpoPlayer} npoplayer - The NpoPlayer instance.
-* @param {InitialisationProps | null} _npotag - The NPO Tag instance.
-* @param {NPOTag} _npotaginstance - The NPO Tag instance.
-* @returns {void}
-*/
 export declare function initPlayerTracker(npoplayer: NpoPlayer, _npotag?: InitialisationProps | null, _npotaginstance?: NPOTag): void;

package/lib/js/tracking/handlers/playertrackerstart.d.ts

@@ -1,8 +1 @@
-/**
-* @function startPlayerTracker
-* @description This function creates a new StreamTracker instance and binds the player events to it.
-* @param {Object} playerInstance - The NpoPlayer instance
-* @param {number} duration - The duration of the stream in seconds
-* @returns {void}
-*/
 export declare function startPlayerTracker(playerInstance: any, duration: number, version: string): void;

package/lib/js/ui/components/ctabar.d.ts

@@ -4,6 +4,6 @@ import { type PlayerAPI } from 'bitmovin-player';
 import { ButtonConfig } from 'bitmovin-player-ui/dist/js/framework/components/button';
 import { LabelConfig } from 'bitmovin-player-ui/dist/js/framework/components/label';
 export declare function createCTABar(player: PlayerAPI | null, npoplayer: NpoPlayer, variant: string): Container<{
-    components: (Button<ButtonConfig> | Label<LabelConfig>)[];
+    components: (Label<LabelConfig> | Button<ButtonConfig>)[];
     cssClasses: string[];
 }>;

package/lib/js/utilities/utilities.d.ts

@@ -1,60 +1,10 @@
 import { type LocalizableText } from 'bitmovin-player-ui/dist/js/framework/localization/i18n';
-/**
- * @function jwtToBase64
- * @description Converts a JWT string to a base64 encoded string.
- * @param {string} jwt - The JWT string to convert.
- * @returns {string} The converted base64 string.
- */
 export declare const jwtToBase64: (jwt: string) => string;
-/**
- * @function base64ToObject
- * @description Converts a base64 encoded JWT string to a JSON object.
- * @param {string} base64 - The base64 string to convert.
- * @returns {Object} The converted JSON object.
- */
 export declare const base64ToObject: (base64: string) => any;
-/**
- * @function noTrailingSlash
- * @description Removes the trailing slash from the provided url if it exists.
- * @param {string} url - The url to remove the trailing slash from.
- * @returns {string} The url without the trailing slash.
- */
 export declare const noTrailingSlash: (url: string) => string;
-/**
- * @function localize
- * @description Returns the localized text for the provided key.
- * @param {key} key - The key of the text to localize.
- * @returns {LocalizableText} The localized text.
- */
 export declare function localize(key: string): LocalizableText;
-/**
- * @function validateStreamLength
- * @description Validates the provided stream duration and converts it to seconds.
- * If the duration is null, returns -1.
- * @param {string|number} duration - The stream duration to validate, can be either a string or a number.
- * @returns {number} The duration in seconds or -1 if the duration is null.
- */
 export declare function validateStreamLength(duration: string | number | undefined): number;
-/**
- * @function msToSeconds
- * @description Converts milliseconds to seconds.
- * @param {number} ms - The milliseconds to convert.
- * @returns {number} The converted milliseconds.
- */
 export declare function msToSeconds(ms: number): number;
-/**
-* @function validatePrid
-* @description Validates the provided prid. If the prid is null or empty, returns 'unknown'.
-* @param {string|null} prid - The prid to validate.
-* @returns {string} The validated prid or 'unknown' if the prid is null or empty.
-*/
 export declare function validatePrid(prid: string | null): string;
-/**
- * @function getModuleExport
- * @description Returns the default export of a module if it exists, otherwise returns the module itself.
- * This is used to support both ES6 and CommonJS modules.
- * @param {unkown} module - The module to get the export from.
- * @returns {unknown} module - The multicompatible module export.
- */
 export declare function getModuleExport(module: unknown): unknown;
 export declare function airPlaySupported(): boolean;