Package com.kaltura.client.services

Class ThumbAssetService

java.lang.Object

com.kaltura.client.services.ThumbAssetService

public class ThumbAssetService
extends Object

Retrieve information and invoke actions on Thumb Asset

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ThumbAssetService.AddFromImageThumbAssetBuilder
static class	ThumbAssetService.AddFromUrlThumbAssetBuilder
static class	ThumbAssetService.AddThumbAssetBuilder
static class	ThumbAssetService.DeleteThumbAssetBuilder
static class	ThumbAssetService.ExportThumbAssetBuilder
static class	ThumbAssetService.GenerateByEntryIdThumbAssetBuilder
static class	ThumbAssetService.GenerateThumbAssetBuilder
static class	ThumbAssetService.GetByEntryIdThumbAssetBuilder
static class	ThumbAssetService.GetRemotePathsThumbAssetBuilder
static class	ThumbAssetService.GetThumbAssetBuilder
static class	ThumbAssetService.GetUrlThumbAssetBuilder
static class	ThumbAssetService.ListThumbAssetBuilder
static class	ThumbAssetService.RegenerateThumbAssetBuilder
static class	ThumbAssetService.ServeByEntryIdThumbAssetBuilder
static class	ThumbAssetService.ServeThumbAssetBuilder
static class	ThumbAssetService.SetAsDefaultThumbAssetBuilder
static class	ThumbAssetService.SetContentThumbAssetBuilder
static class	ThumbAssetService.UpdateThumbAssetBuilder

Constructor Summary

Constructors

Constructor	Description
ThumbAssetService()

Method Summary

Modifier and Type	Method	Description
static ThumbAssetService.AddThumbAssetBuilder	add(String entryId, ThumbAsset thumbAsset)	Add thumbnail asset
static ThumbAssetService.AddFromImageThumbAssetBuilder	addFromImage(String entryId, FileHolder fileData)
static ThumbAssetService.AddFromImageThumbAssetBuilder	addFromImage(String entryId, File fileData)
static ThumbAssetService.AddFromImageThumbAssetBuilder	addFromImage(String entryId, FileInputStream fileData, String fileDataMimeType, String fileDataName)
static ThumbAssetService.AddFromImageThumbAssetBuilder	addFromImage(String entryId, InputStream fileData, String fileDataMimeType, String fileDataName, long fileDataSize)
static ThumbAssetService.AddFromUrlThumbAssetBuilder	addFromUrl(String entryId, String url)
static ThumbAssetService.DeleteThumbAssetBuilder	delete(String thumbAssetId)
static ThumbAssetService.ExportThumbAssetBuilder	export(String assetId, int storageProfileId)	manually export an asset
static ThumbAssetService.GenerateThumbAssetBuilder	generate(String entryId, ThumbParams thumbParams)
static ThumbAssetService.GenerateThumbAssetBuilder	generate(String entryId, ThumbParams thumbParams, String sourceAssetId)
static ThumbAssetService.GenerateByEntryIdThumbAssetBuilder	generateByEntryId(String entryId, int destThumbParamsId)
static ThumbAssetService.GetThumbAssetBuilder	get(String thumbAssetId)
static ThumbAssetService.GetByEntryIdThumbAssetBuilder	getByEntryId(String entryId)
static ThumbAssetService.GetRemotePathsThumbAssetBuilder	getRemotePaths(String id)	Get remote storage existing paths for the asset
static ThumbAssetService.GetUrlThumbAssetBuilder	getUrl(String id)
static ThumbAssetService.GetUrlThumbAssetBuilder	getUrl(String id, int storageId)
static ThumbAssetService.GetUrlThumbAssetBuilder	getUrl(String id, int storageId, ThumbParams thumbParams)	Get download URL for the asset
static ThumbAssetService.ListThumbAssetBuilder	list()
static ThumbAssetService.ListThumbAssetBuilder	list(AssetFilter filter)
static ThumbAssetService.ListThumbAssetBuilder	list(AssetFilter filter, FilterPager pager)	List Thumbnail Assets by filter and pager
static ThumbAssetService.RegenerateThumbAssetBuilder	regenerate(String thumbAssetId)
static ThumbAssetService.ServeThumbAssetBuilder	serve(String thumbAssetId)
static ThumbAssetService.ServeThumbAssetBuilder	serve(String thumbAssetId, int version)
static ThumbAssetService.ServeThumbAssetBuilder	serve(String thumbAssetId, int version, ThumbParams thumbParams)
static ThumbAssetService.ServeThumbAssetBuilder	serve(String thumbAssetId, int version, ThumbParams thumbParams, ThumbnailServeOptions options)	Serves thumbnail by its id
static ThumbAssetService.ServeByEntryIdThumbAssetBuilder	serveByEntryId(String entryId)
static ThumbAssetService.ServeByEntryIdThumbAssetBuilder	serveByEntryId(String entryId, int thumbParamId)	Serves thumbnail by entry id and thumbnail params id
static ThumbAssetService.SetAsDefaultThumbAssetBuilder	setAsDefault(String thumbAssetId)	Tags the thumbnail as DEFAULT_THUMB and removes that tag from all other thumbnail assets of the entry.
static ThumbAssetService.SetContentThumbAssetBuilder	setContent(String id, ContentResource contentResource)	Update content of thumbnail asset
static ThumbAssetService.UpdateThumbAssetBuilder	update(String id, ThumbAsset thumbAsset)	Update thumbnail asset

