Services

General Objects

Filter Objects

Array Objects

Enums

String Enums Constants

Kaltura API

KalturaLiveChannelBaseFilter
Properties
Inherited from KalturaObject
NameTypeRestrictionsDescription
relatedObjectsKalturaListResponseArray
Inherited from KalturaFilter
NameTypeRestrictionsDescription
advancedSearchKalturaSearchItem
orderBystringThis parameter sets the order criteria by which objects will be retrieved.
KalturaRelatedFilter
Inherited from KalturaBaseEntryBaseFilter
NameTypeRestrictionsDescription
accessControlIdEqualint
accessControlIdInstring
adminTagsLikestringThis filter should be in use for retrieving specific entries. It should include only one string to search for in entry tags set by an ADMIN user (no wildcards, spaces are treated as part of the string).
adminTagsMultiLikeAndstringThis filter should be in use for retrieving specific entries. It could include few (comma separated) strings for searching in entry tags, set by an ADMIN user, while applying an AND logic to retrieve entries that contain all input strings (no wildcards, spaces are treated as part of the string).
adminTagsMultiLikeOrstringThis filter should be in use for retrieving specific entries. It could include few (comma separated) strings for searching in entry tags, set by an ADMIN user, while applying an OR logic to retrieve entries that contain at least one input string (no wildcards, spaces are treated as part of the string).
categoriesIdsEmptyKalturaNullableBoolean
categoriesIdsMatchAndstring
categoriesIdsMatchOrstringAll entries of the categories, excluding their child categories.
To include entries of the child categories, use categoryAncestorIdIn, or categoriesMatchOr.
categoriesIdsNotContainsstring
categoriesMatchAndstring
categoriesMatchOrstringAll entries within these categories or their child categories.
categoriesNotContainsstring
createdAtGreaterThanOrEqualintThis filter parameter should be in use for retrieving only entries which were created at Kaltura system after a specific time/date (standard timestamp format).
createdAtLessThanOrEqualintThis filter parameter should be in use for retrieving only entries which were created at Kaltura system before a specific time/date (standard timestamp format).
creatorIdEqualstring
endDateGreaterThanOrEqualint
endDateGreaterThanOrEqualOrNullint
endDateLessThanOrEqualint
endDateLessThanOrEqualOrNullint
entitledUsersEditMatchAndstring
entitledUsersPublishMatchAndstring
groupIdEqualint
idEqualstringThis filter should be in use for retrieving only a specific entry (identified by its entryId).
idInstringThis filter should be in use for retrieving few specific entries (string should include comma separated list of entryId strings).
idNotInstring
moderationStatusEqualKalturaEntryModerationStatus
moderationStatusInstring
moderationStatusNotEqualKalturaEntryModerationStatus
moderationStatusNotInstring
nameEqualstringThis filter should be in use for retrieving entries with a specific name.
nameLikestringThis filter should be in use for retrieving specific entries. It should include only one string to search for in entry names (no wildcards, spaces are treated as part of the string).
nameMultiLikeAndstringThis filter should be in use for retrieving specific entries. It could include few (comma separated) strings for searching in entry names, while applying an AND logic to retrieve entries that contain all input strings (no wildcards, spaces are treated as part of the string).
nameMultiLikeOrstringThis filter should be in use for retrieving specific entries. It could include few (comma separated) strings for searching in entry names, while applying an OR logic to retrieve entries that contain at least one input string (no wildcards, spaces are treated as part of the string).
parentEntryIdEqualstring
partnerIdEqualintThis filter should be in use for retrieving only entries which were uploaded by/assigned to users of a specific Kaltura Partner (identified by Partner ID).
partnerIdInstringThis filter should be in use for retrieving only entries within Kaltura network which were uploaded by/assigned to users of few Kaltura Partners (string should include comma separated list of PartnerIDs)
partnerSortValueGreaterThanOrEqualint
partnerSortValueLessThanOrEqualint
referenceIdEqualstring
referenceIdInstring
replacedEntryIdEqualstring
replacedEntryIdInstring
replacementStatusEqualKalturaEntryReplacementStatus
replacementStatusInstring
replacingEntryIdEqualstring
replacingEntryIdInstring
rootEntryIdEqualstring
rootEntryIdInstring
searchTextMatchAndstringThis filter should be in use for retrieving specific entries while search match the input string within all of the following metadata attributes: name, description, tags, adminTags.
searchTextMatchOrstringThis filter should be in use for retrieving specific entries while search match the input string within at least one of the following metadata attributes: name, description, tags, adminTags.
startDateGreaterThanOrEqualint
startDateGreaterThanOrEqualOrNullint
startDateLessThanOrEqualint
startDateLessThanOrEqualOrNullint
statusEqualKalturaEntryStatusThis filter should be in use for retrieving only entries, at a specific {
statusInstringThis filter should be in use for retrieving only entries, at few specific {
statusNotEqualKalturaEntryStatusThis filter should be in use for retrieving only entries, not at a specific {
statusNotInstringThis filter should be in use for retrieving only entries, not at few specific {
tagsAdminTagsMultiLikeAndstring
tagsAdminTagsMultiLikeOrstring
tagsAdminTagsNameMultiLikeAndstring
tagsAdminTagsNameMultiLikeOrstring
tagsLikestringThis filter should be in use for retrieving specific entries. It should include only one string to search for in entry tags (no wildcards, spaces are treated as part of the string).
tagsMultiLikeAndstringThis filter should be in use for retrieving specific entries. It could include few (comma separated) strings for searching in entry tags, while applying an AND logic to retrieve entries that contain all input strings (no wildcards, spaces are treated as part of the string).
tagsMultiLikeOrstringThis filter should be in use for retrieving specific entries. It could include few (comma separated) strings for searching in entry tags, while applying an OR logic to retrieve entries that contain at least one input string (no wildcards, spaces are treated as part of the string).
tagsNameMultiLikeAndstring
tagsNameMultiLikeOrstring
totalRankGreaterThanOrEqualint
totalRankLessThanOrEqualint
typeEqualKalturaEntryType
typeInstringThis filter should be in use for retrieving entries of few {
updatedAtGreaterThanOrEqualint
updatedAtLessThanOrEqualint
userIdEqualstringThis filter parameter should be in use for retrieving only entries, uploaded by/assigned to a specific user (identified by user Id).
userIdInstring
Inherited from KalturaBaseEntryFilter
NameTypeRestrictionsDescription
categoriesFullNameInstring
categoryAncestorIdInstringAll entries within this categoy or in child categories
freeTextstring
isRootKalturaNullableBoolean
redirectFromEntryIdstringThe id of the original entry
Inherited from KalturaPlayableEntryBaseFilter
NameTypeRestrictionsDescription
durationGreaterThanint
durationGreaterThanOrEqualint
durationLessThanint
durationLessThanOrEqualint
durationTypeMatchOrstring
lastPlayedAtGreaterThanOrEqualint
lastPlayedAtLessThanOrEqualint
KalturaPlayableEntryFilter
Inherited from KalturaMediaEntryBaseFilter
NameTypeRestrictionsDescription
flavorParamsIdsMatchAndstring
flavorParamsIdsMatchOrstring
mediaDateGreaterThanOrEqualint
mediaDateLessThanOrEqualint
mediaTypeEqualKalturaMediaType
mediaTypeInstring
sourceTypeEqualKalturaSourceType
sourceTypeInstring
sourceTypeNotEqualKalturaSourceType
sourceTypeNotInstring
KalturaMediaEntryFilter
KalturaLiveEntryBaseFilter
Inherited from KalturaLiveEntryFilter
NameTypeRestrictionsDescription
hasMediaServerHostnamestring
isLiveKalturaNullableBoolean
isRecordedEntryIdEmptyKalturaNullableBoolean
KalturaLiveChannelBaseFilter
Sub classes: KalturaLiveChannelFilter