LinuxCommandLibrary

gst-install

Install GStreamer plugins and related packages

SYNOPSIS

gst-install [OPTIONS] [FILES...]

PARAMETERS

-h, --help
    Show help options.

-d, --destdir=DIRECTORY
    Install files into a specific directory (DESTDIR).

-p, --package=PACKAGE
    Install files into a package directory (PACKAGE).

-s, --sysconfdir=SYSCONFDIR
    Install files into the system configuration directory (SYSCONFDIR).

-l, --libdir=LIBDIR
    Install files into the library directory (LIBDIR).

-i, --includedir=INCLUDEDIR
    Install files into the include directory (INCLUDEDIR).

-m, --mandir=MANDIR
    Install files into the man page directory (MANDIR).

-n, --no-modify-gstreamer-plugin-dirs
    Don't modify the GStreamer plugin directories configuration.

-f, --force
    Force installation, overwrite existing files.

-v, --verbose
    Be verbose.

DESCRIPTION

The `gst-install` command is used to install GStreamer elements and plugins on a system. It typically copies the plugin libraries (`.so` files) to the appropriate GStreamer plugin directory, allowing GStreamer applications to discover and use them. `gst-install` simplifies the plugin installation process by handling the details of placing files in the correct locations and updating the GStreamer plugin cache. The command is often employed after building plugins from source to make them accessible to GStreamer. It handles the copying and registration of element rank files as well.

Using `gst-install` ensures that plugins are installed in a standard way, making them easier to manage and maintain. It streamlines the process of making GStreamer components available for use in multimedia applications. Most distributions handle this process for you, but it is important to understand how plugins are installed and registered.

CAVEATS

The specific options and behavior of `gst-install` may vary slightly depending on the version of GStreamer and the build system used. It's important to consult the GStreamer documentation for the specific version you are using. Incorrect usage can lead to plugins not being discovered by GStreamer.

PLUGIN DISCOVERY

GStreamer searches for plugins in directories listed in the `GST_PLUGIN_PATH` environment variable and the system's default plugin directories. `gst-install` typically places plugins in one of these recognized locations, or updates the path list to allow them to be discovered.

PLUGIN REGISTRATION

After a plugin is installed, GStreamer needs to be aware of its existence. The `gst-install` command might trigger a plugin cache update, allowing GStreamer to scan the installed plugin directory and register the newly installed plugins. Use gst-inspect-1.0 to check if GStreamer discovers the installed plugin.

HISTORY

The `gst-install` command is part of the GStreamer build system. It arose as a utility to simplify the installation of GStreamer plugins after they have been built from source. Before the dedicated `gst-install`, manual copying of plugin libraries and updating plugin cache were necessary. The command automates this process, making plugin deployment simpler and less error-prone. The usage has continued from early versions of Gstreamer.

SEE ALSO

Copied to clipboard