Package com.kaltura.client.services

Class LiveStreamService

java.lang.Object

com.kaltura.client.services.LiveStreamService

public class LiveStreamService
extends Object

Live Stream service lets you manage live stream entries

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LiveStreamService.AddLiveStreamBuilder
static class	LiveStreamService.AddLiveStreamPushPublishConfigurationLiveStreamBuilder
static class	LiveStreamService.AllocateConferenceRoomLiveStreamBuilder
static class	LiveStreamService.AppendRecordingLiveStreamBuilder
static class	LiveStreamService.ArchiveLiveStreamBuilder
static class	LiveStreamService.AuthenticateLiveStreamBuilder
static class	LiveStreamService.CreatePeriodicSyncPointsLiveStreamBuilder
static class	LiveStreamService.CreateRecordedEntryLiveStreamBuilder
static class	LiveStreamService.DeleteLiveStreamBuilder
static class	LiveStreamService.FinishConfLiveStreamBuilder
static class	LiveStreamService.GetDetailsLiveStreamBuilder
static class	LiveStreamService.GetLiveStreamBuilder
static class	LiveStreamService.IsLiveLiveStreamBuilder
static class	LiveStreamService.ListLiveStreamBuilder
static class	LiveStreamService.RegenerateStreamTokenLiveStreamBuilder
static class	LiveStreamService.RegisterConfLiveStreamBuilder
static class	LiveStreamService.RegisterMediaServerLiveStreamBuilder
static class	LiveStreamService.RemoveLiveStreamPushPublishConfigurationLiveStreamBuilder
static class	LiveStreamService.SetRecordedContentLiveStreamBuilder
static class	LiveStreamService.UnregisterMediaServerLiveStreamBuilder
static class	LiveStreamService.UpdateLiveStreamBuilder
static class	LiveStreamService.UpdateOfflineThumbnailFromUrlLiveStreamBuilder
static class	LiveStreamService.UpdateOfflineThumbnailJpegLiveStreamBuilder
static class	LiveStreamService.ValidateRegisteredMediaServersLiveStreamBuilder

Constructor Summary

Constructors

Constructor	Description
LiveStreamService()

Method Summary

