com.canto.cumulus.video.cloud

Class VideoCloudManager

java.lang.Object

com.canto.cumulus.video.cloud.VideoCloudManager

public class VideoCloudManager
extends java.lang.Object

Video Cloud management class. This provides functionality to work with the Canto Video Cloud. It offers functions to request uploading of videos to the video cloud, retrieving information about a video both in Cumulus and the Video Cloud. It also offers functions to implement a video player that is based on the Video Cloud provider.

Since:

10.1.3

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VideoCloudManager.VideoCloudConfiguration

Field Summary

Fields

Modifier and Type	Field and Description
static long[]	CHUNK_UPLOAD_WAIT_RETRY_MILLIS

Method Summary

Methods

Modifier and Type	Method and Description
VideoCloudManager.VideoCloudConfiguration	getConfiguration()
VideoInformation	getInformation(Item item) Return the information out of the Cumulus catalog.
static VideoCloudManager	getInstance(Server server)
VideoCloudProvider	getProvider(java.lang.String providerID) Get a specific video cloud provider instance.
java.lang.String	getQueryToFindVideosInProgress() Return a query string that finds all videos that are in the state of being uploaded or published (the variants are generated).
java.lang.String	getQueryToFindVideosRecentlyFailed() Return a query string that finds all videos that have a recent (not older than 24 hours) error logged in the "VideoCloud Log" sub-table.
java.lang.String	getQueryToFindVideosToPublish() Return a query string that finds all videos that are requested to publish.
java.lang.String	getQueryToFindVideosToRemove() Return a query string that finds all videos that are requested to be removed from the Video Cloud.
java.lang.String	getQueryToFindVideosToUnpublish() Return a query string that finds all videos that are requested to be unpublished in the Video Cloud.
java.lang.String	getQueryToFindVideosToUpload() Return a query string that finds all videos that should be uploaded to the Video Cloud.
java.util.Collection<UploadQueueItem>	getUploadQueue()
VideoCloudInformation	getVideoCloudInformation(Item item) Return the information directly from the video cloud provider.
java.lang.String	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	logError(Item item, java.lang.String message)
void	logWarn(Item item, java.lang.String message)
boolean	needsToUploadVideo(Item item)
void	removeVideo(Item item) Deletes the video at the video cloud provider along with all of its variants.
void	removeVideo(java.lang.String videoID) Deletes the video at the video cloud provider along with all of its variants.
void	requestPublishing(Item item) Request a publishing of the video asset in it's video cloud provider.
void	requestRemoving(Item item) Request to remove the video asset from it's video cloud provider.
void	requestUnpublishing(Item item) Request to unpublish the video asset in it's video cloud provider.
void	requestUpload(Item item) Request an upload of the video asset to the given provider.
void	setProviderConfiguration(java.lang.String providerConfiguration)
void	startPublishingVideo(Item item) Let the provider generate the variants for different devices/environments/bandwidth.
void	unpublishVideo(Item item) Deactivate the video for publishing.
boolean	updatePlayerSkins(java.lang.String videoProviderID, int catalogID)
void	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	updateVideoCloudInformation(Item item) Update the "valid from" and "valid to" date for a published video at the video cloud provider.
void	uploadMetadata(Item item, java.util.Set<GUID> fieldsToUpdate) Uploads metadata for a video at the video cloud provider.
void	uploadVideo(Item item, java.lang.String providerID) Upload the video to the given provider.

Methods inherited from class java.lang.Object

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

Field Detail

CHUNK_UPLOAD_WAIT_RETRY_MILLIS

public static final long[] CHUNK_UPLOAD_WAIT_RETRY_MILLIS

Method Detail

getInstance

public static VideoCloudManager getInstance(Server server)

getProvider

public VideoCloudProvider getProvider(java.lang.String providerID)

Get a specific video cloud provider instance.

Parameters:

providerID - The GUID of the video cloud provider

Returns:

The instance of the requested video cloud provider

updatePlayerSkins

public boolean updatePlayerSkins(java.lang.String videoProviderID,
                        int catalogID)
                          throws java.io.IOException

Throws:

java.io.IOException

getWebEmbedCode

public java.lang.String 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. It returns null if the asset is not playable via the Video Cloud. This uses the Video Cloud field values to create the embed code to play the video in the given target size. Requirements for a successful web embed code: - "Video Cloud ID" has a value - The current date is within the range "Valid From" .. "Valid To" - The "Video Cloud State" has a value of "Published"

Parameters:

item - The asset record item

width - The target player width in pixels

height - The target player height in pixels

skin - The UI skin variant the player should be using

localeString - The preferred locale of the video playback language.

Returns:

The web embed code that implements a video player or null if the asset is not playable from the Video Cloud.

getInformation

public VideoInformation getInformation(Item item)

Return the information out of the Cumulus catalog.

Parameters:

item - The asset record item

Returns:

Information about the video asset or null if not applicable.

getVideoCloudInformation

public VideoCloudInformation getVideoCloudInformation(Item item)
                                               throws java.io.IOException

Return the information directly from the video cloud provider.

Parameters:

item - The asset record item

Returns:

Information about the video from the video cloud provider.

Throws:

java.io.IOException

requestUpload

public void requestUpload(Item item)
                   throws FieldNotFoundException

Request an upload of the video asset to the given provider. This only sets the "Video Cloud Request" field value to "Upload to Video Cloud" and wait for the Scheduler to perform the actual uploading.

Parameters:

item - The asset record item

Throws:

FieldNotFoundException

requestPublishing

