Package com.kaltura.client.services

Class CaptionAssetService

java.lang.Object

com.kaltura.client.services.CaptionAssetService

public class CaptionAssetService
extends Object

Retrieve information and invoke actions on caption Asset

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CaptionAssetService.AddCaptionAssetBuilder
static class	CaptionAssetService.DeleteCaptionAssetBuilder
static class	CaptionAssetService.ExportCaptionAssetBuilder
static class	CaptionAssetService.GetCaptionAssetBuilder
static class	CaptionAssetService.GetRemotePathsCaptionAssetBuilder
static class	CaptionAssetService.GetUrlCaptionAssetBuilder
static class	CaptionAssetService.ListCaptionAssetBuilder
static class	CaptionAssetService.ServeAsJsonCaptionAssetBuilder
static class	CaptionAssetService.ServeByEntryIdCaptionAssetBuilder
static class	CaptionAssetService.ServeCaptionAssetBuilder
static class	CaptionAssetService.ServeWebVTTCaptionAssetBuilder
static class	CaptionAssetService.SetAsDefaultCaptionAssetBuilder
static class	CaptionAssetService.SetContentCaptionAssetBuilder
static class	CaptionAssetService.UpdateCaptionAssetBuilder

Constructor Summary

Constructors

Constructor	Description
CaptionAssetService()

Method Summary

Modifier and Type	Method	Description
static CaptionAssetService.AddCaptionAssetBuilder	add(String entryId, CaptionAsset captionAsset)	Add caption asset
static CaptionAssetService.DeleteCaptionAssetBuilder	delete(String captionAssetId)
static CaptionAssetService.ExportCaptionAssetBuilder	export(String assetId, int storageProfileId)	manually export an asset
static CaptionAssetService.GetCaptionAssetBuilder	get(String captionAssetId)
static CaptionAssetService.GetRemotePathsCaptionAssetBuilder	getRemotePaths(String id)	Get remote storage existing paths for the asset
static CaptionAssetService.GetUrlCaptionAssetBuilder	getUrl(String id)
static CaptionAssetService.GetUrlCaptionAssetBuilder	getUrl(String id, int storageId)	Get download URL for the asset
static CaptionAssetService.ListCaptionAssetBuilder	list()
static CaptionAssetService.ListCaptionAssetBuilder	list(AssetFilter filter)
static CaptionAssetService.ListCaptionAssetBuilder	list(AssetFilter filter, FilterPager pager)	List caption Assets by filter and pager
static CaptionAssetService.ServeCaptionAssetBuilder	serve(String captionAssetId)	Serves caption by its id
static CaptionAssetService.ServeAsJsonCaptionAssetBuilder	serveAsJson(String captionAssetId)	Serves caption file as Json by its ID
static CaptionAssetService.ServeByEntryIdCaptionAssetBuilder	serveByEntryId(String entryId)
static CaptionAssetService.ServeByEntryIdCaptionAssetBuilder	serveByEntryId(String entryId, int captionParamId)	Serves caption by entry id and thumnail params id
static CaptionAssetService.ServeWebVTTCaptionAssetBuilder	serveWebVTT(String captionAssetId)
static CaptionAssetService.ServeWebVTTCaptionAssetBuilder	serveWebVTT(String captionAssetId, int segmentDuration)
static CaptionAssetService.ServeWebVTTCaptionAssetBuilder	serveWebVTT(String captionAssetId, int segmentDuration, int segmentIndex)
static CaptionAssetService.ServeWebVTTCaptionAssetBuilder	serveWebVTT(String captionAssetId, int segmentDuration, int segmentIndex, int localTimestamp)	Serves caption by its id converting it to segmented WebVTT
static CaptionAssetService.SetAsDefaultCaptionAssetBuilder	setAsDefault(String captionAssetId)	Markss the caption as default and removes that mark from all other caption assets of the entry.
static CaptionAssetService.SetContentCaptionAssetBuilder	setContent(String id, ContentResource contentResource)	Update content of caption asset
static CaptionAssetService.UpdateCaptionAssetBuilder	update(String id, CaptionAsset captionAsset)	Update caption asset