Modifier and Type	Method	Description
static LiveStreamService.AddLiveStreamBuilder	add(LiveStreamEntry liveStreamEntry)
static LiveStreamService.AddLiveStreamBuilder	add(LiveStreamEntry liveStreamEntry, SourceType sourceType)	Adds new live stream entry.
static LiveStreamService.AddLiveStreamPushPublishConfigurationLiveStreamBuilder	addLiveStreamPushPublishConfiguration(String entryId, PlaybackProtocol protocol)
static LiveStreamService.AddLiveStreamPushPublishConfigurationLiveStreamBuilder	addLiveStreamPushPublishConfiguration(String entryId, PlaybackProtocol protocol, String url)
static LiveStreamService.AddLiveStreamPushPublishConfigurationLiveStreamBuilder	addLiveStreamPushPublishConfiguration(String entryId, PlaybackProtocol protocol, String url, LiveStreamConfiguration liveStreamConfiguration)	Add new pushPublish configuration to entry
static LiveStreamService.AllocateConferenceRoomLiveStreamBuilder	allocateConferenceRoom(String entryId)
static LiveStreamService.AllocateConferenceRoomLiveStreamBuilder	allocateConferenceRoom(String entryId, String env)	Allocates a conference room or returns ones that has already been allocated
static LiveStreamService.AppendRecordingLiveStreamBuilder	appendRecording(String entryId, String assetId, EntryServerNodeType mediaServerIndex, DataCenterContentResource resource, double duration)
static LiveStreamService.AppendRecordingLiveStreamBuilder	appendRecording(String entryId, String assetId, EntryServerNodeType mediaServerIndex, DataCenterContentResource resource, double duration, boolean isLastChunk)	Append recorded video to live entry
static LiveStreamService.ArchiveLiveStreamBuilder	archive(String liveEntryId, String vodEntryId)	Archive a live entry which was recorded
static LiveStreamService.AuthenticateLiveStreamBuilder	authenticate(String entryId, String token)
static LiveStreamService.AuthenticateLiveStreamBuilder	authenticate(String entryId, String token, String hostname)
static LiveStreamService.AuthenticateLiveStreamBuilder	authenticate(String entryId, String token, String hostname, EntryServerNodeType mediaServerIndex)
static LiveStreamService.AuthenticateLiveStreamBuilder	authenticate(String entryId, String token, String hostname, EntryServerNodeType mediaServerIndex, String applicationName)	Authenticate live-stream entry against stream token and partner limitations
static LiveStreamService.CreatePeriodicSyncPointsLiveStreamBuilder	createPeriodicSyncPoints(String entryId, int interval, int duration)	Creates periodic metadata sync-point events on a live stream
static LiveStreamService.CreateRecordedEntryLiveStreamBuilder	createRecordedEntry(String entryId, EntryServerNodeType mediaServerIndex, EntryServerNodeStatus liveEntryStatus)	Create recorded entry id if it doesn't exist and make sure it happens on the DC that the live entry was created on.
static LiveStreamService.DeleteLiveStreamBuilder	delete(String entryId)	Delete a live stream entry.
static LiveStreamService.FinishConfLiveStreamBuilder	finishConf(String entryId)
static LiveStreamService.FinishConfLiveStreamBuilder	finishConf(String entryId, int serverNodeId)	When the conf is finished this API should be called.
static LiveStreamService.GetLiveStreamBuilder	get(String entryId)
static LiveStreamService.GetLiveStreamBuilder	get(String entryId, int version)	Get live stream entry by ID.
static LiveStreamService.GetDetailsLiveStreamBuilder	getDetails(String id)	Delivering the status of a live stream (on-air/offline) if it is possible
static LiveStreamService.IsLiveLiveStreamBuilder	isLive(String id)
static LiveStreamService.IsLiveLiveStreamBuilder	isLive(String id, PlaybackProtocol protocol)	Delivering the status of a live stream (on-air/offline) if it is possible
static LiveStreamService.ListLiveStreamBuilder	list()
static LiveStreamService.ListLiveStreamBuilder	list(LiveStreamEntryFilter filter)
static LiveStreamService.ListLiveStreamBuilder	list(LiveStreamEntryFilter filter, FilterPager pager)	List live stream entries by filter with paging support.
static LiveStreamService.RegenerateStreamTokenLiveStreamBuilder	regenerateStreamToken(String entryId)	Regenerate new secure token for liveStream
static LiveStreamService.RegisterConfLiveStreamBuilder	registerConf(String entryId)	Mark that the conference has actually started
static LiveStreamService.RegisterMediaServerLiveStreamBuilder	registerMediaServer(String entryId, String hostname, EntryServerNodeType mediaServerIndex)
static LiveStreamService.RegisterMediaServerLiveStreamBuilder	registerMediaServer(String entryId, String hostname, EntryServerNodeType mediaServerIndex, String applicationName)
static LiveStreamService.RegisterMediaServerLiveStreamBuilder	registerMediaServer(String entryId, String hostname, EntryServerNodeType mediaServerIndex, String applicationName, EntryServerNodeStatus liveEntryStatus)
static LiveStreamService.RegisterMediaServerLiveStreamBuilder	registerMediaServer(String entryId, String hostname, EntryServerNodeType mediaServerIndex, String applicationName, EntryServerNodeStatus liveEntryStatus, boolean shouldCreateRecordedEntry)	Register media server to live entry
static LiveStreamService.RemoveLiveStreamPushPublishConfigurationLiveStreamBuilder	removeLiveStreamPushPublishConfiguration(String entryId, PlaybackProtocol protocol)	Remove push publish configuration from entry
static LiveStreamService.SetRecordedContentLiveStreamBuilder	setRecordedContent(String entryId, EntryServerNodeType mediaServerIndex, DataCenterContentResource resource, double duration)
static LiveStreamService.SetRecordedContentLiveStreamBuilder	setRecordedContent(String entryId, EntryServerNodeType mediaServerIndex, DataCenterContentResource resource, double duration, String recordedEntryId)
static LiveStreamService.SetRecordedContentLiveStreamBuilder	setRecordedContent(String entryId, EntryServerNodeType mediaServerIndex, DataCenterContentResource resource, double duration, String recordedEntryId, int flavorParamsId)	Set recorded video to live entry
static LiveStreamService.UnregisterMediaServerLiveStreamBuilder	unregisterMediaServer(String entryId, String hostname, EntryServerNodeType mediaServerIndex)	Unregister media server from live entry
static LiveStreamService.UpdateLiveStreamBuilder	update(String entryId, LiveStreamEntry liveStreamEntry)	Update live stream entry.
static LiveStreamService.UpdateOfflineThumbnailFromUrlLiveStreamBuilder	updateOfflineThumbnailFromUrl(String entryId, String url)	Update entry thumbnail using url
static LiveStreamService.UpdateOfflineThumbnailJpegLiveStreamBuilder	updateOfflineThumbnailJpeg(String entryId, FileHolder fileData)	Update live stream entry thumbnail using a raw jpeg file
static LiveStreamService.UpdateOfflineThumbnailJpegLiveStreamBuilder	updateOfflineThumbnailJpeg(String entryId, File fileData)
static LiveStreamService.UpdateOfflineThumbnailJpegLiveStreamBuilder	updateOfflineThumbnailJpeg(String entryId, FileInputStream fileData, String fileDataMimeType, String fileDataName)
static LiveStreamService.UpdateOfflineThumbnailJpegLiveStreamBuilder	updateOfflineThumbnailJpeg(String entryId, InputStream fileData, String fileDataMimeType, String fileDataName, long fileDataSize)
static LiveStreamService.ValidateRegisteredMediaServersLiveStreamBuilder	validateRegisteredMediaServers(String entryId)	Validates all registered media servers

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LiveStreamService

