mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-12-24 17:20:36 +00:00
docs: document environment variables
https://bugzilla.gnome.org/show_bug.cgi?id=773544
This commit is contained in:
parent
74a9f76d32
commit
2e1f69898b
3 changed files with 74 additions and 1 deletions
|
@ -61,7 +61,7 @@ EXAMPLE_CFILES =
|
||||||
HTML_IMAGES =
|
HTML_IMAGES =
|
||||||
|
|
||||||
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
|
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
|
||||||
content_files =
|
content_files = running.xml
|
||||||
|
|
||||||
# Other files to distribute.
|
# Other files to distribute.
|
||||||
extra_files =
|
extra_files =
|
||||||
|
|
|
@ -9,6 +9,11 @@
|
||||||
<title>GStreamer VA-API Plugins @GST_API_VERSION@ Plugins Reference Manual</title>
|
<title>GStreamer VA-API Plugins @GST_API_VERSION@ Plugins Reference Manual</title>
|
||||||
</bookinfo>
|
</bookinfo>
|
||||||
|
|
||||||
|
<chapter>
|
||||||
|
<title>gstremaer-vaapi Overview</title>
|
||||||
|
<xi:include href="running.xml"/>
|
||||||
|
</chapter>
|
||||||
|
|
||||||
<chapter>
|
<chapter>
|
||||||
<title>gstreamer-vaapi Elements</title>
|
<title>gstreamer-vaapi Elements</title>
|
||||||
<xi:include href="xml/element-vaapijpegdec.xml"/>
|
<xi:include href="xml/element-vaapijpegdec.xml"/>
|
||||||
|
|
68
docs/plugins/running.xml
Normal file
68
docs/plugins/running.xml
Normal file
|
@ -0,0 +1,68 @@
|
||||||
|
<?xml version="1.0"?>
|
||||||
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
|
||||||
|
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
|
||||||
|
<!ENTITY % version-entities SYSTEM "version.entities">
|
||||||
|
%version-entities;
|
||||||
|
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
|
||||||
|
]>
|
||||||
|
<refentry id="gstreamer-vaapi-running">
|
||||||
|
<refmeta>
|
||||||
|
<refentrytitle>Running GStreamer VAAPI Applications</refentrytitle>
|
||||||
|
</refmeta>
|
||||||
|
|
||||||
|
<refnamediv>
|
||||||
|
<refname>Running GStreamer VAAPI Applications</refname>
|
||||||
|
<refpurpose>
|
||||||
|
How to run GStreamer application with VAAPI elements.
|
||||||
|
</refpurpose>
|
||||||
|
</refnamediv>
|
||||||
|
|
||||||
|
<refsect1>
|
||||||
|
<title>Running GStreamer VAAPI Applications</title>
|
||||||
|
|
||||||
|
<refsect2>
|
||||||
|
<title>Environment variables</title>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
GStreamer-VAAPI inspects a few of environment variables to define it usage.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<formalpara id="GST_VAAPI_ALL_DRIVERS">
|
||||||
|
<title><envar>GST_VAAPI_ALL_DRIVERS</envar></title>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
This environment variable can be set, independently of its value, to disable
|
||||||
|
the drivers white list. By default only intel and mesa va drivers are loaded
|
||||||
|
if they are available. The rest are ignored. With this environment variable
|
||||||
|
defined, all the available va drivers are loaded, even if they are deprecated.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
</formalpara>
|
||||||
|
|
||||||
|
<formalpara id="LIBVA_DRIVER_NAME">
|
||||||
|
<title><envar>LIBVA_DRIVER_NAME</envar></title>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
This environment variable can be set with the drivers name to load. For
|
||||||
|
example, intel's driver is <userinput>i915</userinput>, meanwhile mesa is
|
||||||
|
<userinput>gallium</userinput>.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
</formalpara>
|
||||||
|
|
||||||
|
<formalpara id="LIBVA_DRIVERS_PATH">
|
||||||
|
<title><envar>LIBVA_DRIVERS_PATH</envar></title>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
This environment variable can be set to a colon-separated list of paths (or a
|
||||||
|
semicolon-separated list on Windows). libva will scan these paths for va
|
||||||
|
drivers.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
</formalpara>
|
||||||
|
|
||||||
|
</refsect2>
|
||||||
|
|
||||||
|
</refsect1>
|
||||||
|
|
||||||
|
</refentry>
|
Loading…
Reference in a new issue