Navigate

Kaltura API Documentationmedia.list

List media entries by filter with paging support.

Try it out
post https://www.kaltura.com/api_v3/service/media/action/list

Request Parameters

body:object
SchemaExample
object
filter:object:KalturaMediaEntryFilter
objectType:string
Enum: KalturaMediaEntryFilter, KalturaMediaEntryFilterForPlaylist, KalturaExternalMediaEntryFilter, KalturaLiveEntryFilter, KalturaLiveChannelFilter, KalturaLiveStreamEntryFilter, KalturaLiveStreamAdminEntryFilter
orderBy:string
Enum: CREATED_AT_ASC [+createdAt], DURATION_ASC [+duration], END_DATE_ASC [+endDate], LAST_PLAYED_AT_ASC [+lastPlayedAt], MEDIA_TYPE_ASC [+mediaType], MODERATION_COUNT_ASC [+moderationCount], NAME_ASC [+name], PARTNER_SORT_VALUE_ASC [+partnerSortValue], PLAYS_ASC [+plays], RANK_ASC [+rank], RECENT_ASC [+recent], START_DATE_ASC [+startDate], TOTAL_RANK_ASC [+totalRank], UPDATED_AT_ASC [+updatedAt], VIEWS_ASC [+views], WEIGHT_ASC [+weight], CREATED_AT_DESC [-createdAt], DURATION_DESC [-duration], END_DATE_DESC [-endDate], LAST_PLAYED_AT_DESC [-lastPlayedAt], MEDIA_TYPE_DESC [-mediaType], MODERATION_COUNT_DESC [-moderationCount], NAME_DESC [-name], PARTNER_SORT_VALUE_DESC [-partnerSortValue], PLAYS_DESC [-plays], RANK_DESC [-rank], RECENT_DESC [-recent], START_DATE_DESC [-startDate], TOTAL_RANK_DESC [-totalRank], UPDATED_AT_DESC [-updatedAt], VIEWS_DESC [-views], WEIGHT_DESC [-weight]
KalturaMediaEntryFilter must also match all of:
object:KalturaMediaEntryBaseFilter
KalturaMediaEntryFilter must also match any of:
object:KalturaMediaEntryFilterobject:KalturaMediaEntryFilterForPlaylistobject:KalturaExternalMediaEntryFilterobject:KalturaLiveEntryFilterobject:KalturaLiveChannelFilterobject:KalturaLiveStreamEntryFilterobject:KalturaLiveStreamAdminEntryFilter
pager:object:KalturaFilterPager
The KalturaFilterPager object enables paging management to be applied upon service list actions.


KalturaFilterPager must also match all of:
object:KalturaPager

Response

Success

SchemaExample
object:KalturaMediaListResponse
objects:array[object:KalturaMediaEntry]
object:KalturaMediaEntry
conversionQuality:string
insertOnly


Override the default conversion quality


creditUrl:string
The URL for credits


creditUserName:string
The user name used for credits


dataUrl:string
readOnly


The URL used for playback. This is not the download URL.


flavorParamsIds:string
readOnly


Comma separated flavor params ids that exists for this media entry


isTrimDisabled:integer
Enum: NULL_VALUE [-1], FALSE_VALUE [0], TRUE_VALUE [1]
readOnly


Enum Type: KalturaNullableBoolean


True if trim action is disabled for this entry


mediaDate:integer
readOnly


The media date extracted from EXIF data (For images) as Unix timestamp (In seconds)


mediaType:integer
Enum: VIDEO [1], IMAGE [2], AUDIO [5], LIVE_STREAM_FLASH [201], LIVE_STREAM_WINDOWS_MEDIA [202], LIVE_STREAM_REAL_MEDIA [203], LIVE_STREAM_QUICKTIME [204]
insertOnly


Enum Type: KalturaMediaType


The media type of the entry


objectType:string
Enum: KalturaMediaEntry, KalturaExternalMediaEntry, KalturaLiveChannel, KalturaLiveStreamEntry, KalturaLiveStreamAdminEntry
searchProviderId:string
insertOnly


The ID of the media in the importing site


searchProviderType:integer
Enum: FLICKR [3], YOUTUBE [4], MYSPACE [7], PHOTOBUCKET [8], JAMENDO [9], CCMIXTER [10], NYPL [11], CURRENT [12], MEDIA_COMMONS [13], KALTURA [20], KALTURA_USER_CLIPS [21], ARCHIVE_ORG [22], KALTURA_PARTNER [23], METACAFE [24], SEARCH_PROXY [28], PARTNER_SPECIFIC [100]
insertOnly


Enum Type: KalturaSearchProviderType


The search provider type used to import this entry


sourceType:string
Enum: LIMELIGHT_LIVE [limeLight.LIVE_STREAM], VELOCIX_LIVE [velocix.VELOCIX_LIVE], FILE [1], WEBCAM [2], URL [5], SEARCH_PROVIDER [6], AKAMAI_LIVE [29], MANUAL_LIVE_STREAM [30], AKAMAI_UNIVERSAL_LIVE [31], LIVE_STREAM [32], LIVE_CHANNEL [33], RECORDED_LIVE [34], CLIP [35], KALTURA_RECORDED_LIVE [36], LECTURE_CAPTURE [37], LIVE_STREAM_ONTEXTDATA_CAPTIONS [42]
insertOnly


Enum Type: KalturaSourceType


The source type of the entry


sourceVersion:string
insertOnly


The source version of the entry


streams:array[object:KalturaStreamContainer]
KalturaMediaEntry must also match all of:
object:KalturaPlayableEntry
KalturaMediaEntry must also match any of:
object:KalturaMediaEntryobject:KalturaExternalMediaEntryobject:KalturaLiveChannelobject:KalturaLiveStreamEntryobject:KalturaLiveStreamAdminEntry
KalturaMediaListResponse must also match all of:
object:KalturaListResponse