public LiveStreamService()

Method Detail

add

public static LiveStreamService.AddLiveStreamBuilder add(LiveStreamEntry liveStreamEntry)

add

public static LiveStreamService.AddLiveStreamBuilder add(LiveStreamEntry liveStreamEntry,
                                                         SourceType sourceType)

Adds new live stream entry. The entry will be queued for provision.

Parameters:

liveStreamEntry - Live stream entry metadata

sourceType - Live stream source type

addLiveStreamPushPublishConfiguration

public static LiveStreamService.AddLiveStreamPushPublishConfigurationLiveStreamBuilder addLiveStreamPushPublishConfiguration(String entryId,
                                                                                                                             PlaybackProtocol protocol)

addLiveStreamPushPublishConfiguration

public static LiveStreamService.AddLiveStreamPushPublishConfigurationLiveStreamBuilder addLiveStreamPushPublishConfiguration(String entryId,
                                                                                                                             PlaybackProtocol protocol,
                                                                                                                             String url)

addLiveStreamPushPublishConfiguration

public static LiveStreamService.AddLiveStreamPushPublishConfigurationLiveStreamBuilder addLiveStreamPushPublishConfiguration(String entryId,
                                                                                                                             PlaybackProtocol protocol,
                                                                                                                             String url,
                                                                                                                             LiveStreamConfiguration liveStreamConfiguration)

Add new pushPublish configuration to entry

Parameters:

entryId -

protocol -

url -

liveStreamConfiguration -

allocateConferenceRoom

public static LiveStreamService.AllocateConferenceRoomLiveStreamBuilder allocateConferenceRoom(String entryId)

allocateConferenceRoom

public static LiveStreamService.AllocateConferenceRoomLiveStreamBuilder allocateConferenceRoom(String entryId,
                                                                                               String env)

Allocates a conference room or returns ones that has already been allocated

Parameters:

entryId -

env -

appendRecording

public static LiveStreamService.AppendRecordingLiveStreamBuilder appendRecording(String entryId,
                                                                                 String assetId,
                                                                                 EntryServerNodeType mediaServerIndex,
                                                                                 DataCenterContentResource resource,
                                                                                 double duration)

appendRecording

public static LiveStreamService.AppendRecordingLiveStreamBuilder appendRecording(String entryId,
                                                                                 String assetId,
                                                                                 EntryServerNodeType mediaServerIndex,
                                                                                 DataCenterContentResource resource,
                                                                                 double duration,
                                                                                 boolean isLastChunk)

Append recorded video to live entry

Parameters:

entryId - Live entry id

assetId - Live asset id

mediaServerIndex -

resource -

duration - in seconds

isLastChunk - Is this the last recorded chunk in the current session (i.e. following a stream stop event)

archive

public static LiveStreamService.ArchiveLiveStreamBuilder archive(String liveEntryId,
                                                                 String vodEntryId)

Archive a live entry which was recorded

Parameters:

liveEntryId -

vodEntryId -

authenticate

public static LiveStreamService.AuthenticateLiveStreamBuilder authenticate(String entryId,
                                                                           String token)

authenticate

public static LiveStreamService.AuthenticateLiveStreamBuilder authenticate(String entryId,
                                                                           String token,
                                                                           String hostname)

authenticate

public static LiveStreamService.AuthenticateLiveStreamBuilder authenticate(String entryId,
                                                                           String token,
                                                                           String hostname,
                                                                           EntryServerNodeType mediaServerIndex)

authenticate

