Navigate

Kaltura API Documentationannotation.add

Allows you to add an annotation object associated with an entry

Try it out
post https://www.kaltura.com/api_v3/service/annotation_annotation/action/add

Request Parameters

body:object
SchemaExample
object
annotation*:object:KalturaCuePoint
abstract


copiedFrom:string
readOnly


createdAt:integer
readOnly


cuePointType:string
Enum: AD [adCuePoint.Ad], ANNOTATION [annotation.Annotation], CODE [codeCuePoint.Code], EVENT [eventCuePoint.Event], QUIZ_ANSWER [quiz.QUIZ_ANSWER], QUIZ_QUESTION [quiz.QUIZ_QUESTION], THUMB [thumbCuePoint.Thumb]
readOnly


Enum Type: KalturaCuePointType


entryId:string
insertOnly


forceStop:integer
Enum: NULL_VALUE [-1], FALSE_VALUE [0], TRUE_VALUE [1]
Enum Type: KalturaNullableBoolean


id:string
readOnly


intId:integer
readOnly


isMomentary:boolean
readOnly


objectType:string
Enum: KalturaAnnotation, KalturaAdCuePoint, KalturaAnswerCuePoint, KalturaCodeCuePoint, KalturaEventCuePoint, KalturaQuestionCuePoint, KalturaThumbCuePoint
partnerData:string
partnerId:integer
readOnly


partnerSortValue:integer
startTime:integer
Start time in milliseconds


status:integer
Enum: READY [1], DELETED [2], HANDLED [3], PENDING [4]
readOnly


Enum Type: KalturaCuePointStatus


systemName:string
tags:string
thumbOffset:integer
triggeredAt:integer
updatedAt:integer
readOnly


userId:string
KalturaCuePoint must also match any of:
object:KalturaAnnotationobject:KalturaAdCuePointobject:KalturaAnswerCuePointobject:KalturaCodeCuePointobject:KalturaEventCuePointobject:KalturaQuestionCuePointobject:KalturaThumbCuePoint

Response

Success

SchemaExample
object:KalturaAnnotation
childrenCount:integer
readOnly


Number of all descendants


depth:integer
readOnly


Depth in the tree


directChildrenCount:integer
readOnly


Number of children, first generation only.


duration:integer
readOnly


Duration in milliseconds


endTime:integer
End time in milliseconds


isPublic:integer
Enum: NULL_VALUE [-1], FALSE_VALUE [0], TRUE_VALUE [1]
Enum Type: KalturaNullableBoolean


Is the annotation public.


parentId:string
insertOnly


searchableOnEntry:integer
Enum: NULL_VALUE [-1], FALSE_VALUE [0], TRUE_VALUE [1]
Enum Type: KalturaNullableBoolean


Should the cue point get indexed on the entry.


text:string
KalturaAnnotation must also match all of:
object:KalturaCuePoint