Flag of Ukraine

Export files to YouTube

The /youtube/store Robot exports encoding results to YouTube.

Note that this Robot only accepts videos.

Installation

Since YouTube works with OAuth you will need to generate Template Credentials in order to use this Robot.

To change the title, description, category, or keywords per video we recommend to inject variables into your Template.

Adding a thumbnail image to your video

You can add a custom thumbnail to your video on YouTube by using our "as" syntax for the "use" parameter to supply both a video and an image to the step:

"my_store_on_youtube_step": {
  "use": [
    { "name": "video_encode_step", "as": "video" },
    { "name": "image_resize_step", "as": "image" },
  ],
  "robot"      : "/youtube/store",
  "credentials": "my_youtube_credentials",
  "title"      : "My dummy title",
  ...
},

If you receive an error such as "The authenticated user doesn't have permissions to upload and set custom video thumbnails" from YouTube, then you need to go into your YouTube account, try adding a custom thumbnail to one of your existing videos, and then you are prompted to add your phone number. Once you added that, the error will go away.

Parameters

  • use

    String / Array of Strings / Objectrequired

    Specifies 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, the /file/compress Robot 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 the use parameter:

      "use": {
        "steps": [
          ":original",
          "encoded",
          "resized"
        ],
        "bundle_steps": true
      }
      

      This is also a crucial parameter for the /video/adaptive Robot, 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 the /file/compress Robot example, you can set group_by_original to true, 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 the /media/playlist Robot 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 the name attribute of the HTML file input field tag for instance. When using a back-end SDK, it corresponds with myFieldName1 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, the /video/merge Robot 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 the /image/resize Robot 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

    Stringrequired

    The authentication Template credentials used for your YouTube account. You can generate them on the Template Credentials page. Simply add the name of your YouTube channel, and you will be redirected to a Google verification page. Accept the presented permissions and you will be good to go.

  • title

    Stringrequired

    The title of the video to be displayed on YouTube.

    Note that since the YouTube API requires titles to be within 80 characters, longer titles may be truncated.

  • description

    Stringrequired

    The description of the video to be displayed on YouTube. This can be up to 5000 characters, including \n for new-lines.

  • category

    Stringrequired

    The category to which this video will be assigned. These are the valid values: "autos & vehicles", "comedy", "education", "entertainment", "film & animation", "gaming", "howto & style", "music", "news & politics", "people & blogs", "pets & animals", "science & technology", "sports", "travel & events",

  • keywords

    Stringrequired

    Tags used to describe the video, separated by commas. These tags will also be displayed on YouTube.

  • visibility

    Stringrequired

    Defines the visibility of the uploaded video. This can be "public", "private", or "unlisted".

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

Uppy
20% off any plan for the Uppy community
Use the UPPY20 code when upgrading.
Sign up
tus
20% off any plan for the tus community
Use the TUS20 code when upgrading.
Sign up
Product Hunt
20% off any plan for Product Hunters
Use the PRH20 code when upgrading.
Sign up