public static LiveStreamService.AuthenticateLiveStreamBuilder authenticate(String entryId,
                                                                           String token,
                                                                           String hostname,
                                                                           EntryServerNodeType mediaServerIndex,
                                                                           String applicationName)

Authenticate live-stream entry against stream token and partner limitations

Parameters:

entryId - Live stream entry id

token - Live stream broadcasting token

hostname - Media server host name

mediaServerIndex - Media server index primary / secondary

applicationName - the application to which entry is being broadcast

createPeriodicSyncPoints

public static LiveStreamService.CreatePeriodicSyncPointsLiveStreamBuilder createPeriodicSyncPoints(String entryId,
                                                                                                   int interval,
                                                                                                   int duration)

Creates periodic metadata sync-point events on a live stream

Parameters:

entryId - Kaltura live-stream entry id

interval - Events interval in seconds

duration - Duration in seconds

createRecordedEntry

public static LiveStreamService.CreateRecordedEntryLiveStreamBuilder createRecordedEntry(String entryId,
                                                                                         EntryServerNodeType mediaServerIndex,
                                                                                         EntryServerNodeStatus liveEntryStatus)

Create recorded entry id if it doesn't exist and make sure it happens on the DC that the live entry was created on.

Parameters:

entryId - Live entry id

mediaServerIndex - Media server index primary / secondary

liveEntryStatus - the status KalturaEntryServerNodeStatus::PLAYABLE | KalturaEntryServerNodeStatus::BROADCASTING

delete

public static LiveStreamService.DeleteLiveStreamBuilder delete(String entryId)

Delete a live stream entry.

Parameters:

entryId - Live stream entry id to delete

finishConf

public static LiveStreamService.FinishConfLiveStreamBuilder finishConf(String entryId)

finishConf

public static LiveStreamService.FinishConfLiveStreamBuilder finishConf(String entryId,
                                                                       int serverNodeId)

When the conf is finished this API should be called.

Parameters:

entryId -

serverNodeId -

get

public static LiveStreamService.GetLiveStreamBuilder get(String entryId)

get

public static LiveStreamService.GetLiveStreamBuilder get(String entryId,
                                                         int version)

Get live stream entry by ID.

Parameters:

entryId - Live stream entry id

version - Desired version of the data

getDetails

public static LiveStreamService.GetDetailsLiveStreamBuilder getDetails(String id)

Delivering the status of a live stream (on-air/offline) if it is possible

Parameters:

id - ID of the live stream entry

isLive

public static LiveStreamService.IsLiveLiveStreamBuilder isLive(String id)

isLive

public static LiveStreamService.IsLiveLiveStreamBuilder isLive(String id,
                                                               PlaybackProtocol protocol)

Delivering the status of a live stream (on-air/offline) if it is possible

Parameters:

id - ID of the live stream

protocol - protocol of the stream to test.

list

public static LiveStreamService.ListLiveStreamBuilder list()

list

public static LiveStreamService.ListLiveStreamBuilder list(LiveStreamEntryFilter filter)

list

public static LiveStreamService.ListLiveStreamBuilder list(LiveStreamEntryFilter filter,
                                                           FilterPager pager)

List live stream entries by filter with paging support.

Parameters:

filter - live stream entry filter

pager - Pager

regenerateStreamToken

public static LiveStreamService.RegenerateStreamTokenLiveStreamBuilder regenerateStreamToken(String entryId)

Regenerate new secure token for liveStream

Parameters:

entryId - Live stream entry id to regenerate secure token for

registerConf

public static LiveStreamService.RegisterConfLiveStreamBuilder registerConf(String entryId)

Mark that the conference has actually started

Parameters:

entryId -

registerMediaServer

public static LiveStreamService.RegisterMediaServerLiveStreamBuilder registerMediaServer(String entryId,
                                                                                         String hostname,
                                                                                         EntryServerNodeType mediaServerIndex)

registerMediaServer

public static LiveStreamService.RegisterMediaServerLiveStreamBuilder registerMediaServer(String entryId,
                                                                                         String hostname,
                                                                                         EntryServerNodeType mediaServerIndex,
                                                                                         String applicationName)

registerMediaServer

public static LiveStreamService.RegisterMediaServerLiveStreamBuilder registerMediaServer(String entryId,
                                                                                         String hostname,
                                                                                         EntryServerNodeType mediaServerIndex,
                                                                                         String applicationName,
                                                                                         EntryServerNodeStatus liveEntryStatus)

registerMediaServer

