Package com.kaltura.client.services

Class AnnotationService

java.lang.Object

com.kaltura.client.services.AnnotationService

public class AnnotationService
extends Object

Annotation service - Video Annotation

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AnnotationService.AddAnnotationBuilder
static class	AnnotationService.AddFromBulkAnnotationBuilder
static class	AnnotationService.CloneAnnotationBuilder
static class	AnnotationService.CountAnnotationBuilder
static class	AnnotationService.DeleteAnnotationBuilder
static class	AnnotationService.GetAnnotationBuilder
static class	AnnotationService.ListAnnotationBuilder
static class	AnnotationService.ServeBulkAnnotationBuilder
static class	AnnotationService.UpdateAnnotationBuilder
static class	AnnotationService.UpdateCuePointsTimesAnnotationBuilder
static class	AnnotationService.UpdateStatusAnnotationBuilder

Constructor Summary

Constructors

Constructor	Description
AnnotationService()

Method Summary

Modifier and Type	Method	Description
static AnnotationService.AddAnnotationBuilder	add(CuePoint annotation)	Allows you to add an annotation object associated with an entry
static AnnotationService.AddFromBulkAnnotationBuilder	addFromBulk(FileHolder fileData)	Allows you to add multiple cue points objects by uploading XML that contains multiple cue point definitions
static AnnotationService.AddFromBulkAnnotationBuilder	addFromBulk(File fileData)
static AnnotationService.AddFromBulkAnnotationBuilder	addFromBulk(FileInputStream fileData, String fileDataMimeType, String fileDataName)
static AnnotationService.AddFromBulkAnnotationBuilder	addFromBulk(InputStream fileData, String fileDataMimeType, String fileDataName, long fileDataSize)
static AnnotationService.CloneAnnotationBuilder	clone(String id, String entryId)
static AnnotationService.CloneAnnotationBuilder	clone(String id, String entryId, String parentId)	Clone cuePoint with id to given entry
static AnnotationService.CountAnnotationBuilder	count()
static AnnotationService.CountAnnotationBuilder	count(CuePointFilter filter)	count cue point objects by filter
static AnnotationService.DeleteAnnotationBuilder	delete(String id)	delete cue point by id, and delete all children cue points
static AnnotationService.GetAnnotationBuilder	get(String id)	Retrieve an CuePoint object by id
static AnnotationService.ListAnnotationBuilder	list()
static AnnotationService.ListAnnotationBuilder	list(CuePointFilter filter)
static AnnotationService.ListAnnotationBuilder	list(CuePointFilter filter, FilterPager pager)	List annotation objects by filter and pager
static AnnotationService.ServeBulkAnnotationBuilder	serveBulk()
static AnnotationService.ServeBulkAnnotationBuilder	serveBulk(CuePointFilter filter)
static AnnotationService.ServeBulkAnnotationBuilder	serveBulk(CuePointFilter filter, FilterPager pager)	Download multiple cue points objects as XML definitions
static AnnotationService.UpdateAnnotationBuilder	update(String id, CuePoint annotation)	Update annotation by id
static AnnotationService.UpdateCuePointsTimesAnnotationBuilder	updateCuePointsTimes(String id, int startTime)
static AnnotationService.UpdateCuePointsTimesAnnotationBuilder	updateCuePointsTimes(String id, int startTime, int endTime)
static AnnotationService.UpdateStatusAnnotationBuilder	updateStatus(String id, CuePointStatus status)	Update cuePoint status by id

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationService

public AnnotationService()

Method Detail

add

public static AnnotationService.AddAnnotationBuilder add(CuePoint annotation)

Allows you to add an annotation object associated with an entry

Parameters:

annotation -

addFromBulk

public static AnnotationService.AddFromBulkAnnotationBuilder addFromBulk(File fileData)

addFromBulk

public static AnnotationService.AddFromBulkAnnotationBuilder addFromBulk(InputStream fileData,
                                                                         String fileDataMimeType,
                                                                         String fileDataName,
                                                                         long fileDataSize)

addFromBulk

public static AnnotationService.AddFromBulkAnnotationBuilder addFromBulk(FileInputStream fileData,
                                                                         String fileDataMimeType,
                                                                         String fileDataName)

addFromBulk

public static AnnotationService.AddFromBulkAnnotationBuilder addFromBulk(FileHolder fileData)

Allows you to add multiple cue points objects by uploading XML that contains multiple cue point definitions

Parameters:

fileData -

clone

public static AnnotationService.CloneAnnotationBuilder clone(String id,
                                                             String entryId)

clone

public static AnnotationService.CloneAnnotationBuilder clone(String id,
                                                             String entryId,
                                                             String parentId)

Clone cuePoint with id to given entry

Parameters:

id -

entryId -

parentId -

count

public static AnnotationService.CountAnnotationBuilder count()

count

public static AnnotationService.CountAnnotationBuilder count(CuePointFilter filter)

count cue point objects by filter

Parameters:

filter -

delete

public static AnnotationService.DeleteAnnotationBuilder delete(String id)

delete cue point by id, and delete all children cue points

Parameters:

id -

get

public static AnnotationService.GetAnnotationBuilder get(String id)

Retrieve an CuePoint object by id

Parameters:

id -

list

public static AnnotationService.ListAnnotationBuilder list()

list

public static AnnotationService.ListAnnotationBuilder list(CuePointFilter filter)

list

public static AnnotationService.ListAnnotationBuilder list(CuePointFilter filter,
                                                           FilterPager pager)

List annotation objects by filter and pager

Parameters:

filter -

pager -

serveBulk

public static AnnotationService.ServeBulkAnnotationBuilder serveBulk()

serveBulk

public static AnnotationService.ServeBulkAnnotationBuilder serveBulk(CuePointFilter filter)

serveBulk

public static AnnotationService.ServeBulkAnnotationBuilder serveBulk(CuePointFilter filter,
                                                                     FilterPager pager)

Download multiple cue points objects as XML definitions

Parameters:

filter -

pager -

update

public static AnnotationService.UpdateAnnotationBuilder update(String id,
                                                               CuePoint annotation)

Update annotation by id

Parameters:

id -

annotation -

updateCuePointsTimes

public static AnnotationService.UpdateCuePointsTimesAnnotationBuilder updateCuePointsTimes(String id,
                                                                                           int startTime)

updateCuePointsTimes

public static AnnotationService.UpdateCuePointsTimesAnnotationBuilder updateCuePointsTimes(String id,
                                                                                           int startTime,
                                                                                           int endTime)

updateStatus

public static AnnotationService.UpdateStatusAnnotationBuilder updateStatus(String id,
                                                                           CuePointStatus status)

Update cuePoint status by id

Parameters:

id -

status -