Kinescope

About Kinescope Video Service

Kinescope is a video hosting and streaming platform for businesses and content creators. It provides tools for uploading, managing, and embedding videos with analytics and customization, plus high-quality playback and secure delivery.

For more information, visit the Kinescope website.

About this module

This project integrates Kinescope into Drupal 10 and 11. It is split into four modules; enable only what you need:

• Kinescope — API client, settings form, and API token configuration. No Media dependency.
• Kinescope Player — Kinescope field type, widget, default formatter, and player renderer (iframe, IFrame API, or Web Components).
• Kinescope Media (optional) — media source plugin, Media Library add-form, title/poster/metadata from the API, and Drupal core oEmbed provider registration. Requires core Media.
• Kinescope Popup (optional) — formatter that opens the player in an AJAX modal dialog.

Minimum for embedding: enable Kinescope and Kinescope Player.

Installation

Install as any other contributed module. Recommended:

composer require drupal/kinescope

Then enable the submodules you need under Extend. For detailed steps, see Installing modules.

Settings

Configuration lives at Configuration → Media → Kinescope settings (/admin/config/media/kinescope). Permission: administer kinescope settings.

1. Go to Configuration → Media → Kinescope settings.
2. Optionally enter a Kinescope API token (UUID from the Kinescope Dashboard under Settings → API tokens).
3. Choose the global embed method: simple iframe (default), IFrame API, or Web Components (experimental).
4. Save. An invalid token produces an error. Leaving the token empty is valid.

Tokenless (default): embed and poster URLs are built from the video ID. No API calls; no title or metadata from Kinescope.

Token-authorized: the module calls the Kinescope API for title, status, description, subtitles, duration, and poster URL. Media names are filled from the API title when using Kinescope Media.

You can override the token in settings.php with $settings['kinescope.api_token']. The token field is then disabled in the UI. Token status also appears on Reports → Status report.

Usage: Kinescope field (no Media)

1. Enable Kinescope and Kinescope Player.
2. Add a Kinescope field to a content type, paragraph, block, or other entity (Structure → Content types → Manage fields).
3. On the content form, paste an HTTPS Kinescope URL, for example https://kinescope.io/{video_id}.

Field setting Allow editors to override player settings per video (checked by default) shows responsive/width/height/allow-list on the content form. Unchecked: one set of defaults applies to every value in that field.

Usage: Media Library

Enabling the modules does not create a media type. You add it once:

1. Enable Kinescope, Kinescope Player, and Kinescope Media.
2. Go to Structure → Media types → Add media type, name it (for example Kinescope), and set the source to Kinescope.
3. Add and manage videos under Media (URL field with the same validation as the Kinescope widget).
4. On a content type, add a Media field and allow that media type.

Usage: oEmbed (Remote video)

Kinescope is not listed in the public oEmbed provider database. Enabling Kinescope Media registers it with Drupal core oEmbed:

• Provider name: Kinescope
• Endpoint: https://kinescope.io/oembed?url={video_url}
• URLs: https://kinescope.io/{video_id} and https://kinescope.io/embed/{video_id}

This adds Kinescope to the core Remote video source and provides a dedicated Kinescope oEmbed media source.

1. Enable Kinescope Media and rebuild caches.
2. For an existing Remote video media type, edit it under Structure → Media types and include Kinescope in the allowed providers. Or add a media type that uses Kinescope oEmbed.
3. Paste a Kinescope URL into the Remote video / oEmbed field.

oEmbed playback uses the core sandboxed media/oembed iframe. It does not use the Kinescope IFrame API or Web Components. For the full player, DRM, and popup, use the Kinescope field or the Kinescope media source.

Usage: popup player

1. Enable Kinescope Popup (works with the Kinescope field and with Media).
2. On Manage display, set the formatter to Kinescope popup.
3. Configure link text (poster with play overlay, or plain text).