public static LiveStreamService.RegisterMediaServerLiveStreamBuilder registerMediaServer(String entryId,
                                                                                         String hostname,
                                                                                         EntryServerNodeType mediaServerIndex,
                                                                                         String applicationName,
                                                                                         EntryServerNodeStatus liveEntryStatus,
                                                                                         boolean shouldCreateRecordedEntry)

Register media server to live entry

Parameters:

entryId - Live entry id

hostname - Media server host name

mediaServerIndex - Media server index primary / secondary

applicationName - the application to which entry is being broadcast

liveEntryStatus - the status KalturaEntryServerNodeStatus::PLAYABLE | KalturaEntryServerNodeStatus::BROADCASTING

shouldCreateRecordedEntry -

removeLiveStreamPushPublishConfiguration

public static LiveStreamService.RemoveLiveStreamPushPublishConfigurationLiveStreamBuilder removeLiveStreamPushPublishConfiguration(String entryId,
                                                                                                                                   PlaybackProtocol protocol)

Remove push publish configuration from entry

Parameters:

entryId -

protocol -

setRecordedContent

public static LiveStreamService.SetRecordedContentLiveStreamBuilder setRecordedContent(String entryId,
                                                                                       EntryServerNodeType mediaServerIndex,
                                                                                       DataCenterContentResource resource,
                                                                                       double duration)

setRecordedContent

public static LiveStreamService.SetRecordedContentLiveStreamBuilder setRecordedContent(String entryId,
                                                                                       EntryServerNodeType mediaServerIndex,
                                                                                       DataCenterContentResource resource,
                                                                                       double duration,
                                                                                       String recordedEntryId)

setRecordedContent

public static LiveStreamService.SetRecordedContentLiveStreamBuilder setRecordedContent(String entryId,
                                                                                       EntryServerNodeType mediaServerIndex,
                                                                                       DataCenterContentResource resource,
                                                                                       double duration,
                                                                                       String recordedEntryId,
                                                                                       int flavorParamsId)

Set recorded video to live entry

Parameters:

entryId - Live entry id

mediaServerIndex -

resource -

duration - in seconds

recordedEntryId - Recorded entry Id

flavorParamsId - Recorded entry Id

unregisterMediaServer

public static LiveStreamService.UnregisterMediaServerLiveStreamBuilder unregisterMediaServer(String entryId,
                                                                                             String hostname,
                                                                                             EntryServerNodeType mediaServerIndex)

Unregister media server from live entry

Parameters:

entryId - Live entry id

hostname - Media server host name

mediaServerIndex - Media server index primary / secondary

update

public static LiveStreamService.UpdateLiveStreamBuilder update(String entryId,
                                                               LiveStreamEntry liveStreamEntry)

Update live stream entry. Only the properties that were set will be updated.

Parameters:

entryId - Live stream entry id to update

liveStreamEntry - Live stream entry metadata to update

updateOfflineThumbnailFromUrl

public static LiveStreamService.UpdateOfflineThumbnailFromUrlLiveStreamBuilder updateOfflineThumbnailFromUrl(String entryId,
                                                                                                             String url)

Update entry thumbnail using url

Parameters:

entryId - live stream entry id

url - file url

updateOfflineThumbnailJpeg

public static LiveStreamService.UpdateOfflineThumbnailJpegLiveStreamBuilder updateOfflineThumbnailJpeg(String entryId,
                                                                                                       File fileData)

updateOfflineThumbnailJpeg

public static LiveStreamService.UpdateOfflineThumbnailJpegLiveStreamBuilder updateOfflineThumbnailJpeg(String entryId,
                                                                                                       InputStream fileData,
                                                                                                       String fileDataMimeType,
                                                                                                       String fileDataName,
                                                                                                       long fileDataSize)

updateOfflineThumbnailJpeg

public static LiveStreamService.UpdateOfflineThumbnailJpegLiveStreamBuilder updateOfflineThumbnailJpeg(String entryId,
                                                                                                       FileInputStream fileData,
                                                                                                       String fileDataMimeType,
                                                                                                       String fileDataName)

updateOfflineThumbnailJpeg

public static LiveStreamService.UpdateOfflineThumbnailJpegLiveStreamBuilder updateOfflineThumbnailJpeg(String entryId,
                                                                                                       FileHolder fileData)

Update live stream entry thumbnail using a raw jpeg file

Parameters:

entryId - live stream entry id

fileData - Jpeg file data

validateRegisteredMediaServers

public static LiveStreamService.ValidateRegisteredMediaServersLiveStreamBuilder validateRegisteredMediaServers(String entryId)

Validates all registered media servers

Parameters:

entryId - Live entry id