VCC

Overview

The VCC service is used to create personalised videos and images for visitors. It takes a media file and optionally transforms it in some way before uploading it to a destination.

Transformations include rotating images, overlaying images on videos and changing the frame rate or size of a video.

Destinations include Amazon S3, YouTube, Giphy and custom web hooks.

The VCC service manages five resources: VCC asset, configuration, task, taskmeta and taskgroup. These are described below.

Configurations

You define your requirements by either creating a single VCC configuration or creating and chaining multiple together. For example a chain could resize a video, change its audio track and upload it to an Amazon S3 bucket. Each of these steps would require a configuration.

A VCC configuration provides all the information needed for an adapter to function. Adapters are known as either transformers or destinations. Transformer adapters take a file and change it in some way, for example scale a video. Destination adapters provide functionality to upload the file somewhere. See here for a list of available adapters.

There are lots of options in a configuration so it is strongly recommended you define everything in XPKit Portal.

Assets

Some configurations require a static asset in order to function. For example a configuration using the Video join adapter requires a video asset to prepend or append to the file. The VCC API provides an endpoint where assets such as these can be uploaded (maximum size 150MB). These can then be referenced in a configuration.

Tasks

Once a chain or configuration is created it can be used in a task. A task request provides a configuration name, file (image or video, maximum size 150MB), profile lookup information and any configuration overrides.

The file is processed asynchronously using the information in the configuration(s) and an activity is created containing a destination link to the final (transformed) file.

Task meta

Sometimes tasks fail, maybe your credentials for Amazon are no longer valid or there is an error in a configuration. The VCC API provides taskmeta endpoints where you can check on the status of tasks, retrigger them if they fail or cancel them if a problem cannot be resolved.

Task groups

A taskgroup runs a list of tasks in order. Much like a task a taskgroup request provides configuration names, files (total maximum size 150MB), profile lookup information and any configuration overrides.