Learn how to search through your video library using Kaltura's API
To search for objects in Kaltura, API services expose the list action. For media entries, the list action provides a vast set of filter parameters to allow for granular flexibility in building custom library search experiences, whether it is a free-form search, or a pre-determined gallery.
This recipe will walk through some common scenarios of using the media.list action
This workflow has no steps. Try adding one.
You still haven't completed step 1
The following special operators can be used in a free text search field in the Kaltura API:
You still haven't completed step 1
To retrieve a list of media entries, use Media Entry Filters to select which content you want to show.
This combination of filter parameters will search through all of the Kaltura Media Entry fields and custom metadata fields, using a free text search and ordered by default using the BM25 algorithm.
You still haven't completed step 1
To search based on specific base fields, use the filter parameter that corresponds to the name of the base field you'd like search on.
Base fields are exposed in the filter via a number of optional fields:
Blend Chars:
Blended characters are indexed both as separators and valid characters.
For instance, assume that & is configured as blended and AT&T occurs in an indexed document. Three different keywords will get indexed, namely "at&t", treating blended characters as valid, plus "at" and "t", treating them as separators.
The following blend chars are configured for the API search.
!, $, ', (, ), *, -, /, :, ;, <, =, #, [, , ], ^, `, {, |, }, ~, %, &, +, >, ?, @, _
These blend characters may be used as delimiters or as characters.
Note, to treat * and ! as literals, use a backslash. e.g. if name="test!" to search for it, use "test\!"
You still haven't completed step 1
Here's how to embed the results in HTML. You can select a skin by setting uiconf_id.
Learn about working with custom metadata
You can learn more about the operations used in this workflow by visiting the API Console and Documentation
media.list | Console | Documentation |