tuber (version 2.0.0)

upload_caption: Upload a Caption Track

Description

Uploads a timed caption file using YouTube's resumable media-upload protocol. The request requires OAuth 2.0 authorization.

Usage

upload_caption(
  file,
  video_id,
  caption_name,
  language = "en-US",
  is_draft = FALSE,
  on_behalf_of_content_owner = NULL,
  open_url = FALSE,
  ...
)

Value

A list containing the final HTTP response, parsed caption resource, and video URL.

Arguments

file

Path to a caption file containing timing information.

video_id

YouTube video ID.

caption_name

Name of the caption track. YouTube limits names to 150 characters.

language

BCP 47 language tag for the caption track.

is_draft

Whether the caption track should remain a draft.

on_behalf_of_content_owner

Optional YouTube content-owner ID. This is only available to authorized YouTube content partners.

open_url

Whether to open the video's YouTube URL after a successful upload.

...

Additional arguments passed to [httr::POST()] and [httr::PUT()].

References

<https://developers.google.com/youtube/v3/docs/captions/insert>

Examples

if (FALSE) {
upload_caption(
  file = "captions.vtt",
  video_id = "dQw4w9WgXcQ",
  caption_name = "English"
)
}