Skip to contents

Set metadata tags in a video file

Source: R/tags.R
ov_set_video_meta.Rd

Requires that ffmpeg is available on your system path.

Usage

ov_set_video_meta(
  video_file,
  ...,
  movflags = FALSE,
  overwrite = FALSE,
  debug = FALSE
)

Arguments

video_file

string: path to the video file

...

: named values to set

movflags

logical: if TRUE, add "-movflags use_metadata_tags" to the command-line ffmpeg call. This allows arbitrary tag names to be used with mp4/m4v/mov video formats, but note that these may be stored in a manner that some video software cannot read. If movflags = FALSE, the supported video tag names (i.e. allowable names in the ... parameters) depend on the video file type

overwrite

logical: if TRUE overwrite the video_file, see Details

debug

logical: if TRUE, echo the ffmpeg output to the console

Value

The path to the new video file, which if overwrite = TRUE will be the input file, otherwise a file in the temporary directory

Details

This function creates a new video file with the specified metadata added. This is always a file in the temporary directory. If overwrite = TRUE, the original file is deleted and replaced with the new file.

Note that if movflags = FALSE, the supported video tag names (i.e. allowable names in the ... parameters) depend on the video file type.

See also

ov_get_video_meta()

Examples

if (FALSE) {
  newfile <- ov_set_video_meta(ov_example_video(), comment = "A comment")
  ov_get_video_meta(newfile)
}