source-git / mingw-gstreamer1

Clone
Source Code
GIT

Blame docs/gst/html/gst-running.html

c8 c8s master
  1.   9633508fe3a0cd76fc2337761b104a98cc169ca8
  2.   docs
  3.   gst
  4.   html
  5.   gst-running.html
Blob History Raw
Packit Service 963350
Packit Service 963350 
<html>
Packit Service 963350 
<head>
Packit Service 963350 
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit Service 963350 
<title>Running GStreamer Applications: GStreamer 1.0 Core Reference Manual</title>
Packit Service 963350 
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
Packit Service 963350 
<link rel="home" href="index.html" title="GStreamer 1.0 Core Reference Manual">
Packit Service 963350 
<link rel="up" href="gstreamer.html" title="GStreamer Overview">
Packit Service 963350 
<link rel="prev" href="gst-building.html" title="Building GStreamer and GStreamer Applications">
Packit Service 963350 
<link rel="next" href="libgstreamer.html" title="GStreamer Core Library">
Packit Service 963350 
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
Packit Service 963350 
<link rel="stylesheet" href="style.css" type="text/css">
Packit Service 963350 
</head>
Packit Service 963350 
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit Service 963350
Packit Service 963350
Packit Service 963350 
Home
Packit Service 963350 
Up
Packit Service 963350 
Prev
Packit Service 963350 
Next
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
Running GStreamer Applications
Packit Service 963350 
Running GStreamer Applications —
Packit Service 963350 
How to run and debug your GStreamer application
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
Running and debugging GStreamer Applications
Packit Service 963350
Packit Service 963350 
Environment variables
Packit Service 963350
Packit Service 963350 
GStreamer inspects a few of environment variables in addition to standard
Packit Service 963350 
variables like LANG, PATH or HOME.
Packit Service 963350
Packit Service 963350 
GST_PLUGIN_SYSTEM_PATH,
Packit Service 963350 
         GST_PLUGIN_SYSTEM_PATH_1_0. 