Methods inherited from class java.lang.Object

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

Constructor Detail

ThumbAssetService

public ThumbAssetService()

Method Detail

add

public static ThumbAssetService.AddThumbAssetBuilder add(String entryId,
                                                         ThumbAsset thumbAsset)

Add thumbnail asset

Parameters:

entryId -

thumbAsset -

addFromImage

public static ThumbAssetService.AddFromImageThumbAssetBuilder addFromImage(String entryId,
                                                                           File fileData)

addFromImage

public static ThumbAssetService.AddFromImageThumbAssetBuilder addFromImage(String entryId,
                                                                           InputStream fileData,
                                                                           String fileDataMimeType,
                                                                           String fileDataName,
                                                                           long fileDataSize)

addFromImage

public static ThumbAssetService.AddFromImageThumbAssetBuilder addFromImage(String entryId,
                                                                           FileInputStream fileData,
                                                                           String fileDataMimeType,
                                                                           String fileDataName)

addFromImage

public static ThumbAssetService.AddFromImageThumbAssetBuilder addFromImage(String entryId,
                                                                           FileHolder fileData)

addFromUrl

public static ThumbAssetService.AddFromUrlThumbAssetBuilder addFromUrl(String entryId,
                                                                       String url)

delete

public static ThumbAssetService.DeleteThumbAssetBuilder delete(String thumbAssetId)

export

public static ThumbAssetService.ExportThumbAssetBuilder export(String assetId,
                                                               int storageProfileId)

manually export an asset

Parameters:

assetId -

storageProfileId -

generate

public static ThumbAssetService.GenerateThumbAssetBuilder generate(String entryId,
                                                                   ThumbParams thumbParams)

generate

public static ThumbAssetService.GenerateThumbAssetBuilder generate(String entryId,
                                                                   ThumbParams thumbParams,
                                                                   String sourceAssetId)

generateByEntryId

public static ThumbAssetService.GenerateByEntryIdThumbAssetBuilder generateByEntryId(String entryId,
                                                                                     int destThumbParamsId)

get

public static ThumbAssetService.GetThumbAssetBuilder get(String thumbAssetId)

getByEntryId

public static ThumbAssetService.GetByEntryIdThumbAssetBuilder getByEntryId(String entryId)

getRemotePaths

public static ThumbAssetService.GetRemotePathsThumbAssetBuilder getRemotePaths(String id)

Get remote storage existing paths for the asset

Parameters:

id -

getUrl

public static ThumbAssetService.GetUrlThumbAssetBuilder getUrl(String id)

getUrl

public static ThumbAssetService.GetUrlThumbAssetBuilder getUrl(String id,
                                                               int storageId)

getUrl

public static ThumbAssetService.GetUrlThumbAssetBuilder getUrl(String id,
                                                               int storageId,
                                                               ThumbParams thumbParams)

Get download URL for the asset

Parameters:

id -

storageId -

thumbParams -

list

public static ThumbAssetService.ListThumbAssetBuilder list()

list

public static ThumbAssetService.ListThumbAssetBuilder list(AssetFilter filter)

list

public static ThumbAssetService.ListThumbAssetBuilder list(AssetFilter filter,
                                                           FilterPager pager)

List Thumbnail Assets by filter and pager

Parameters:

filter -

pager -

regenerate

public static ThumbAssetService.RegenerateThumbAssetBuilder regenerate(String thumbAssetId)

serve

public static ThumbAssetService.ServeThumbAssetBuilder serve(String thumbAssetId)

serve

public static ThumbAssetService.ServeThumbAssetBuilder serve(String thumbAssetId,
                                                             int version)

serve

public static ThumbAssetService.ServeThumbAssetBuilder serve(String thumbAssetId,
                                                             int version,
                                                             ThumbParams thumbParams)

serve

public static ThumbAssetService.ServeThumbAssetBuilder serve(String thumbAssetId,
                                                             int version,
                                                             ThumbParams thumbParams,
                                                             ThumbnailServeOptions options)

Serves thumbnail by its id

Parameters:

thumbAssetId -

version -

thumbParams -

options -

serveByEntryId

public static ThumbAssetService.ServeByEntryIdThumbAssetBuilder serveByEntryId(String entryId)

serveByEntryId

public static ThumbAssetService.ServeByEntryIdThumbAssetBuilder serveByEntryId(String entryId,
                                                                               int thumbParamId)

Serves thumbnail by entry id and thumbnail params id

Parameters:

entryId -

thumbParamId - if not set, default thumbnail will be used.

setAsDefault

public static ThumbAssetService.SetAsDefaultThumbAssetBuilder setAsDefault(String thumbAssetId)

Tags the thumbnail as DEFAULT_THUMB and removes that tag from all other thumbnail assets of the entry. Create a new file sync link on the entry thumbnail that points to the thumbnail asset file sync.

Parameters:

thumbAssetId -

setContent

public static ThumbAssetService.SetContentThumbAssetBuilder setContent(String id,
                                                                       ContentResource contentResource)

Update content of thumbnail asset

Parameters:

id -

contentResource -

update

public static ThumbAssetService.UpdateThumbAssetBuilder update(String id,
                                                               ThumbAsset thumbAsset)

Update thumbnail asset

Parameters:

id -

thumbAsset -