B_MOVIE_MIN_DELAY

#define B_MOVIE_MIN_DELAY      20

The minimum time for a frame in milliseconds. Shorter frame delays will be set to this value.

B_MOVIE_DEFAULT_DELAY

#define B_MOVIE_DEFAULT_DELAY  100

The default time for a frame in milliseconds. Frames with no specified delay will be set to this value.

struct BMovie

struct BMovie;

The BMovie struct has various members that may be read directly since not all of them has accessor functions. You must however not change any of the fields.

struct BMovieFrame

struct BMovieFrame {

  gint          start;
  gint          duration;
  guchar       *data;
};

The BMovieFrame struct defines a single movie frame.

B_TYPE_MOVIE_BML

#define B_TYPE_MOVIE_BML            (b_movie_bml_get_type ())

Type derived from BMovie that handles movies in the Blinkenlights Markup Language (BML).

B_TYPE_MOVIE_BLM

#define B_TYPE_MOVIE_BLM            (b_movie_blm_get_type ())

Type derived from BMovie that handles movies in old-fashioned BLM format.

B_TYPE_MOVIE_GIF

#define B_TYPE_MOVIE_GIF            (b_movie_gif_get_type ())

Type derived from BMovie that handles movies in the GIF format.

b_movie_new_from_file ()

BMovie*     b_movie_new_from_file           (const gchar *filename,
                                             gboolean lazy_load,
                                             GError **error);

Tries to load a BMovie from the file pointed to by filename. If lazy_load is TRUE, only the header is loaded and no frames are stored.

b_movie_new_from_fd ()

BMovie*     b_movie_new_from_fd             (gint fd,
                                             GError **error);

Tries to load a BMovie from the UNIX file descriptor fd. Lazy loading from file descriptors is not implemented since it doesn't seem to make much sense.

b_movie_load ()

gboolean    b_movie_load                    (BMovie *movie,
                                             GError **error);

Assures that the frames of the movie are loaded.

b_movie_unload ()

void        b_movie_unload                  (BMovie *movie);

Unloads the frames of a movie.

The movie object counts how many times you call b_movie_load() and b_movie_unload() and only really unloads the frames if b_movie_unload() was called as often as b_movie_load(). Note that b_movie_new_from_file() and b_movie_new_from_fd() call b_movie_load() unless lazy-loading was requested.

b_movie_save ()

gboolean    b_movie_save                    (BMovie *movie,
                                             FILE *stream,
                                             GError **error);

Saves a BMovie object to a stream.

b_movie_save_as ()

gboolean    b_movie_save_as                 (BMovie *movie,
                                             GType movie_type,
                                             FILE *stream,
                                             GError **error);

Saves a BMovie object to a stream and allows to specify the file format to use.

The format is specified by passing a type derived from B_TYPE_MOVIE as movie_type. At the moment B_TYPE_MOVIE_BML, B_TYPE_MOVIE_BLM and B_TYPE_MOVIE_GIF are supported types.

b_movie_get_frame_at_time ()

GList*      b_movie_get_frame_at_time       (BMovie *movie,
                                             GList *seed,
                                             gint time);

Looks for the frame active after time milliseconds.

If you are calling this function subsequentially with increasing time values, you can speed up the search by passing the last return value as the seed parameter.

b_movie_prepend_frame ()

void        b_movie_prepend_frame           (BMovie *movie,
                                             gint duration,
                                             const guchar *data);

This is an internal function used by the movie loaders. It should never be called from anywhere else.