GstGnomeEffectFilter

GstGnomeEffectFilter — A Gnome Video Effect filter

Synopsis

#include <gst/filters/gst-gnome-effect-filter.h>

                    GstGnomeEffectFilter;
typedef             GstGnomeEffectCategoriesGList;
GstGnomeEffectFilter * gst_gnome_effect_filter_new      (const gchar *filename,
                                                         GError **error);
GList *             gst_gnome_effect_categories_list_copy
                                                        (const GList *categories_list);
void                gst_gnome_effect_categories_list_destroy
                                                        (GList *categories_list);
GList *             gst_gnome_effect_list_effects       (const gchar *directory);
void                gst_gnome_effect_effects_list_destroy
                                                        (GList *effects_list);

Object Hierarchy

  GObject
   +----GstFilter
         +----GstGnomeEffectFilter
  GBoxed
   +----GstGnomeEffectCategoriesGList

Properties

  "categories"               GstGnomeEffectCategoriesGList*  : Read
  "filename"                 gchar*                : Read / Write / Construct Only
  "name"                     gchar*                : Read
  "pipeline-description"     gchar*                : Read

Description

This filter will parse a Gnome Video Effect file and will generate the proper pipeline for that effect, as well as give access to some of the effect's configuration.

Details

GstGnomeEffectFilter

typedef struct _GstGnomeEffectFilter GstGnomeEffectFilter;

A Gnome Video Effect filter


GstGnomeEffectCategoriesGList

typedef GList GstGnomeEffectCategoriesGList;

A GList of strings representing the categories of the Gnome Video Effect.


gst_gnome_effect_filter_new ()

GstGnomeEffectFilter * gst_gnome_effect_filter_new      (const gchar *filename,
                                                         GError **error);

Creates a new Gnome Video Effect filter This filter will add the video effect pipeline description with an ffmpegcolorspace to the pipeline when applied.

filename :

The filename to the .effect file representing the Gnome Video Effect

error :

A pointer to a GError to be set if the .effect file is invalid

Returns :

A new GstGnomeEffectFilter or NULL if an error occured. [transfer full]

gst_gnome_effect_categories_list_copy ()

GList *             gst_gnome_effect_categories_list_copy
                                                        (const GList *categories_list);

Creates a GList copy of the categories list

categories_list :

The GList of categories to copy. [element-type utf8]

Returns :

The copy of the categories list. [transfer full][element-type utf8]

gst_gnome_effect_categories_list_destroy ()

void                gst_gnome_effect_categories_list_destroy
                                                        (GList *categories_list);

Frees and destroys the GList of categories returned by the property "categories"

categories_list :

The GList of categories to free

gst_gnome_effect_list_effects ()

GList *             gst_gnome_effect_list_effects       (const gchar *directory);

Searches in a directory for all .effect files and returns a GList of strings with the full path to the .effect files in it.

directory :

The directory to search for effects

Returns :

A GList of the filenames of the .effect files in the directory. [transfer full][element-type utf8]

gst_gnome_effect_effects_list_destroy ()

void                gst_gnome_effect_effects_list_destroy
                                                        (GList *effects_list);

Frees and destroys the GList of effects returned by gst_gnome_effect_list_effects()

effects_list :

The GList of effects to free. [element-type utf8]

Property Details

The "categories" property

  "categories"               GstGnomeEffectCategoriesGList*  : Read

The list of categories as specified in the .effect file. This returns a GList of strings, each representing a category for this Gnome Video Effect.


The "filename" property

  "filename"                 gchar*                : Read / Write / Construct Only

The filename to the Gnome Video Effect .effect file to parse

Default value: NULL


The "name" property

  "name"                     gchar*                : Read

The user-friendly name to the Gnome Video Effect

Default value: NULL


The "pipeline-description" property

  "pipeline-description"     gchar*                : Read

The pipeline description of the Gnome Video Effect as taken from the .effect file

Default value: NULL