Methods inherited from class java.lang.Object

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

Constructor Detail

CaptionAssetService

public CaptionAssetService()

Method Detail

add

public static CaptionAssetService.AddCaptionAssetBuilder add(String entryId,
                                                             CaptionAsset captionAsset)

Add caption asset

Parameters:

entryId -

captionAsset -

delete

public static CaptionAssetService.DeleteCaptionAssetBuilder delete(String captionAssetId)

export

public static CaptionAssetService.ExportCaptionAssetBuilder export(String assetId,
                                                                   int storageProfileId)

manually export an asset

Parameters:

assetId -

storageProfileId -

get

public static CaptionAssetService.GetCaptionAssetBuilder get(String captionAssetId)

getRemotePaths

public static CaptionAssetService.GetRemotePathsCaptionAssetBuilder getRemotePaths(String id)

Get remote storage existing paths for the asset

Parameters:

id -

getUrl

public static CaptionAssetService.GetUrlCaptionAssetBuilder getUrl(String id)

getUrl

public static CaptionAssetService.GetUrlCaptionAssetBuilder getUrl(String id,
                                                                   int storageId)

Get download URL for the asset

Parameters:

id -

storageId -

list

public static CaptionAssetService.ListCaptionAssetBuilder list()

list

public static CaptionAssetService.ListCaptionAssetBuilder list(AssetFilter filter)

list

public static CaptionAssetService.ListCaptionAssetBuilder list(AssetFilter filter,
                                                               FilterPager pager)

List caption Assets by filter and pager

Parameters:

filter -

pager -

serve

public static CaptionAssetService.ServeCaptionAssetBuilder serve(String captionAssetId)

Serves caption by its id

Parameters:

captionAssetId -

serveAsJson

public static CaptionAssetService.ServeAsJsonCaptionAssetBuilder serveAsJson(String captionAssetId)

Serves caption file as Json by its ID

Parameters:

captionAssetId -

serveByEntryId

public static CaptionAssetService.ServeByEntryIdCaptionAssetBuilder serveByEntryId(String entryId)

serveByEntryId

public static CaptionAssetService.ServeByEntryIdCaptionAssetBuilder serveByEntryId(String entryId,
                                                                                   int captionParamId)

Serves caption by entry id and thumnail params id

Parameters:

entryId -

captionParamId - if not set, default caption will be used.

serveWebVTT

public static CaptionAssetService.ServeWebVTTCaptionAssetBuilder serveWebVTT(String captionAssetId)

serveWebVTT

public static CaptionAssetService.ServeWebVTTCaptionAssetBuilder serveWebVTT(String captionAssetId,
                                                                             int segmentDuration)

serveWebVTT

public static CaptionAssetService.ServeWebVTTCaptionAssetBuilder serveWebVTT(String captionAssetId,
                                                                             int segmentDuration,
                                                                             int segmentIndex)

serveWebVTT

public static CaptionAssetService.ServeWebVTTCaptionAssetBuilder serveWebVTT(String captionAssetId,
                                                                             int segmentDuration,
                                                                             int segmentIndex,
                                                                             int localTimestamp)

Serves caption by its id converting it to segmented WebVTT

Parameters:

captionAssetId -

segmentDuration -

segmentIndex -

localTimestamp -

setAsDefault

public static CaptionAssetService.SetAsDefaultCaptionAssetBuilder setAsDefault(String captionAssetId)

Markss the caption as default and removes that mark from all other caption assets of the entry.

Parameters:

captionAssetId -

setContent

public static CaptionAssetService.SetContentCaptionAssetBuilder setContent(String id,
                                                                           ContentResource contentResource)

Update content of caption asset

Parameters:

id -

contentResource -

update

public static CaptionAssetService.UpdateCaptionAssetBuilder update(String id,
                                                                   CaptionAsset captionAsset)

Update caption asset

Parameters:

id -

captionAsset -