API Frequently Asked Questions
Articles
Introduction
In this area of our Knowledge Center you will find answers to frequently asked questions about the Kaltura's API. If this is your first time working with Kaltura's API, it is highly recommended that you take time to review the Kaltura's API Docume...
How to retrieve the Partner ID, API Admin Secret and API User Secret
To retrieve account information *Including the account partner id, user and admin API secret keys: login to Kaltura Management Console, Open the Settings tab Select the Integration Settings sub-tab. For more information see: What can you con...
How to retrieve metadata of a media entry using the API?
To get a specific media entry, call the media.get API providing the id of the Kaltura Entry. The media.get request will return the basic metadata and information associated a Kaltura Entry. Using the Kaltura REST API, the media.get request will look...
Does the Kaltura platform allow fps and resolution reduction?
Yes, off the shelf. Kaltura transcodes input video files (and live streams) to web-playable and MBR renditions (flavors in Kaltura). This is done by transcoding the video. It’s controlled by the flavors API, which allows defining new transcoding rul...
Can Kaltura send control commands and audio stream back to the camera (bi-directional)?
This functionality requires an extension to the Kaltura media-server package. Alternatively, it would be another batch in Kaltura. Or an API script.
How does the Kaltura facilitate handshake / user authentication to ensure authorized users access?
In Kaltura all API calls require a valid KS (Kaltura Session) to be sent as a payload of that call. By providing a valid KS, the Kaltura service ensures that the user is authenticated and holds sufficient permissions to perform its desired action. T...
What is the backend component that handles Live Streaming in Kaltura?
The Kaltura media-server package, is a proprietary Kaltura ingest-transcoding and packaging solution.
How is the content uploaded through the Kaltura API?
There are three ways to upload content to Kaltura API- Single upload, Bulk upload and using Drop folders. Following is an example for a single upload. Create a session Media->add – create the entry, get entry ID. uploadToken->add – create uplo...
How to configure the KMC to provide server side notifications
For a complete list of notifications that are supported in KMC, click here . To enable the notifications In the KMC, select the Settings tab and then select the Integration Settings menu. Toggle Yes to receive server notifications. Enter the...
What is the recommended time to keep a log of server notifications?
The recommended time to keep the log of notifications is 48 hours. After 48 hours it should be safe to assume a notification will not be re-sent unless manually requested by an admin.
How to create a video thumbnail rotator in JavaScript?
This topic describes the steps to create a Video Thumbnail Rotator in JavaScript. The Video Thumbnail Rotator is a JS widget that provides a thumbnail slideshow preview for videos hosted on the Kaltura Server. For the complete process, click here ....
Does Kaltura allow batch processing of computer vision algorithms on transcoded files?
Kaltura’s core transcoding is of batch architecture. Refer to Introduction guide: Batch Processing .
Can Kaltura allow real time triggering of specific events (stream processing e.g. apache storm, http://hipi.cs.virginia.edu/)?
Refer to the HTTP Event Notifications mechanism: HTTP Event Notifications .
Can Kaltura extract/grab frame images from a video?
Yes, using the thumbnail API Kaltura enables publishers to extract frames from the video in real-time. Refer to the Thumbnail API Guide to learn more.
Can Kaltura cross reference metadata such as events to video timestamp?
Yes, by saving these events as cue-points metadata in Kaltura. This will allow the player (across devices) to read the cue points and create all sorts of experiences like chapters. For example, see the Chapters Player plugin . ...
What is the Kaltura media player JavaScript API?
The JavaScript API is a two-way communication channel that lets the player and user interact with each other. It lets the user know what the player is doing and vice versa.
What JavaScript APIs are provided with Kaltura's media players?
You can access the entire JavaScript API through following methods: addJsListener/removeJsListener, sendNotification, evaluate, setKDPAttribute.
How to find the Kaltura Video Player APIs?
The list of the Kaltura Video Player APIs is found on the web at: Kaltura Video Player API .
Media Localization via API
About This guide is designated for developers and will walk you through how to set up the basic metadata (i.e. name, description, and tags) in multiple languages for an entry. For the user guide, visit Media Localization . Setup Log in to the ...