Packit Service 963350
Packit Service 963350 
This environment variable can be set to a colon-separated list of paths (or
Packit Service 963350 
semicolon-separated list on Windows).
Packit Service 963350 
If this variable is not set, GStreamer will fill in this list for you
Packit Service 963350 
with
Packit Service 963350
Packit Service 963350
    Packit Service 963350
    • Packit Service 963350 
    plug-ins in the user's home directory, or rather the user's "data home"
    Packit Service 963350 
    directory according to the xdg base dir specification. Usually this will be
    Packit Service 963350 
    a directory called
    Packit Service 963350 
    plugins inside the
    Packit Service 963350 
    .local/share/gstreamer-1.0 directory in
    Packit Service 963350 
    the user's home directory by default, though this search path may change if
    Packit Service 963350 
    the XDG_DATA_HOME environment variable is set.
    Packit Service 963350
    Packit Service 963350
    • Packit Service 963350 
    plug-ins installed system-wide.  On this system, they are stored in
    Packit Service 963350 
    /usr/local/lib/gstreamer-1.0.
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350 
    GStreamer will scan these paths for GStreamer plug-ins.  These plug-ins will
    Packit Service 963350 
    be loaded after the plug-ins in the GST_PLUGIN_PATH variable below.
    Packit Service 963350
    Packit Service 963350 
    The paths are scanned in the given order.  This allows a user to override
    Packit Service 963350 
    system-installed plug-ins with his own versions.
    Packit Service 963350
    Packit Service 963350 
    The GST_PLUGIN_SYSTEM_PATH_1_0 variant is useful if both the old GStreamer 0.10
    Packit Service 963350 
    version and the new GStreamer 1.0 version need to be pointed to new plugin
    Packit Service 963350 
    paths. The latter will use the _1_0 variant over the non-versioned one if
    Packit Service 963350 
    it is set.
    Packit Service 963350
    Packit Service 963350 
    Setting this variable to an empty string will cause GStreamer not to scan any
    Packit Service 963350 
    system paths at all for plug-ins.  This can be useful if you're running
    Packit Service 963350 
    uninstalled (for development purposes) or while running testsuites.
    Packit Service 963350
    Packit Service 963350 
    GST_PLUGIN_PATH, GST_PLUGIN_PATH_1_0. 
    Packit Service 963350 
    This environment variable can be set to a colon-separated list of paths (or a
    Packit Service 963350 
    semicolon-separated list on Windows).
    Packit Service 963350 
    GStreamer will scan these paths for GStreamer plug-ins.  These plug-ins will
    Packit Service 963350 
    be loaded in addition to, and before, the plug-ins in the system paths.
    Packit Service 963350
    Packit Service 963350 
    The GST_PLUGIN_PATH_1_0 variant is useful if both the old GStreamer 0.10
    Packit Service 963350 
    version and the new GStreamer 1.0 version need to be pointed to new plugin
    Packit Service 963350 
    paths. The latter will use the _1_0 variant over the non-versioned one if
    Packit Service 963350 
    it is set.
    Packit Service 963350
    Packit Service 963350 
    GST_DEBUG. 
    Packit Service 963350 
    If GStreamer has been configured with --enable-gst-debug=yes,
    Packit Service 963350 
    this variable can be set to a list of debug options, which cause GStreamer
    Packit Service 963350 
    to print out different types of debugging information to stderr.
    Packit Service 963350
    Packit Service 963350 
    The variable takes a comma-separated list of "category_name:level" pairs
    Packit Service 963350 
    to set specific levels for the individual categories.
    Packit Service 963350 
    The level value ranges from 0 (nothing) to 9 (MEMDUMP).
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350 
    1 - ERROR
    Packit Service 963350
    Packit Service 963350 
    Logs all fatal errors.  These are errors that do not allow the core or elements
    Packit Service 963350 
    to perform the requested action.  The application can still recover if
    Packit Service 963350 
    programmed to handle the conditions that triggered the error.
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350 
    2 - WARNING
    Packit Service 963350
    Packit Service 963350 
    Logs all warnings.  Typically these are non-fatal, but user-visible problems
    Packit Service 963350 
    are expected to happen.
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350 
    3 - FIXME
    Packit Service 963350
    Packit Service 963350 
    Logs all fixme messages. Fixme messages are messages that indicate that something
    Packit Service 963350 
    in the executed code path is not fully implemented or handled yet.  The purpose
    Packit Service 963350 
    of this message is to make it easier to spot incomplete/unfinished pieces of
    Packit Service 963350 
    code when reading the debug log.
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350 
    4 - INFO
    Packit Service 963350
    Packit Service 963350 
    Logs all informational messages.  These are typically used for events in
    Packit Service 963350 
    the system that only happen once, or are important and rare enough to be
    Packit Service 963350 
    logged at this level.
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350 
    5 - DEBUG
    Packit Service 963350
    Packit Service 963350 
    Logs all debug messages.  These are general debug messages for events
    Packit Service 963350 
    that happen only a limited number of times during an object's lifetime;
    Packit Service 963350 
    these include setup, teardown, change of parameters, ...
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350 
    6 - LOG
    Packit Service 963350
    Packit Service 963350 
    Logs all log messages.  These are messages for events
    Packit Service 963350 
    that happen repeatedly during an object's lifetime;
    Packit Service 963350 
    these include streaming and steady-state conditions.
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350 
    7 - TRACE
    Packit Service 963350
    Packit Service 963350 
    Logs all trace messages.  These messages for events
    Packit Service 963350 
    that happen repeatedly during an object's lifetime such as the
    Packit Service 963350 
    ref/unref cycles.
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350 
    9 - MEMDUMP
    Packit Service 963350
    Packit Service 963350 
    Log all memory dump messages. Memory dump messages are used to log
    Packit Service 963350 
    (small) chunks of data as memory dumps in the log. They will be displayed
    Packit Service 963350 
    as hexdump with ASCII characters.
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350 
     The category_name can contain "*" as a wildcard.
    Packit Service 963350
    Packit Service 963350 
    For example, setting GST_DEBUG to
    Packit Service 963350 
    GST_AUTOPLUG:6,GST_ELEMENT_*:4, will cause the
    Packit Service 963350 
    GST_AUTOPLUG category to be logged at full
    Packit Service 963350 
    LOG level, while all categories starting with
    Packit Service 963350 
    GST_ELEMENT_ will be logged at INFO level.
    Packit Service 963350
    Packit Service 963350 
    To get all possible debug output, set
    Packit Service 963350 
    GST_DEBUG
    Packit Service 963350 
    to *:9. For debugging purposes a *:6 debug
    Packit Service 963350 
    log is usually the most useful, as it contains all important information, but
    Packit Service 963350 
    hides a lot of noise such as refs/unrefs. For bug reporting purposes, a
    Packit Service 963350 
    *:6 log is also what will be requested usually. It's often
    Packit Service 963350 
    also worth running with *:3 to see if there are any
    Packit Service 963350 
    non-fatal errors or warnings that might be related to the problem at hand.
    Packit Service 963350
    Packit Service 963350 
    Since GStreamer 1.2 it is also possible to specify debug levels by name,
    Packit Service 963350 
    e.g. GST_DEBUG=*:WARNING,*audio*:LOG
    Packit Service 963350
    Packit Service 963350 
    GST_DEBUG_NO_COLOR. 
    Packit Service 963350 
    Set this environment variable to any value ("1" typically) to switch off
    Packit Service 963350 
    colouring in GST_DEBUG output. This has the same effect as specifying the
    Packit Service 963350 
    --gst-debug-no-color or
    Packit Service 963350 
    --gst-debug-color-mode=off command line option to
    Packit Service 963350 
    well-behaved GStreamer applications (ie. those that pass command-line
    Packit Service 963350 
    options correctly to GStreamer).
    Packit Service 963350 
    This is particularly useful to reduce the size of debug output and also allows
    Packit Service 963350 
    for the output to be compressed much better than with colours turned on.
    Packit Service 963350
    Packit Service 963350 
    Has the same effect as setting GST_DEBUG_COLOR_MODE environment variable to
    Packit Service 963350 
    "off".
    Packit Service 963350
    Packit Service 963350 
    GST_DEBUG_COLOR_MODE. 
    Packit Service 963350 
    Set this environment variable to change log colouring in GST_DEBUG output.
    Packit Service 963350 
    Possible values:
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350 
    on
    Packit Service 963350
    Packit Service 963350 
    Enables debug log output coloring. Uses default coloring method for current
    Packit Service 963350 
    platform. This is the default.
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350 
    off
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350 
    Disables debug log output coloring. This has the same effect as specifying the
    Packit Service 963350 
    --gst-debug-color-mode=off command line option to
    Packit Service 963350 
    well-behaved GStreamer applications (ie. those that pass command-line
    Packit Service 963350 
    options correctly to GStreamer).
    Packit Service 963350 
    This is particularly useful to reduce the size of debug output and also allows
    Packit Service 963350 
    for the output to be compressed much better than with colours turned on.
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350 
    Has the same effect as setting GST_DEBUG_NO_COLOR environment variable to
    Packit Service 963350 
    any value.
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350 
    auto
    Packit Service 963350
    Packit Service 963350 
    Same as on.
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350 
    disable
    Packit Service 963350
    Packit Service 963350 
    Same as off.
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350 
    unix
    Packit Service 963350
    Packit Service 963350 
    Enables debug log output coloring and forces the use of UNIX termial codes
    Packit Service 963350 
    for coloring, even if this method is not normally used on current platform.
    Packit Service 963350 
    This has the same effect as specifying the
    Packit Service 963350 
    --gst-debug-color-mode=unix command line option to
    Packit Service 963350 
    well-behaved GStreamer applications (ie. those that pass command-line options
    Packit Service 963350 
    correctly to GStreamer).
    Packit Service 963350 
    This is particularly useful to dump debug output into a file on non-UNIX
    Packit Service 963350 
    platforms to be sent to developers who have viewers that support UNIX terminal
    Packit Service 963350 
    codes.
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350 
    GST_DEBUG_OPTIONS. 
    Packit Service 963350 
    This environment variable can be used to tweak the behaviour of the debugging
    Packit Service 963350 
    system. Currently the only options supported are "pretty-tags" and "full-tags".
    Packit Service 963350 
    In "pretty-tags" mode (the default), taglists in the debug log will be
    Packit Service 963350 
    serialized so that only the first few and last few bytes of a buffer-type tag
    Packit Service 963350 
    will be serialized into the log, to avoid dumping hundreds of lines of useless
    Packit Service 963350 
    output into the log in case of large image tags and the like.
    Packit Service 963350
    Packit Service 963350 
    GST_DEBUG_DUMP_DOT_DIR. 
    Packit Service 963350 
    Set this environment variable to a path to turn on all
    Packit Service 963350 
    #GST_DEBUG_BIN_TO_DOT_FILE or #GST_DEBUG_BIN_TO_DOT_FILE_WITH_TS calls
    Packit Service 963350 
    and have the dot files in that location.
    Packit Service 963350
    Packit Service 963350 
    This will only work if the application in question makes these calls in
    Packit Service 963350 
    strategic places (like when the pipeline state changes or an error occurs).
    Packit Service 963350 
    gst-launch-1.0 is one such application.
    Packit Service 963350
    Packit Service 963350 
    When gst-launch-1.0 changes state through NULL to PLAYING
    Packit Service 963350 
    and back to NULL, a dot file is generated on each state change. To have
    Packit Service 963350 
    gst-launch-1.0 write a snapshot of the pipeline state, send
    Packit Service 963350 
    a SIGHUP to the gst-launch-1.0 process.
    Packit Service 963350
    Packit Service 963350 
    These .dot files can then be turned into images using the 'dot' utility
    Packit Service 963350 
    from the graphviz set of tools, like this:
    Packit Service 963350 
      dot foo.dot -Tsvg -o foo.svg or
    Packit Service 963350 
      dot foo.dot -Tpng -o foo.png or
    Packit Service 963350 
      dot foo.dot -Tjpg -o foo.jpg.
    Packit Service 963350
    Packit Service 963350 
    There is also a utility called xdot which allows you to
    Packit Service 963350 
    view the dot file directly without converting it first.
    Packit Service 963350
    Packit Service 963350 
    GST_REGISTRY, GST_REGISTRY_1_0. 
    Packit Service 963350 
    Set this environment variable to make GStreamer use a different file for the
    Packit Service 963350 
    plugin cache / registry than the default one. This is useful when operating
    Packit Service 963350 
    in a separate environment which should not affect the default cache in the
    Packit Service 963350 
    user's home directory.
    Packit Service 963350
    Packit Service 963350 
    GST_REGISTRY_FORK. 
    Packit Service 963350 
    Set this environment variable to "no" to prevent GStreamer from forking on
    Packit Service 963350 
    startup in order to update the plugin registry. This is useful for debugging
    Packit Service 963350 
    purposes, but should not be used under normal circumstances, since it means
    Packit Service 963350 
    that plugins may be loaded into memory even if they are not needed by the
    Packit Service 963350 
    application.
    Packit Service 963350
    Packit Service 963350 
    GST_REGISTRY_UPDATE. 
    Packit Service 963350 
    Set this environment variable to "no" to prevent GStreamer from updating the
    Packit Service 963350 
    plugin registry. This is useful for embedded device which is not updating the
    Packit Service 963350 
    plugins frequently, it will save time when doing gst_init().
    Packit Service 963350
    Packit Service 963350 
    GST_TRACE. 
    Packit Service 963350 
        Enable memory allocation tracing. Most GStreamer objects have support for
    Packit Service 963350 
        tracing the number of unfreed objects and their memory pointers.
    Packit Service 963350
    Packit Service 963350 
    The variable takes a comma-separated list of tracing options to enable.
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350 
    live
    Packit Service 963350
    Packit Service 963350 
      Counts all live objects and dumps an overview of the number of unfreed
    Packit Service 963350 
      objects at program exit.
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350 
    mem-live
    Packit Service 963350
    Packit Service 963350 
      Keep track of the unfreed memory pointers and dump an overview of all unfreed
    Packit Service 963350 
      memory at program exit. Together with a level 9 debug log this can be used to
    Packit Service 963350 
      follow the lifecycle of leaked objects in order to track down where they are
    Packit Service 963350 
      leaked. This can be useful for debugging memory leaks in situations where
    Packit Service 963350 
      tools such as valgrind are not available, or not an option.
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350 
     Use all to enable all tracing flags.
    Packit Service 963350
    Packit Service 963350 
    GST_DEBUG_FILE. 
    Packit Service 963350 
      Set this variable to a file path to redirect all GStreamer debug
    Packit Service 963350 
      messages to this file. If left unset, debug messages with be output
    Packit Service 963350 
      unto the standard error.
    Packit Service 963350
    Packit Service 963350 
    ORC_CODE. 
    Packit Service 963350 
    Useful Orc environment variable. Set ORC_CODE=debug to enable debuggers
    Packit Service 963350 
    such as gdb to create useful backtraces from Orc-generated code.  Set
    Packit Service 963350 
    ORC_CODE=backup or ORC_CODE=emulate if you suspect Orc's SIMD code
    Packit Service 963350 
    generator is producing incorrect code (Quite a few important
    Packit Service 963350 
    GStreamer plugins like videotestsrc, audioconvert or audioresample use Orc).
    Packit Service 963350 
    One can also combine flags like ORC_CODE=backup,debug.
    Packit Service 963350
    Packit Service 963350 
    G_DEBUG. 
    Packit Service 963350 
    Useful GLib environment variable. Set G_DEBUG=fatal_warnings to make
    Packit Service 963350 
    GStreamer programs abort when a critical warning such as an assertion failure
    Packit Service 963350 
    occurs. This is useful if you want to find out which part of the code caused
    Packit Service 963350 
    that warning to be triggered and under what circumstances. Simply set G_DEBUG
    Packit Service 963350 
    as mentioned above and run the program in gdb (or let it core dump). Then get
    Packit Service 963350 
    a stack trace in the usual way.
    Packit Service 963350
    Packit Service 963350 
    G_SLICE. 
    Packit Service 963350 
    Useful GLib environment variable. Set G_SLICE=always-malloc when running
    Packit Service 963350 
    GStreamer programs in valgrind, or debugging memory leaks with other tools.
    Packit Service 963350 
    See the GLib API reference for more details.
    Packit Service 963350
    Packit Service 963350 
    GST_TAG_ENCODING. 
    Packit Service 963350 
    Try this character encoding first for tag-related strings where the encoding
    Packit Service 963350 
    is not defined and which are not UTF-8 already. By default the current locale
    Packit Service 963350 
    will be tried (if not UTF-8).
    Packit Service 963350
    Packit Service 963350 
    GST_TAG_ID3_ENCODING. 
    Packit Service 963350 
    Try this character encoding first for ID3 tag-related strings where the
    Packit Service 963350 
    encoding is not defined and which are not UTF-8 already. By default the current
    Packit Service 963350 
    locale will be tried (if not UTF-8).
    Packit Service 963350
    Packit Service 963350 
    GST_TAG_ID3V1_ENCODING. 
    Packit Service 963350 
    Try this character encoding first for ID3v1 tag-related strings where the
    Packit Service 963350 
    encoding does not look like UTF-8.
    Packit Service 963350
    Packit Service 963350 
    GST_GL_WINDOW. 
    Packit Service 963350 
    Influences the window system to use by the GStreamer OpenGL library.
    Packit Service 963350 
    Common values are 'x11', 'wayland', 'win32' or 'cocoa'.
    Packit Service 963350
    Packit Service 963350 
    GST_GL_PLATFORM. 
    Packit Service 963350 
    Influences the OpenGL platform to use by the GStreamer OpenGL library.
    Packit Service 963350 
    Common values are 'egl', 'glx', 'wgl' or 'cgl'.
    Packit Service 963350
    Packit Service 963350 
    GST_GL_API. 
    Packit Service 963350 
    Influences the OpenGL API requested by the OpenGL platform.
    Packit Service 963350 
    Common values are 'opengl' or 'gles2'.
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350
    Packit Service 963350 
    Generated by GTK-Doc V1.27
    Packit Service 963350 
    </body>
    Packit Service 963350 
    </html>

    Powered by Pagure 5.14.1

    SSH Hostkey/Fingerprint | Documentation