public void requestPublishing(Item item)
                       throws FieldNotFoundException

Request a publishing of the video asset in it's video cloud provider. This only sets the "Video Cloud Request" field value to "Publish in Video Cloud" and wait for the Scheduler to perform the actual publishing.

Parameters:

item - The asset record item

Throws:

FieldNotFoundException

requestUnpublishing

public void requestUnpublishing(Item item)
                         throws FieldNotFoundException

Request to unpublish the video asset in it's video cloud provider. This only sets the "Video Cloud Request" field value to "Unpublish in Video Cloud" and wait for the Scheduler to perform the actual unpublishing.

Parameters:

item - The asset record item

Throws:

FieldNotFoundException

requestRemoving

public void requestRemoving(Item item)
                     throws FieldNotFoundException

Request to remove the video asset from it's video cloud provider. This only sets the "Video Cloud Request" field value to "Remove from Video Cloud" and wait for the Scheduler to perform the actual removing.

Parameters:

item - The asset record item

Throws:

FieldNotFoundException

getQueryToFindVideosToUpload

public java.lang.String getQueryToFindVideosToUpload()

Return a query string that finds all videos that should be uploaded to the Video Cloud. With the found items you may call uploadVideo(Item, String) to actually upload the video asset to the Video Cloud.

Returns:

the query string

getQueryToFindVideosToPublish

public java.lang.String getQueryToFindVideosToPublish()

Return a query string that finds all videos that are requested to publish. With the found items you may call startPublishingVideo(Item) to start the preparation process.

Returns:

the query string

getQueryToFindVideosInProgress

public java.lang.String getQueryToFindVideosInProgress()

Return a query string that finds all videos that are in the state of being uploaded or published (the variants are generated). With the found items you may call updateState(Item) to update the "Video Cloud State" field value accordingly.

Returns:

the query string

getQueryToFindVideosRecentlyFailed

public java.lang.String getQueryToFindVideosRecentlyFailed()

Return a query string that finds all videos that have a recent (not older than 24 hours) error logged in the "VideoCloud Log" sub-table.

Returns:

the query string

getQueryToFindVideosToUnpublish

public java.lang.String getQueryToFindVideosToUnpublish()

Return a query string that finds all videos that are requested to be unpublished in the Video Cloud. With the found items you may call unpublishVideo(Item) to unpublish them.

Returns:

the query string

getQueryToFindVideosToRemove

public java.lang.String getQueryToFindVideosToRemove()

Return a query string that finds all videos that are requested to be removed from the Video Cloud. With the found items you may call removeVideo(String) to remove them.

Returns:

the query string

needsToUploadVideo

public boolean needsToUploadVideo(Item item)

uploadVideo

public void uploadVideo(Item item,
               java.lang.String providerID)
                 throws java.io.IOException

Upload the video to the given provider. This function should be called by the Scheduler task for items that requested uploading the video asset. After successful upload this method updates the "Video Cloud State" field value. After uploading the provider may start generating the variants for playing the video.

Parameters:

item - The asset record item

providerID - The ID of the Video Cloud provider to use or null if the default Video Cloud provider should be used.

Throws:

java.io.IOException

uploadMetadata

public void uploadMetadata(Item item,
                  java.util.Set<GUID> fieldsToUpdate)
                    throws java.io.IOException

Uploads metadata for a video at the video cloud provider.

Parameters:

item - The item containing the metadata

fieldsToUpdate - The fields to update or null when all fields should be updated

Throws:

java.io.IOException

Since:

11.0.1

startPublishingVideo

public void startPublishingVideo(Item item)
                          throws java.io.IOException

Let the provider generate the variants for different devices/environments/bandwidth. You can get the progress of this by calling getVariants() and checking the progress information for each variant.

Parameters:

item - The asset record item

Throws:

java.io.IOException

updateVideoCloudInformation

public void updateVideoCloudInformation(Item item)
                                 throws java.io.IOException

Update the "valid from" and "valid to" date for a published video at the video cloud provider.

Parameters:

item - The asset record item

Throws:

java.io.IOException

updateState

public void updateState(Item item)
                 throws java.io.IOException

Update the Video Cloud State value to "Uploaded" or "Published" if the Video Cloud provider says that the video is finished uploading or preparing

Parameters:

item - The asset record item

Throws:

java.io.IOException

unpublishVideo

public void unpublishVideo(Item item)
                    throws java.io.IOException

Deactivate the video for publishing. Depending on the provider this may be solved differently. The idea is that calling startPublishingVideo() afterwards will be able to quickly switch it on again.

Parameters:

item - The asset record item

Throws:

java.io.IOException

removeVideo

public void removeVideo(Item item)
                 throws java.io.IOException

Deletes the video at the video cloud provider along with all of its variants.

Parameters:

item - The asset record item

Throws:

java.io.IOException

removeVideo

public void removeVideo(java.lang.String videoID)
                 throws java.io.IOException

Deletes the video at the video cloud provider along with all of its variants. The "Video Cloud ID" field value is provided (so it can be called from a trigger action after the item is already deleted).

Parameters:

videoID - The "Video Cloud ID" field value

Throws:

java.io.IOException

getUploadQueue

public java.util.Collection<UploadQueueItem> getUploadQueue()

setProviderConfiguration

public void setProviderConfiguration(java.lang.String providerConfiguration)

getConfiguration

public VideoCloudManager.VideoCloudConfiguration getConfiguration()

logError

public void logError(Item item,
            java.lang.String message)

logWarn

public void logWarn(Item item,
           java.lang.String message)