Developers
PricingSign in
Request a Demo
Developers

Inkrypt Videos for developers: Secure video, in your stack.

Inkrypt Videos gives developers a one-time-password playback API with a dynamic watermark, a JavaScript player API, upload APIs, a WordPress plugin and SDKs for Android, iOS, React Native and Flutter.

Secure playback

Three steps to a protected player.

Your server asks Inkrypt Videos for a one-time password for each viewer, with the watermark that viewer should see. Your page then loads the player with that password. The API secret key never leaves your server.

  1. 01

    Create an API secret key

    Generate it in the panel under Security & Config. It is shown once, so store it in your back end.

  2. 02

    Request an OTP from your server

    POST /s1/videos/{VIDEO_ID}/otp with Authorization: apikey …, plus the viewer’s identifier and watermark settings.

  3. 03

    Embed the player with it

    Load ink.js and call inkrypt.add() with the Video ID, the OTP and the returned configuration.

Try the watermark settings

Change the values and watch the request and embed code update. These are the fields the OTP request accepts:

configuration.text
Watermark text that appears at random positions on the video.
configuration.alpha
Watermark opacity.
configuration.color
Watermark text colour.
configuration.size
Watermark text size.
configuration.interval
Interval between watermark moves, in milliseconds.
identifier
Your user ID, so Inkrypt Videos can notify you about suspicious behaviour.
ttl
How long the one-time password stays valid.
Preview

A preview of your settings over a sample lesson. Real playback is DRM-protected and drawn by the Inkrypt player.

Watermark configuration
0.60
18
5.0s
color
#FFFFFF
curl -X POST https://api.inkryptvideos.com/api/s1/videos/{VIDEO_ID}/otp \
  -H "Authorization: apikey API_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
  "ttl": 300,
  "identifier": 99999,
  "configuration": {
    "type": "rtext",
    "text": "user 99999 · [email protected]",
    "alpha": "0.60",
    "color": "#FFFFFF",
    "size": 18,
    "interval": 5000
  }
}'

Full reference: Obtain OTP for secure video playback (opens in a new tab) and embed code (opens in a new tab). The same flow protects EPUB documents (EPUB OTP (opens in a new tab)).

Mobile SDKs and plugins

Native players, same protection.

Each mobile SDK is a drop-in, DRM-protected player with watermarking, quality selection and chapter navigation. It plays with the same Video ID and OTP as the web player.

Android

Maven Central

Android 7.0 (API 24) or later

implementation("com.inkryptvideos.android:inkryptvideos-android:<version>")
  • Blocks screenshots and screen recording of the player in release builds (FLAG_SECURE)
  • Reports capture attempts to your dashboard on Android 14+
Android guide (opens in a new tab)

iOS

Swift Package Manager

iOS 16.1+, Xcode 15.3+, SwiftUI

https://github.com/medrees-ink/inkryptvideos-ios
  • FairPlay DRM streaming through AVFoundation
  • Works in UIKit apps through UIHostingController
iOS guide (opens in a new tab)

React Native

npm from GitHub

React Native 0.60+ (autolinking)

npm install github:inkrypt-mobile/mobile-sdk-react-native#<tag>
  • Imports as @inkrypt/react-native-inkrypt-video-player
  • Wraps the native Android and iOS players
React Native guide (opens in a new tab)

Flutter

pubspec.yaml

Android and iOS targets

inkrypt_video_player: ^<version>
  • A widget and controller over the native Android and iOS players
  • Plays with a Video ID and an OTP, like the web player
Flutter guide (opens in a new tab)

WordPress

Plugin v1.0.8

No code: add secure video to any page from the block editor.

  1. Create an API secret key
  2. Download the plugin
  3. Install and activate it
  4. Add your key in the plugin settings
  5. Add the “Inkrypt Video” block and paste a Video ID
Plugin guide (opens in a new tab)
Upload APIs

Automate your library.

The upload APIs list, import and delete videos and folders from your own platform, so admins don’t need to sign in to the dashboard. Use them when:

  • Your site already has a video upload flow for admins.
  • Admins should not need to sign in to the Inkrypt Videos dashboard.
  • You want to bulk-import videos from your own storage.

Headers: Authorization + x-username

  • POST/public/videosList videos and folders, or search across the account or inside a folder.
  • GET/public/videos/{video_id}Get the details of one video.
  • POST/public/videos/import-videoImport a video from a URL into a folder, with an optional webhook when it is ready.
  • DELETE/public/videos/{video_id}Delete a video permanently.
  • DELETE/public/folders/{folder_id}Delete a folder and everything in it.
Upload status
  1. uploadingThe file is being uploaded.
  2. processingQuality versions are generated and the video is encrypted.
  3. readyProcessed and ready to play or share.
  • uploading-paused Paused by the user; can be resumed.
  • failed Upload or processing failed; can be retried.
  • reprocessing Being processed again after a change or an error.
Upload API reference (opens in a new tab)
Player API

Control the player from JavaScript.

Define onInkryptAPIReady, get the player with inkrypt.getObjects()[0], then listen to events and call methods.

Events

load
The video is loaded
play
The video is played
pause
The video is paused
seeking
The viewer changes the current time
ended
The video has ended
volumechange
The volume changes
Events reference (opens in a new tab)

Methods

play()
Play the video
pause()
Pause the video
mute() / unmute()
Mute or unmute the audio
setVolume(volume)
Set the volume level
setPlaybackRate(rate)
Pick a quality, for example 720, 480, 240 or 144
setAdaptive(isAdaptive)
Switch adaptive (auto) quality on or off
setCurrentTime(seconds)
Jump to a position in seconds
Methods reference (opens in a new tab)
Security settings

Decide who can press play.

In the panel’s security settings you limit playback by hostname, country and IP, and connect Apple FairPlay.

  • HostnamesAllow playback only on the domains you list.
  • CountriesAllow only selected countries, or block selected countries.
  • IPs and subnetsAllow only specific IPs or subnets, or block them.
  • Apple FairPlayUpload your Apple certificate, RSA private key and ASK in the panel to enable FairPlay.

Limit viewers (opens in a new tab) · Apple FPS setup (opens in a new tab)

Integration help

Build it with the team.

The docs cover every step, and the team helps with integration and playback issues. Start with a free 30-day trial, no credit card required.