markdown/tools/gst-inspect.md

   1 # gst-inspect-1.0
   2
   3 > ![information] This is the Linux man page for
   4 > the `gst-inspect-1.0` tool. As such, it is very Linux-centric
   5 > regarding path specification and plugin names. Please be patient while
   6 > it is rewritten to be more generic.
   7
   8 ## Name
   9
  10 gst-inspect-1.0 - print info about a GStreamer plugin or element
  11
  12 ## Synopsis
  13
  14 **gst-inspect-1.0 \[OPTION...\] \[PLUGIN|ELEMENT\]**
  15
  16 ## Description
  17
  18 *gst-inspect-1.0* is a tool that prints out information on
  19 available *GStreamer* plugins, information about a particular plugin, or
  20 information about a particular element. When executed with no PLUGIN or
  21 ELEMENT argument, *gst-inspect-1.0* will print a list of all plugins and
  22 elements together with a sumary. When executed with a PLUGIN or ELEMENT
  23 argument, *gst-inspect-1.0* will print information about that plug-in or
  24 element.
  25
  26 ## Options
  27
  28 *gst-inspect-1.0* accepts the following arguments and options:
  29
  30 **PLUGIN**
  31
  32 Name of a plugin. This is a file name
  33 like `%GSTREAMER_ROOT_X86%\lib\gstreamer-1.0\libgstaudiotestsrc.dll`
  34 for example.
  35
  36 **ELEMENT**
  37
  38 Name of an element. This is the name of an element, like
  39 `audiotestsrc` for example
  40
  41 **--help**
  42
  43 Print help synopsis and available FLAGS
  44
  45 **--gst-info-mask=FLAGS**
  46
  47 *GStreamer* info flags to set (list with --help)
  48
  49  **-a, --print-all**
  50
  51 Print all plugins and elements
  52
  53  **--print-plugin-auto-install-info**
  54
  55 Print a machine-parsable list of features the specified plugin provides.
  56 Useful in connection with external automatic plugin installation
  57 mechanisms.
  58
  59  **--gst-debug-mask=FLAGS**
  60
  61 *GStreamer* debugging flags to set (list with --help)
  62
  63  **--gst-mask=FLAGS**
  64
  65 *GStreamer* info and debugging flags to set (list with --help)
  66
  67  **--gst-plugin-spew**
  68
  69 *GStreamer* info flags to set Enable printout of errors while
  70 loading *GStreamer* plugins
  71
  72  **--gst-plugin-path=PATH**
  73
  74 Add directories separated with ':' to the plugin search path
  75
  76 ## Example
  77
  78     gst-inspect-1.0 audiotestsrc
  79
  80 should produce:
  81
  82     Factory Details:
  83       Rank                     none (0)
  84       Long-name                Audio test source
  85       Klass                    Source/Audio
  86       Description              Creates audio test signals of given frequency and volume
  87       Author                   Stefan Kost <ensonic@users.sf.net>
  88
  89     Plugin Details:
  90       Name                     audiotestsrc
  91       Description              Creates audio test signals of given frequency and volume
  92       Filename                 /usr/lib/gstreamer-1.0/libgstaudiotestsrc.so
  93       Version                  1.8.1
  94       License                  LGPL
  95       Source module            gst-plugins-base
  96       Source release date      2016-04-20
  97       Binary package           GStreamer Base Plugins (Arch Linux)
  98       Origin URL               http://www.archlinux.org/
  99
 100     GObject
 101      +----GInitiallyUnowned
 102            +----GstObject
 103                  +----GstElement
 104                        +----GstBaseSrc
 105                              +----GstAudioTestSrc
 106
 107     Pad Templates:
 108       SRC template: 'src'
 109         Availability: Always
 110         Capabilities:
 111           audio/x-raw
 112                      format: { S16LE, S16BE, U16LE, U16BE, S24_32LE, S24_32BE, U24_32LE, U24_32BE, S32LE, S32BE, U32LE, U32BE, S24LE, S24BE, U24LE, U24BE, S20LE, S20BE, U20LE, U20BE, S18LE, S18BE, U18LE, U18BE, F32LE, F32BE, F64LE, F64BE, S8, U8 }
 113                      layout: interleaved
 114                        rate: [ 1, 2147483647 ]
 115                    channels: [ 1, 2147483647 ]
 116
 117     Element Flags:
 118       no flags set
 119
 120     Element Implementation:
 121       Has change_state() function: gst_base_src_change_state
 122
 123     Element has no clocking capabilities.
 124     Element has no URI handling capabilities.
 125
 126     Pads:
 127       SRC: 'src'
 128         Pad Template: 'src'
 129
 130     Element Properties:
 131       name                : The name of the object
 132                             flags: readable, writable
 133                             String. Default: "audiotestsrc0"
 134       parent              : The parent of the object
 135                             flags: readable, writable
 136                             Object of type "GstObject"
 137       blocksize           : Size in bytes to read per buffer (-1 = default)
 138                             flags: readable, writable
 139                             Unsigned Integer. Range: 0 - 4294967295 Default: 4294967295
 140       num-buffers         : Number of buffers to output before sending EOS (-1 = unlimited)
 141                             flags: readable, writable
 142                             Integer. Range: -1 - 2147483647 Default: -1
 143       typefind            : Run typefind before negotiating
 144                             flags: readable, writable
 145                             Boolean. Default: false
 146       do-timestamp        : Apply current stream time to buffers
 147                             flags: readable, writable
 148                             Boolean. Default: false
 149       samplesperbuffer    : Number of samples in each outgoing buffer
 150                             flags: readable, writable
 151                             Integer. Range: 1 - 2147483647 Default: 1024
 152       wave                : Oscillator waveform
 153                             flags: readable, writable, controllable
 154                             Enum "GstAudioTestSrcWave" Default: 0, "sine"
 155                                (0): sine             - Sine
 156                                (1): square           - Square
 157                                (2): saw              - Saw
 158                                (3): triangle         - Triangle
 159                                (4): silence          - Silence
 160                                (5): white-noise      - White uniform noise
 161                                (6): pink-noise       - Pink noise
 162                                (7): sine-table       - Sine table
 163                                (8): ticks            - Periodic Ticks
 164                                (9): gaussian-noise   - White Gaussian noise
 165                                (10): red-noise        - Red (brownian) noise
 166                                (11): blue-noise       - Blue noise
 167                                (12): violet-noise     - Violet noise
 168       freq                : Frequency of test signal. The sample rate needs to be at least 4 times higher.
 169                             flags: readable, writable, controllable
 170                             Double. Range:               0 -    5.368709e+08 Default:             440
 171       volume              : Volume of test signal
 172                             flags: readable, writable, controllable
 173                             Double. Range:               0 -               1 Default:             0.8
 174       is-live             : Whether to act as a live source
 175                             flags: readable, writable
 176                             Boolean. Default: false
 177       timestamp-offset    : An offset added to timestamps set on buffers (in ns)
 178                             flags: readable, writable
 179                             Integer64. Range: -9223372036854775808 - 9223372036854775807 Default: 0
 180       can-activate-push   : Can activate in push mode
 181                             flags: readable, writable
 182                             Boolean. Default: true
 183       can-activate-pull   : Can activate in pull mode
 184                             flags: readable, writable
 185                             Boolean. Default: false
 186
 187   [information]: images/icons/emoticons/information.png