Package | Description |
---|---|
com.canto.cumulus |
The base package of the Cumulus Java Classes.
|
com.canto.cumulus.db.permissions | |
com.canto.cumulus.db.subscriptions | |
com.canto.cumulus.db.trigger | |
com.canto.cumulus.keyword.service | |
com.canto.cumulus.mediadeliverycloud | |
com.canto.cumulus.prefs |
The Cumulus preferences package for accessing the Cumulus preferences.
|
com.canto.cumulus.ui |
The Cumulus application user interface classes.
|
com.canto.cumulus.utils |
The Cumulus utilities package.
|
com.canto.cumulus.video.cloud |
Modifier and Type | Class and Description |
---|---|
class |
CategoryItem
This class represents a category of a Cumulus catalog.
|
class |
RecordItem
This class represents a record in the
Cumulus.TABLE_NAME_ASSET_RECORDS table of a Cumulus catalog. |
Modifier and Type | Method and Description |
---|---|
Item |
RecordItemCollection.createItem()
Create a new RecordItem object.
|
Item |
ItemCollection.createItem()
Create a new item object.
|
Item |
RecordItemCollection.createItem(java.lang.String permissionTemplate)
Create a new RecordItem object.
|
Item |
ItemCollection.createItem(java.lang.String permissionTemplate)
Create a new item object.
|
Item |
RecordItemCollection.getItemByID(int itemID)
Return a RecordItem specified by ID.
|
Item |
ItemCollection.getItemByID(int itemID)
Return an item specified by ID.
|
Item |
MultiItemCollection.getItemByID(int catalogID,
int itemID)
Return an item specified by catalog ID and item ID.
|
Item |
MultiItemCollection.getItemByID(ItemIdentifier itemIdentifier)
Return an item specified by identifier.
|
Modifier and Type | Method and Description |
---|---|
java.util.Iterator<Item> |
MultiItemCollection.iterator()
Return an iterator that iterates over all items in this collection.
|
java.util.Iterator<Item> |
MultiCategoryItemCollection.iterator() |
java.util.Iterator<Item> |
ItemCollection.iterator()
Return an iterator that iterates over all items in this collection.
|
java.util.Iterator<Item> |
CategoryItemCollection.iterator()
Return an iterator that iterates over all category items in this collection using the tree hierarchy.
|
Modifier and Type | Method and Description |
---|---|
void |
ItemCollection.catalogAsset(Asset asset,
java.lang.String assetHandlingSet,
java.lang.String permissionTemplate,
java.util.EnumSet<CatalogingFlag> catalogingFlags,
Item additionalFieldValuesItem,
java.util.Map<GUID,MetadataTemplateEntry.ValueFillMode> additionalFieldValuesFillMode,
CatalogingListener<ItemCollection> catalogingListener)
Catalog a single asset to this collection.
|
void |
ItemCollection.catalogAssets(AssetCollection assetCollection,
java.lang.String assetHandlingSet,
java.lang.String permissionTemplate,
java.util.EnumSet<CatalogingFlag> catalogingFlags,
Item additionalFieldValuesItem,
java.util.Map<GUID,MetadataTemplateEntry.ValueFillMode> additionalFieldValuesFillMode,
CatalogingListener<ItemCollection> catalogingListener)
Catalog a collection of assets to this collection.
|
java.awt.image.BufferedImage |
Pixmap.getAsImage(CumulusSession session,
Item item,
boolean extendImageAreaToBoundingBox,
int maxSizeWidth,
int maxSizeHeight,
int rotation)
Return AWT image which optionally embeds the assets metadata tags.
|
byte[] |
Pixmap.getAsJPEG(Item item,
CumulusSession cumulusSession,
int maxWidth,
int maxHeight,
int rotation,
int quality)
Return JPEG image which optionally embeds the assets metadata tags.
|
byte[] |
Pixmap.getAsJPEG(Item item,
int maxSize,
int rotation,
int quality)
Return JPEG image which optionally embeds the assets metadata tags.
|
boolean |
UserContext.hasPermission(java.lang.String permission,
Item item)
Returns whether the current user has the specified permission on the given item either through the catalog permissions or by a permission being assigned
to the item itself.
|
Modifier and Type | Method and Description |
---|---|
void |
PermissionManager.applyPermissionTemplate(Item item,
PermissionTemplate permissionTemplate)
Applies the given permission template on to the given record.
|
Permissions |
PermissionManager.getPermissions(Item item)
Returns the permissions for the given record item.
|
PermissionsList |
PermissionManager.getPermissionsList(Item item)
Returns a permissions list containing only the permissions for the specified record item.
|
Modifier and Type | Method and Description |
---|---|
void |
SubscriptionManager.addSubscription(Item item)
Subscribe to the given item.
|
java.util.Set<java.lang.String> |
SubscriptionManager.getSubscriptions(Item item)
Returns all user UIDs subscribed to the given item.
|
boolean |
SubscriptionManager.hasSubscription(Item item)
Returns whether the current user has a subscription for the given item.
|
void |
SubscriptionManager.removeSubscription(Item item)
Unsubscribe from the given item.
|
boolean |
SubscriptionManager.supportsSubscriptions(Item item)
Returns whether the current item supports subscriptions.
|
Modifier and Type | Method and Description |
---|---|
Item |
Binding.getItem()
Returns the item of this binding if bound to an item.
|
Modifier and Type | Method and Description |
---|---|
void |
TriggerManager.addItemTrigger(Item item,
Trigger trigger)
Adds the given trigger as a trigger for the specified item.
|
Binding |
TriggerManager.createBinding(Item item)
Returns a binding for the given item.
|
java.util.Collection<Trigger> |
TriggerManager.getItemTriggers(Item item)
Returns a collection of all existing triggers for the given item.
|
void |
TriggerManager.removeItemTrigger(Item item,
Trigger trigger)
Removes the given trigger as a trigger for the specified record.
|
Modifier and Type | Method and Description |
---|---|
java.util.Set<java.lang.String> |
AutoTaggingManager.getKeywords(Item item)
Returns the keywords for the given item from the configured provider.
|
java.util.Map<java.lang.Integer,java.util.Set<java.lang.String>> |
AutoTaggingManager.getLanguageKeywords(Item item)
Returns the keywords for the given item from the configured provider for the configured languages.
|
void |
AutoTaggingManager.tagItem(Item item)
Tags the given item with the keywords from the configured provider.
|
Modifier and Type | Method and Description |
---|---|
void |
MediaDeliveryCloudManager.addAllRenditionParameters(Item item,
JSONObject targetObject,
java.lang.String propertyName) |
void |
MediaDeliveryCloudManager.addMasterImageRegionOfInterest(Item item,
JSONObject targetObject,
java.lang.String propertyName) |
java.lang.String |
MediaDeliveryCloudManager.getImageRenditionURL(Item item,
RenditionParameters parameters)
Returns the URL to the image with the given rendering parameters in the media delivery cloud
|
java.lang.String |
MediaDeliveryCloudManager.getOriginalAssetURL(Item item)
Returns the URL to the original asset in the media delivery cloud
|
void |
MediaDeliveryCloudManager.unpublishMasterImage(Item item)
Deactivate the images for publishing.
|
void |
MediaDeliveryCloudManager.unpublishMasterImage(Item item,
boolean invalidateCDN)
Deactivate the images for publishing.
|
void |
MediaDeliveryCloudManager.unpublishOriginalAsset(Item item)
Deactivate the original asset for publishing.
|
void |
MediaDeliveryCloudManager.unpublishOriginalAsset(Item item,
boolean invalidateCDN)
Deactivate the original asset for publishing.
|
void |
MediaDeliveryCloudManager.updateMasterImageExpirationDate(Item item)
Update the images expiration date for publishing.
|
void |
MediaDeliveryCloudManager.updateMasterImageMetadata(Item item)
Update the images expiration date for publishing and other metadata such as crop parameters.
|
void |
MediaDeliveryCloudManager.updateOriginalAssetExpirationDate(Item item)
Update the original asset expiration date for publishing.
|
void |
MediaDeliveryCloudManager.uploadMasterImage(Item item)
Upload the master image to media delivery cloud.
|
void |
MediaDeliveryCloudManager.uploadOriginalAsset(Item item)
Upload the original asset to media delivery cloud.
|
Modifier and Type | Method and Description |
---|---|
void |
MetadataTemplate.fill(Item item)
Fill this template with the field values of the given item.
|
boolean |
RecordField.isVisibleForItem(Item item,
java.util.Map<java.lang.String,java.lang.Boolean> visibilityQueryResultCache)
Returns whether this field should be shown for the given item according to the visibility rules of this field.
|
void |
MetadataTemplate.processItem(Item item,
java.util.Set<GUID> restrictedFieldList,
boolean saveItem,
MetadataTemplate.ChangeCallback changeCallback)
Applies this template on the given item.
|
Modifier and Type | Method and Description |
---|---|
java.util.Iterator<Item> |
MultiItemPane.iterator()
Return an iterator that iterates over all selected items in this pane.
|
Modifier and Type | Method and Description |
---|---|
static ImagingPixmap |
ImagingPixmap.getPixmap(Item item)
Returns a new pixmap instance for the given record item that works on the preview of the related asset.
|
static ImagingPixmap |
ImagingPixmap.getPixmap(Item item,
Asset asset,
java.lang.String assetHandlingSet,
int page)
Returns a new pixmap instance for the given record item that works on the preview (generated by using the specified asset handling set) of the given
asset.
|
static ImagingPixmap |
ImagingPixmap.getPixmap(Item item,
java.lang.String assetHandlingSet)
Returns a new pixmap instance for the given record item that works on the preview (generated by using the specified asset handling set) of the related
asset.
|
static ImagingPixmap |
ImagingPixmap.getPixmap(Item item,
java.lang.String assetHandlingSet,
int version)
Returns a new pixmap instance for the given record item that works on the preview (generated by using the specified asset handling set) of the related
asset.
|
static ImagingPixmap |
ImagingPixmap.getPixmap(Item item,
java.lang.String assetHandlingSet,
int version,
int page)
Returns a new pixmap instance for the given record item that works on the preview (generated by using the specified asset handling set) of the related
asset.
|
Modifier and Type | Method and Description |
---|---|
VideoInformation |
VideoCloudManager.getInformation(Item item)
Return the information out of the Cumulus catalog.
|
java.util.Collection<VideoVariant> |
VideoCloudInformation.getVariants(Item item)
Return a list of variants with their name, URL and the encoding progress.
|
VideoCloudInformation |
VideoCloudManager.getVideoCloudInformation(Item item)
Return the information directly from the video cloud provider.
|
java.lang.String |
VideoCloudManager.getWebEmbedCode(Item item,
int width,
int height,
java.lang.String skin,
java.lang.String localeString)
Return the complete HTML+JavaScript code to embed a player in a web page.
|
void |
VideoCloudManager.logError(Item item,
java.lang.String message) |
void |
VideoCloudManager.logWarn(Item item,
java.lang.String message) |
boolean |
VideoCloudManager.needsToUploadVideo(Item item) |
void |
VideoCloudManager.removeVideo(Item item)
Deletes the video at the video cloud provider along with all of its variants.
|
void |
VideoCloudManager.requestPublishing(Item item)
Request a publishing of the video asset in it's video cloud provider.
|
void |
VideoCloudManager.requestRemoving(Item item)
Request to remove the video asset from it's video cloud provider.
|
void |
VideoCloudManager.requestUnpublishing(Item item)
Request to unpublish the video asset in it's video cloud provider.
|
void |
VideoCloudManager.requestUpload(Item item)
Request an upload of the video asset to the given provider.
|
void |
VideoCloudManager.startPublishingVideo(Item item)
Let the provider generate the variants for different devices/environments/bandwidth.
|
void |
VideoCloudManager.unpublishVideo(Item item)
Deactivate the video for publishing.
|
void |
VideoCloudManager.updateState(Item item)
Update the Video Cloud State value to "Uploaded" or "Published" if the Video Cloud provider says that the video is finished uploading or preparing
|
void |
VideoCloudManager.updateVideoCloudInformation(Item item)
Update the "valid from" and "valid to" date for a published video at the video cloud provider.
|
void |
VideoCloudManager.uploadMetadata(Item item,
java.util.Set<GUID> fieldsToUpdate)
Uploads metadata for a video at the video cloud provider.
|
void |
VideoCloudManager.uploadVideo(Item item,
java.lang.String providerID)
Upload the video to the given provider.
|
www.canto.com
Canto, the Canto logo, the Cumulus logo, and Cumulus are registered trademarks of Canto GmbH, registered in the U.S. and other countries.