                                                                                
                              GtkHX

Introduction:
============= 
 
GtkHX is a Gtk-friendly wrapper around the hxclientkit library.
hxclientkit is a C binding that wraps the helix client core.

The main widget of interest in GtkHX is the GtkHXPlayer. This
widget can be used to easily embed a video window into a gtk
application.

There are several supporting widgets within GtkHX:

o GtkHXBin is a container widget that derives from GtkBin. It
  sizes a contained gtk widget 

o GStatisticsObserver derives from GObject, and can be used
  to monitor the statistics information produced by the helix
  client core. Call g_hxstatistics_observer_new with the player
  and the name of the statistic you want to observe. Statistics
  include, among other things, clip information ("title", 
  "author", "copyright").

o GHXValue, designed to be binary-compatible with GConfValue.
  These values are used by helix preferences system to load/save
  preferences. They are also used as a variant type by the 
  statistics system.

Examples:
=========

See the sample autotools-based gtkplay application for a simple
example of how to use these components.

For a more complex example, look at the source code for the 
helix player, available at https://player.helixcommunity.org
 

Installation:
=============

The header files for gtkhx should be copied to:
/usr/include/gtkhx-0.1/

The libgtkhx.so libray should be copied to:
/usr/lib

The pkg-config script should be copied to:
/usr/lib/pkgconfig/gtkhx-0.1.pc


Questions:
==========

If you have any questions regarding GtkHX, contact the player development
list at dev@player.helixcommunity.org.

Good luck!

Ryan Gammon <rgammon@real.com>
Oct. 31, 2003
