Services

General Objects

Filter Objects

Array Objects

Enums

String Enums Constants

Kaltura API

KalturaLiveChannel
Properties
Inherited from KalturaObject
NameTypeWritableRestrictionsDescription
relatedObjectsKalturaListResponseArray
Inherited from KalturaBaseEntry
NameTypeWritableRestrictionsDescription
accessControlIdintVThe Access Control ID assigned to this entry (null when not set, send -1 to remove)
adminTagsstringVEntry admin tags can be updated only by administrators
capabilitiesstringComma seperated string of the capabilities of the entry. Any capability needed can be added to this list.
categoriesstringVComma separated list of full names of categories to which this entry belongs. Only categories that don't have entitlement (privacy context) are listed, to retrieve the full list of categories, use the categoryEntry.list action.
categoriesIdsstringVComma separated list of ids of categories to which this entry belongs. Only categories that don't have entitlement (privacy context) are listed, to retrieve the full list of categories, use the categoryEntry.list action.
conversionProfileIdintVOverride the default ingestion profile
createdAtintEntry creation date as Unix timestamp (In seconds)
creatorIdstringVThe ID of the user who created this entry
descriptionstringVEntry description
downloadUrlstringDownload URL for the entry
endDateintVEntry scheduling end date (null when not set, send -1 to remove)
entitledUsersEditstringVlist of user ids that are entitled to edit the entry (no server enforcement) The difference between entitledUsersEdit and entitledUsersPublish is applicative only
entitledUsersPublishstringVlist of user ids that are entitled to publish the entry (no server enforcement) The difference between entitledUsersEdit and entitledUsersPublish is applicative only
groupIdintV
idstringAuto generated 10 characters alphanumeric string
licenseTypeKalturaLicenseTypeVLicense type used for this entry
moderationCountintNumber of moderation requests waiting for this entry
moderationStatusKalturaEntryModerationStatusEntry moderation status
namestringVEntry name (Min 1 chars)
operationAttributesKalturaOperationAttributesArrayVclipping, skipping and cropping attributes that used to create this entry
parentEntryIdstringVID of source root entry, used for defining entires association
partnerDatastringVCan be used to store various partner related data as a string
partnerIdint
partnerSortValueintVCan be used to store various partner related data as a numeric value
rankfloatThe calculated average rank. rank = totalRank / votes
redirectEntryIdstringVIF not empty, points to an entry ID the should replace this current entry's id.
referenceIdstringVEntry external reference id
replacedEntryIdstringID of the entry that will be replaced when the replacement approved and this entry is ready
replacementStatusKalturaEntryReplacementStatusStatus of the replacement readiness and approval
replacingEntryIdstringID of temporary entry that will replace this entry when it's approved and ready for replacement
rootEntryIdstringID of source root entry, used for clipped, skipped and cropped entries that created from another entry
searchTextstringIndexed search text for full text search
startDateintVEntry scheduling start date (null when not set, send -1 to remove)
statusKalturaEntryStatus
tagsstringVEntry tags
thumbnailUrlstringThumbnail URL
totalRankintThe sum of all rank values submitted to the baseEntry.anonymousRank action
typeKalturaEntryTypeVThe type of the entry, this is auto filled by the derived entry object
updatedAtintEntry update date as Unix timestamp (In seconds)
userIdstringVThe ID of the user who is the owner of this entry
versionintVersion of the entry data
votesintA count of all requests made to the baseEntry.anonymousRank action
Inherited from KalturaPlayableEntry
NameTypeWritableRestrictionsDescription
durationintThe duration in seconds
durationTypeKalturaDurationTypeThe duration type (short for 0-4 mins, medium for 4-20 mins, long for 20+ mins)
heightintThe height in pixels
lastPlayedAtintThe last time the entry was played
msDurationintVThe duration in miliseconds
playsintNumber of plays
viewsintNumber of views
widthintThe width in pixels
Inherited from KalturaMediaEntry
NameTypeWritableRestrictionsDescription
conversionQualitystringVOverride the default conversion quality
creditUrlstringVThe URL for credits
creditUserNamestringVThe user name used for credits
dataUrlstringThe URL used for playback. This is not the download URL.
flavorParamsIdsstringComma separated flavor params ids that exists for this media entry
isTrimDisabledKalturaNullableBooleanTrue if trim action is disabled for this entry
mediaDateintThe media date extracted from EXIF data (For images) as Unix timestamp (In seconds)
mediaTypeKalturaMediaTypeVThe media type of the entry
searchProviderIdstringVThe ID of the media in the importing site
searchProviderTypeKalturaSearchProviderTypeVThe search provider type used to import this entry
sourceTypeKalturaSourceTypeVThe source type of the entry
Inherited from KalturaLiveEntry
NameTypeWritableRestrictionsDescription
currentBroadcastStartTimefloatVThe time (unix timestamp in milliseconds) in which the entry broadcast started or 0 when the entry is off the air
dvrStatusKalturaDVRStatusVDVR Status Enabled/Disabled
dvrWindowintVWindow of time which the DVR allows for backwards scrubbing (in minutes)
firstBroadcastintThe first time in which the entry was broadcast
lastBroadcastintThe Last time in which the entry was broadcast
lastElapsedRecordingTimeintVElapsed recording time (in msec) up to the point where the live stream was last stopped (unpublished).
liveStreamConfigurationsKalturaLiveStreamConfigurationArrayVArray of key value protocol->live stream url objects
offlineMessagestringVThe message to be presented when the stream is offline
publishConfigurationsKalturaLiveStreamPushPublishConfigurationArrayVArray of publish configurations
pushPublishEnabledKalturaLivePublishStatusVFlag denoting whether entry should be published by the media server
recordStatusKalturaRecordStatusVRecording Status Enabled/Disabled
recordedEntryIdstringVRecorded entry id
recordingOptionsKalturaLiveEntryRecordingOptionsV
KalturaLiveChannel
NameTypeWritableRestrictionsDescription
playlistIdstringVPlaylist id to be played
repeatKalturaNullableBooleanVIndicates that the segments should be repeated for ever