============================================================
GStreamer Inspector - Multimedia system plugin introspection
============================================================

GStreamer Inspector is an introspection data viewer for the GStreamer multimedia
framework. Developers of GStreamer applications can use it to find out about the
various elements available in the system.

It can be thought of as a graphical variant of the gst-inspect program, which
currently serves as the canonical source of introspection information for many
developers.

This program is free software under the terms of the GNU GPL.

--------
Features
--------

The program presents:

 - Element details -- description, classification, rank, authors, interfaces,
   URI protocols, class hierarchy

 - Plugin details -- description, version, license, source module, binary
   package, filename, origin

 - Pad information -- direction, availability and caps

 - Properties -- description, inheritance, flags, data type, default value,
   value ranges, flags and enum value names and nick names

 - Signals -- inheritance, parameters and return type

Finding elements is fast and straightforward:

 - Find-as-you-type functionality of the list view gets you to any element by
   name with a few strokes

 - Filtering -- restrict element list by author, binary package, caps name,
   classification, interface, license, parent class, source module, URI protocol

 - Uses a compact on-disk cache to achieve fast program startup time (after the
   first run) and reasonably low memory usage

------------
Requirements
------------

 - Python 2.5 (http://python.org)
 - GTK+ 2.12 (http://gtk.org)
 - PyGTK (http://pygtk.org)
 - PyGObject 2.12.3 (http://pygtk.org)
 - gst-python 0.10.5 (http://gstreamer.freedesktop.org)

Tested on GNU/Linux (Ubuntu 8.04) and Windows Vista.

---------------------------
Getting GStreamer Inspector
---------------------------

Refer to the project page for download locations of releases:

  http://renestadler.de/projects/gst-inspector

Latest development code is hosted on freedesktop.org:

  git://people.freedesktop.org/~cymacs/gst-inspector

  Web view of git repository:
    http://cgit.freedesktop.org/~cymacs/gst-inspector

  Atom feed:
    http://cgit.freedesktop.org/~cymacs/gst-inspector/atom

----------
Installing
----------

For a system-wide installation, run this command:

  python setup.py install

Alternatively, you can install into any directory you wish by using:

  python setup.py install --prefix /path/to/wanted/directory

For a private installation (below a home directory), use this command:

  python setup.py install --home ~/path/to/wanted/directory

A --home installation has the added benefit of relieving you from having to
adjust your PYTHONPATH.

After installation, the program can be run by executing the gst-inspector Python
script.

If your system is missing the intltool-update, intltool-merge or msgfmt programs
(from the intltool and GNU gettext packages respectively), you can disable
translation support by editing the setup.cfg file.  Change the line that says
"## disable-l10n = True" to "disable-l10n = True".

--------
Feedback
--------

You can report any bugs you encounter to the Launchpad bug tracker:

  http://bugs.launchpad.net/gst-inspector/

Feel free to direct any form of feedback to myself via email:

  René Stadler <mail@renestadler.de>

--------
See also
--------

The TODO file contains information about known caveats and feature plans.