unset_program: Forget the location of a dependency program

In tidymedia: Media File Preprocessing and Metadata for the 'tidyverse'

Forget the location of a dependency program

Description

unset_program() forgets the location that set_program() saved for a program. After that, find_ffmpeg() and the other ⁠find_*()⁠ functions look for the program on the PATH only.

Usage

unset_program(program)

Arguments

program

A string naming the program to forget. One of "ffmpeg", "ffprobe", "ffplay" or "mediainfo". There is no default, because the call deletes a file. A call that names no program gives an error.

Details

The call deletes the file that holds the location. It does not ask you to confirm first. It does not remove the program, and it does not change the PATH. A program on the PATH is still found afterwards.

If no location is saved for the program, the call gives a warning and returns FALSE. It does not give an error, because the program is already forgotten.

The call also clears a location saved by a version before 0.2.0. See the section "Locations saved by earlier versions" in find_ffmpeg().

Value

Invisibly, TRUE when the call removed a saved location, and FALSE when there was none to remove.

See Also

set_program() to save a location, and program_status() to see where the package finds each program.

Other program management functions: find_ffmpeg(), install_on_win(), program_status(), set_program()

Examples

## Not run: 
# Forget a location set_program() remembered, so that find_mediainfo() goes
# back to answering from the PATH
unset_program("mediainfo")

## End(Not run)

tidymedia documentation built on Oct. 11, 2026, 5:08 p.m.