Navigate

Kaltura API DocumentationthumbAsset.generate

Try it out
post https://www.kaltura.com/api_v3/service/thumbasset/action/generate

Request Parameters

body:object
SchemaExample
object
entryId*:string
thumbParams*:object:KalturaThumbParams
backgroundColor:string
Hexadecimal value


cropHeight:integer
cropType:integer
Enum: RESIZE [1], RESIZE_WITH_PADDING [2], CROP [3], CROP_FROM_TOP [4], RESIZE_WITH_FORCE [5]
Enum Type: KalturaThumbCropType


cropWidth:integer
cropX:integer
cropY:integer
density:integer
The image density (dpi) for example: 72 or 96


format:string
Enum: _3GP [3gp], APPLEHTTP [applehttp], AVI [avi], BIF [bif], BMP [bmp], COPY [copy], FLV [flv], HLS [hls], ISMA [isma], ISMV [ismv], JPG [jpg], M2TS [m2ts], M4V [m4v], MKV [mkv], MOV [mov], MP3 [mp3], MP4 [mp4], MPEG [mpeg], MPEGTS [mpegts], MXF [mxf], OGG [ogg], OGV [ogv], PDF [pdf], PNG [png], SWF [swf], WAV [wav], WEBM [webm], WMA [wma], WMV [wmv], WVM [wvm]
Enum Type: KalturaContainerFormat


The container format of the Flavor Params


height:integer
interval:integer
interval in seconds for creating thumbnail


objectType:string
Enum: KalturaThumbParams, KalturaThumbParamsOutput
quality:integer
scaleHeight:number
scaleWidth:number
sourceParamsId:integer
Id of the flavor params or the thumbnail params to be used as source for the thumbnail creation


stripProfiles:boolean
Strip profiles and comments


videoOffset:number
videoOffsetInPercentage:integer
Create thumbnail from the videoLengthpercentage second


width:integer
KalturaThumbParams must also match all of:
object:KalturaAssetParams
KalturaThumbParams must also match any of:
object:KalturaThumbParamsobject:KalturaThumbParamsOutput
sourceAssetId:string

Response

Success

SchemaExample
object:KalturaThumbAsset
height:integer
readOnly


The height of the Flavor Asset


objectType:string
Enum: KalturaThumbAsset, KalturaTimedThumbAsset
status:integer
Enum: ERROR [-1], QUEUED [0], CAPTURING [1], READY [2], DELETED [3], IMPORTING [7], EXPORTING [9]
readOnly


Enum Type: KalturaThumbAssetStatus


The status of the asset


thumbParamsId:integer
insertOnly


The Flavor Params used to create this Flavor Asset


width:integer
readOnly


The width of the Flavor Asset


KalturaThumbAsset must also match all of:
object:KalturaAsset
KalturaThumbAsset must also match any of:
object:KalturaThumbAssetobject:KalturaTimedThumbAsset