
Export files to Vimeo
🤖/vimeo/store exports encoding results to vimeo.
Note that this Robot only accepts videos.
Warning: Vimeo's API limits the number of concurrent uploads per minute by your Vimeo account plan type. To see how many videos can be uploaded at a time based on your Vimeo accounts type, click the following link. [{.alert .alert-warning}]
Installation
Since Vimeo works with OAuth you will need to generate Template Credentials in order to use this Robot.
To change the title
or description
per video we recommend to
inject variables into your Template.
Parameters
-
use
String / Array of Strings / ObjectrequiredSpecifies which Step(s) to use as input.
-
You can pick any names for Steps except
":original"
(reserved for user uploads handled by Transloadit) -
You can provide several Steps as input with arrays:
"use": [ ":original", "encoded", "resized" ]
💡 That’s likely all you need to know about
use
, but you can view advanced use cases:› Advanced use cases
-
Step bundling. Some Robots can gather several Step results for a single invocation. For example, 🤖/file/compress would normally create one archive for each file passed to it. If you'd set
bundle_steps
to true, however, it will create one archive containing all the result files from all Steps you give it. To enable bundling, provide an object like the one below to theuse
parameter:"use": { "steps": [ ":original", "encoded", "resized" ], "bundle_steps": true }
This is also a crucial parameter for 🤖/video/adaptive, otherwise you'll generate 1 playlist for each viewing quality.
Keep in mind that all input Steps must be present in your Template. If one of them is missing (for instance it is rejected by a filter), no result is generated because the Robot waits indefinitely for all input Steps to be finished.Here’s a demo that showcases Step bundling.
-
Group by original. Sticking with 🤖/file/compress example, you can set
group_by_original
totrue
, in order to create a separate archive for each of your uploaded or imported files, instead of creating one archive containing all originals (or one per resulting file). This is important for for 🤖/media/playlist where you'd typically set:"use": { "steps": [ "segmented" ], "bundle_steps": true, "group_by_original": true }
-
Fields. You can be more discriminatory by only using files that match a field name by setting the
fields
property. When this array is specified, the corresponding Step will only be executed for files submitted through one of the given field names, which correspond with the strings in thename
attribute of the HTML file input field tag for instance. When using a back-end SDK, it corresponds withmyFieldName1
in e.g.:$transloadit->addFile('myFieldName1', './chameleon.jpg')
.This parameter is set to
true
by default, meaning all fields are accepted.Example:
"use": { "steps": [ ":original" ], "fields": [ "myFieldName1" ] }
-
Use as. Sometimes Robots take several inputs. For instance, 🤖/video/merge can create a slideshow from audio and images. You can map different Steps to the appropriate inputs.
Example:
"use": { "steps": [ { "name": "audio_encoded", "as": "audio" }, { "name": "images_resized", "as": "image" } ] }
Sometimes the ordering is important, for instance, with our concat Robots. In these cases, you can add an index that starts at 1. You can also optionally filter by the multipart field name. Like in this example, where all files are coming from the same source (end-user uploads), but with different
<input>
names:Example:
"use": { "steps": [ { "name": ":original", "fields": "myFirstVideo", "as": "video_1" }, { "name": ":original", "fields": "mySecondVideo", "as": "video_2" }, { "name": ":original", "fields": "myThirdVideo", "as": "video_3" } ] }
For times when it is not apparent where we should put the file, you can use Assembly Variables to be specific. For instance, you may want to pass a text file to 🤖/image/resize to burn the text in an image, but you are burning multiple texts, so where do we put the text file? We specify it via
${use.text_1}
, to indicate the first text file that was passed.Example:
"watermarked": { "robot": "/image/resize", "use" : { "steps": [ { "name": "resized", "as": "base" }, { "name": "transcribed", "as": "text" }, ], }, "text": [ { "text" : "Hi there", "valign": "top", "align" : "left", }, { "text" : "From the 'transcribed' Step: ${use.text_1}", "valign" : "bottom", "align" : "right", "x_offset": 16, "y_offset": -10, } ] }
-
-
credentials
StringrequiredThe authentication Template Credentials used for your Vimeo account. You can generate them on the Template Credentials page. You will be redirected to a Vimeo verification page. Accept the presented permissions and you will be good to go.
-
title
StringrequiredThe title of the video to be displayed on Vimeo.
-
description
StringrequiredThe description of the video to be displayed on Vimeo.
-
acl
String ⋅ default:"anybody"
Controls access permissions for the video. Here are the valid values:
"anybody"
— anyone can access the video."contacts"
— only those who follow the owner on Vimeo can access the video."disable"
— the video is embeddable, but it's hidden on Vimeo and can't be played."nobody"
— no one except the owner can access the video."password"
— only those with the password can access the video."unlisted"
— only those with the private link can access the video."users"
— only Vimeo members can access the video.
-
password
StringThe password to access the video if
acl
is"password"
. -
showcases
Array of Strings ⋅ default:[]
An array of string IDs of showcases that you want to add the video to. The IDs can be found when browsing Vimeo. For example
https://vimeo.com/manage/showcases/[SHOWCASE_ID]/info
. -
downloadable
Boolean ⋅ default:false
Whether or not the video can be downloaded from the Vimeo website.
Only set this to
true
if you have unlocked this feature in your Vimeo accounting by upgrading to their "Pro" plan. If you use it while on their Freemium plan, the Vimeo API will return an"Invalid parameter supplied"
error. -
folder_uri
String ⋅ default:null
The URI of the folder to which the video is uploaded.
When visiting one of your folders, the URL is similar to
https://vimeo.com/manage/folders/xxxxxxxx
. The folder_uri would be"/folders/xxxxxxxx"
.
Note: The URLs in the result JSON already point to the file on your target storage platform, so you can just save that URL in your database.
Demos
Related blog posts
- Transloadit Milestones of 2021 January 31, 2022