Package com.kaltura.client.services

Class LiveChannelService

java.lang.Object

com.kaltura.client.services.LiveChannelService

public class LiveChannelService
extends Object

Live Channel service lets you manage live channels

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LiveChannelService.AddLiveChannelBuilder
static class	LiveChannelService.AppendRecordingLiveChannelBuilder
static class	LiveChannelService.CreateRecordedEntryLiveChannelBuilder
static class	LiveChannelService.DeleteLiveChannelBuilder
static class	LiveChannelService.GetLiveChannelBuilder
static class	LiveChannelService.IsLiveLiveChannelBuilder
static class	LiveChannelService.ListLiveChannelBuilder
static class	LiveChannelService.RegisterMediaServerLiveChannelBuilder
static class	LiveChannelService.SetRecordedContentLiveChannelBuilder
static class	LiveChannelService.UnregisterMediaServerLiveChannelBuilder
static class	LiveChannelService.UpdateLiveChannelBuilder
static class	LiveChannelService.ValidateRegisteredMediaServersLiveChannelBuilder

Constructor Summary

Constructors

Constructor	Description
LiveChannelService()

Method Summary

Modifier and Type	Method	Description
static LiveChannelService.AddLiveChannelBuilder	add(LiveChannel liveChannel)	Adds new live channel.
static LiveChannelService.AppendRecordingLiveChannelBuilder	appendRecording(String entryId, String assetId, EntryServerNodeType mediaServerIndex, DataCenterContentResource resource, double duration)
static LiveChannelService.AppendRecordingLiveChannelBuilder	appendRecording(String entryId, String assetId, EntryServerNodeType mediaServerIndex, DataCenterContentResource resource, double duration, boolean isLastChunk)	Append recorded video to live entry
static LiveChannelService.CreateRecordedEntryLiveChannelBuilder	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 LiveChannelService.DeleteLiveChannelBuilder	delete(String id)	Delete a live channel.
static LiveChannelService.GetLiveChannelBuilder	get(String id)	Get live channel by ID.
static LiveChannelService.IsLiveLiveChannelBuilder	isLive(String id)	Delivering the status of a live channel (on-air/offline)
static LiveChannelService.ListLiveChannelBuilder	list()
static LiveChannelService.ListLiveChannelBuilder	list(LiveChannelFilter filter)
static LiveChannelService.ListLiveChannelBuilder	list(LiveChannelFilter filter, FilterPager pager)	List live channels by filter with paging support.
static LiveChannelService.RegisterMediaServerLiveChannelBuilder	registerMediaServer(String entryId, String hostname, EntryServerNodeType mediaServerIndex)
static LiveChannelService.RegisterMediaServerLiveChannelBuilder	registerMediaServer(String entryId, String hostname, EntryServerNodeType mediaServerIndex, String applicationName)
static LiveChannelService.RegisterMediaServerLiveChannelBuilder	registerMediaServer(String entryId, String hostname, EntryServerNodeType mediaServerIndex, String applicationName, EntryServerNodeStatus liveEntryStatus)
static LiveChannelService.RegisterMediaServerLiveChannelBuilder	registerMediaServer(String entryId, String hostname, EntryServerNodeType mediaServerIndex, String applicationName, EntryServerNodeStatus liveEntryStatus, boolean shouldCreateRecordedEntry)	Register media server to live entry
static LiveChannelService.SetRecordedContentLiveChannelBuilder	setRecordedContent(String entryId, EntryServerNodeType mediaServerIndex, DataCenterContentResource resource, double duration)
static LiveChannelService.SetRecordedContentLiveChannelBuilder	setRecordedContent(String entryId, EntryServerNodeType mediaServerIndex, DataCenterContentResource resource, double duration, String recordedEntryId)
static LiveChannelService.SetRecordedContentLiveChannelBuilder	setRecordedContent(String entryId, EntryServerNodeType mediaServerIndex, DataCenterContentResource resource, double duration, String recordedEntryId, int flavorParamsId)	Set recorded video to live entry
static LiveChannelService.UnregisterMediaServerLiveChannelBuilder	unregisterMediaServer(String entryId, String hostname, EntryServerNodeType mediaServerIndex)	Unregister media server from live entry
static LiveChannelService.UpdateLiveChannelBuilder	update(String id, LiveChannel liveChannel)	Update live channel.
static LiveChannelService.ValidateRegisteredMediaServersLiveChannelBuilder	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

LiveChannelService

public LiveChannelService()

Method Detail

add

public static LiveChannelService.AddLiveChannelBuilder add(LiveChannel liveChannel)

Adds new live channel.

Parameters:

liveChannel - Live channel metadata

appendRecording

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

appendRecording

public static LiveChannelService.AppendRecordingLiveChannelBuilder 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)

createRecordedEntry

public static LiveChannelService.CreateRecordedEntryLiveChannelBuilder 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 LiveChannelService.DeleteLiveChannelBuilder delete(String id)

Delete a live channel.

Parameters:

id - Live channel id to delete

get

public static LiveChannelService.GetLiveChannelBuilder get(String id)

Get live channel by ID.

Parameters:

id - Live channel id

isLive

public static LiveChannelService.IsLiveLiveChannelBuilder isLive(String id)

Delivering the status of a live channel (on-air/offline)

Parameters:

id - ID of the live channel

list

public static LiveChannelService.ListLiveChannelBuilder list()

list

public static LiveChannelService.ListLiveChannelBuilder list(LiveChannelFilter filter)

list

public static LiveChannelService.ListLiveChannelBuilder list(LiveChannelFilter filter,
                                                             FilterPager pager)

List live channels by filter with paging support.

Parameters:

filter - live channel filter

pager - Pager

registerMediaServer

public static LiveChannelService.RegisterMediaServerLiveChannelBuilder registerMediaServer(String entryId,
                                                                                           String hostname,
                                                                                           EntryServerNodeType mediaServerIndex)

registerMediaServer

public static LiveChannelService.RegisterMediaServerLiveChannelBuilder registerMediaServer(String entryId,
                                                                                           String hostname,
                                                                                           EntryServerNodeType mediaServerIndex,
                                                                                           String applicationName)

registerMediaServer

public static LiveChannelService.RegisterMediaServerLiveChannelBuilder registerMediaServer(String entryId,
                                                                                           String hostname,
                                                                                           EntryServerNodeType mediaServerIndex,
                                                                                           String applicationName,
                                                                                           EntryServerNodeStatus liveEntryStatus)

registerMediaServer

public static LiveChannelService.RegisterMediaServerLiveChannelBuilder 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 -

setRecordedContent

public static LiveChannelService.SetRecordedContentLiveChannelBuilder setRecordedContent(String entryId,
                                                                                         EntryServerNodeType mediaServerIndex,
                                                                                         DataCenterContentResource resource,
                                                                                         double duration)

setRecordedContent

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

setRecordedContent

public static LiveChannelService.SetRecordedContentLiveChannelBuilder 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 LiveChannelService.UnregisterMediaServerLiveChannelBuilder 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 LiveChannelService.UpdateLiveChannelBuilder update(String id,
                                                                 LiveChannel liveChannel)

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

Parameters:

id - Live channel id to update

liveChannel - Live channel metadata to update

validateRegisteredMediaServers

public static LiveChannelService.ValidateRegisteredMediaServersLiveChannelBuilder validateRegisteredMediaServers(String entryId)

Validates all registered media servers

Parameters:

entryId - Live entry id