@kinescope/player-iframe-api-loader

Kinescope Player Iframe API Loader

A simple loader of JavaScript files (Iframe API) and TypeScript types who uses Kinescope Player Iframe API.

Installation

npm install --save @kinescope/player-iframe-api-loader
# or
yarn add @kinescope/player-iframe-api-loader

Features

The loader replaces standard way of loading and usage Iframe API such as onKinescopeIframeAPIReady callback.

Also the library contains TypeScript type definitions. It is possible to use only TypeScript types without loader.

Example:

import * as iframeApiLoader from '@kinescope/player-iframe-api-loader';

// Load the latest stable version.
const factory = await iframeApiLoader.load();
// Create the player. Look at the docs, the link below.
const player = await factory.create(...);

Using only types:

import '@kinescope/player-iframe-api-loader/types';

let player: Kinescope.IframePlayer.Player | undefined;

const factory = window.Kinescope?.IframePlayer;
if (factory) {
  player = await factory.create(...);
}

Player embedding docs

Changelog

0.2.0 (2025-05-14)

Features

• Update types (b0b53e2)
• Update types (9cb2482)

Bug Fixes

• Typo in cta (83b5905)

Miscellaneous Chores

• Update configs (572fb57)
• Update deps (02fd267)
• Update deps (08bff5a)
• Update deps (fab4490)
• Update deps (0f8c577)
• Update deps (c2dd382)

Code Refactoring

• load (3e3dfc0)
• Update types (23b96f4)