Kaltura API

KalturaLiveStreamEntry
Properties
KalturaObjectBase Inherited from KalturaObjectBase
Name Type Writable Restrictions Description
relatedObjects map of KalturaListResponse
KalturaBaseEntry Inherited from KalturaBaseEntry
Name Type Writable Restrictions Description
id string Auto generated 10 characters alphanumeric string
name string V Entry name (Min 1 chars)
description string V Entry description
partnerId int
userId string V The ID of the user who is the owner of this entry
creatorId string V The ID of the user who created this entry
tags string V Entry tags
adminTags string V Entry admin tags can be updated only by administrators
categories string V Comma 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.
categoriesIds string V Comma 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.
status KalturaEntryStatus
moderationStatus KalturaEntryModerationStatus Entry moderation status
moderationCount int Number of moderation requests waiting for this entry
type KalturaEntryType V The type of the entry, this is auto filled by the derived entry object
createdAt int Entry creation date as Unix timestamp (In seconds)
updatedAt int Entry update date as Unix timestamp (In seconds)
rank float The calculated average rank. rank = totalRank / votes
totalRank int The sum of all rank values submitted to the baseEntry.anonymousRank action
votes int A count of all requests made to the baseEntry.anonymousRank action
groupId int V
partnerData string V Can be used to store various partner related data as a string
downloadUrl string Download URL for the entry
searchText string Indexed search text for full text search
licenseType KalturaLicenseType V License type used for this entry
version int Version of the entry data
thumbnailUrl string Thumbnail URL
accessControlId int V The Access Control ID assigned to this entry (null when not set, send -1 to remove)
startDate int V Entry scheduling start date (null when not set, send -1 to remove)
endDate int V Entry scheduling end date (null when not set, send -1 to remove)
referenceId string V Entry external reference id
replacingEntryId string ID of temporary entry that will replace this entry when it's approved and ready for replacement
replacedEntryId string ID of the entry that will be replaced when the replacement approved and this entry is ready
replacementStatus KalturaEntryReplacementStatus Status of the replacement readiness and approval
partnerSortValue int V Can be used to store various partner related data as a numeric value
conversionProfileId int V Override the default ingestion profile
redirectEntryId string V IF not empty, points to an entry ID the should replace this current entry's id.
rootEntryId string ID of source root entry, used for clipped, skipped and cropped entries that created from another entry
parentEntryId string V ID of source root entry, used for defining entires association
operationAttributes array of KalturaOperationAttributes V clipping, skipping and cropping attributes that used to create this entry
entitledUsersEdit string V list of user ids that are entitled to edit the entry (no server enforcement) The difference between entitledUsersEdit, entitledUsersPublish and entitledUsersView is applicative only
entitledUsersPublish string V list of user ids that are entitled to publish the entry (no server enforcement) The difference between entitledUsersEdit, entitledUsersPublish and entitledUsersView is applicative only
entitledUsersView string V list of user ids that are entitled to view the entry (no server enforcement) The difference between entitledUsersEdit, entitledUsersPublish and entitledUsersView is applicative only
capabilities string Comma seperated string of the capabilities of the entry. Any capability needed can be added to this list.
templateEntryId string V Template entry id
displayInSearch KalturaEntryDisplayInSearchType V should we display this entry in search
application KalturaEntryApplication V Entry application
applicationVersion string V Entry application version
blockAutoTranscript bool V Block auto transcript on Entry
KalturaPlayableEntry Inherited from KalturaPlayableEntry
Name Type Writable Restrictions Description
plays int Number of plays
views int Number of views
lastPlayedAt int The last time the entry was played
width int The width in pixels
height int The height in pixels
duration int The duration in seconds
msDuration int V The duration in miliseconds
durationType KalturaDurationType The duration type (short for 0-4 mins, medium for 4-20 mins, long for 20+ mins)
KalturaMediaEntry Inherited from KalturaMediaEntry
Name Type Writable Restrictions Description
mediaType KalturaMediaType V The media type of the entry
conversionQuality string V Override the default conversion quality
sourceType KalturaSourceType V The source type of the entry
sourceVersion string V The source version of the entry
searchProviderType KalturaSearchProviderType V The search provider type used to import this entry
searchProviderId string V The ID of the media in the importing site
creditUserName string V The user name used for credits
creditUrl string V The URL for credits
mediaDate int The media date extracted from EXIF data (For images) as Unix timestamp (In seconds)
dataUrl string The URL used for playback. This is not the download URL.
flavorParamsIds string Comma separated flavor params ids that exists for this media entry
isTrimDisabled KalturaNullableBoolean True if trim action is disabled for this entry
streams array of KalturaStreamContainer V Array of streams that exists on the entry
KalturaLiveEntry Inherited from KalturaLiveEntry
Name Type Writable Restrictions Description
offlineMessage string V The message to be presented when the stream is offline
recordStatus KalturaRecordStatus V Recording Status Enabled/Disabled
dvrStatus KalturaDVRStatus V DVR Status Enabled/Disabled
dvrWindow int V Window of time which the DVR allows for backwards scrubbing (in minutes)
lastElapsedRecordingTime int V Elapsed recording time (in msec) up to the point where the live stream was last stopped (unpublished).
liveStreamConfigurations array of KalturaLiveStreamConfiguration V Array of key value protocol->live stream url objects
recordedEntryId string V Recorded entry id
pushPublishEnabled KalturaLivePublishStatus V Flag denoting whether entry should be published by the media server
publishConfigurations array of KalturaLiveStreamPushPublishConfiguration V Array of publish configurations
firstBroadcast int The first time in which the entry was broadcast
lastBroadcast int The Last time in which the entry was broadcast
currentBroadcastStartTime float V The time (unix timestamp in milliseconds) in which the entry broadcast started or 0 when the entry is off the air
recordingOptions KalturaLiveEntryRecordingOptions V
liveStatus KalturaEntryServerNodeStatus the status of the entry of type EntryServerNodeStatus
segmentDuration int V The chunk duration value in milliseconds
explicitLive KalturaNullableBoolean V
viewMode KalturaViewMode V
recordingStatus KalturaRecordingStatus V
lastBroadcastEndTime int The time the last broadcast finished.
broadcastTime int V The time when the entry was first live with view_all
KalturaLiveStreamEntry
Name Type Writable Restrictions Description
streamRemoteId string The stream id as provided by the provider
streamRemoteBackupId string The backup stream id as provided by the provider
bitrates array of KalturaLiveStreamBitrate V Array of supported bitrates
primaryBroadcastingUrl string V
secondaryBroadcastingUrl string V
primarySecuredBroadcastingUrl string V
secondarySecuredBroadcastingUrl string V
primaryRtspBroadcastingUrl string V
secondaryRtspBroadcastingUrl string V
primarySrtBroadcastingUrl string V
primarySrtStreamId string V
secondarySrtBroadcastingUrl string V
secondarySrtStreamId string V
streamName string V
streamUrl string V The stream url
hlsStreamUrl string V HLS URL - URL for live stream playback on mobile device
urlManager string V URL Manager to handle the live stream URL (for instance, add token)
encodingIP1 string V The broadcast primary ip
encodingIP2 string V The broadcast secondary ip
streamPassword string V The broadcast password
streamUsername string The broadcast username
srtPass string V
primaryServerNodeId int The Streams primary server node id
sipToken string
sipSourceType KalturaSipSourceType
Sub classes: KalturaLiveStreamAdminEntry