mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-25 01:30:38 +00:00
Code Issues 1 Projects Releases Wiki Activity

design: Update effect implementation doc

Browse source
This commit is contained in:
Thibault Saunier 2011-02-10 16:33:16 +01:00 committed by Edward Hervey
parent 4b4439ad8a
commit 01589a5685
1 changed files with 51 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

70
docs/design/effects.txt
View file

@ -116,7 +116,7 @@ C. Keyframes
signals: signals:
------- -------
* property-changed: emited when a usefull property of a GstElement * deep-notify: emited when a usefull property of a GstElement
contained in the GESTrackObject changes contained in the GESTrackObject changes
=> DONE => DONE
@ -207,7 +207,7 @@ C. Keyframes
GESTrackEffect *ges_timeline_object_add_effect (GESTimelineObject *object, GESTrackEffect *ges_timeline_object_add_effect (GESTimelineObject *object,
GESEffect *effect_material, GESEffect *effect_material,
gint position); gint position);
=> DONE => Waiting for GESMaterial
/** /**
* ges_timeline_object_get_effects: * ges_timeline_object_get_effects:
@ -255,24 +255,14 @@ C. Keyframes
=> DONE => DONE
C - The GESTrackEffect API: C - The GESTrackEffect API:
-> This is an empty abstract class
=> DONE
D - The GESTrackParseLaunchEffect API:
This is a parse-launch based implementation of TrackEffect.
/** /**
* ges_track_effect_new_from_material: * ges_track_parse_launch_effect_new:
*
* @effect_material: The #GESEffect from which to create this
* #GESTrackEffect
*
* Creates a new #GESTrackEffect from a #GESEffect
*
* Returns: a newly created #GESTrackEffect, or %NULL if something went
* wrong.
*/
GESTrackEffect *ges_track_effect_new_from_material(GESTrackEffect *effect,
GESEffect *effect_material);
=> Waiting for GESMaterial
/**
* ges_track_effect_new_from_bin_desc:
* *
* @bin_dec: The gst-launch like bin description of the effect * @bin_dec: The gst-launch like bin description of the effect
* *
@ -282,22 +272,56 @@ C. Keyframes
* Returns: a newly created #GESTrackEffect, or %NULL if something went * Returns: a newly created #GESTrackEffect, or %NULL if something went
* wrong. * wrong.
*/ */
GESTrackEffect *ges_track_effect_new_from_bin_desc(GESTrackEffect *effect, GESTrackEffect *ges_track_parse_launch_effect_new (GESTrackEffect *effect,
const gchar *bin_desc); const gchar *bin_desc);
=> DONE => DONE
D - The GESTimelineEffect API: E - The GESTrackMaterialEffect API:
/**
* ges_track_material_effect:
*
* @effect_material: The #GESEffect from which to create this
* #GESTrackEffect
*
* Creates a new #GESTrackEffect from a #GESEffect
*
* Returns: a newly created #GESTrackEffect, or %NULL if something went
* wrong.
*/
GESTrackEffect *ges_track_material_effect_new (GESTrackEffect *effect,
GESEffect *effect_material);
=> Waiting for GESMaterial
The GESTimelineEffect basically doesn't have anything else but what F - The GESTimelineEffect API:
GESTimelineObject has. -> This is an empty abstract class
=> DONE
-> Usecases: The user wants to control multiple effects in sync. The user -> Usecases: The user wants to control multiple effects in sync. The user
wants to add an effect to the whole timeline. The user wants wants to add an effect to the whole timeline. The user wants
to had an effect to a segment of the timeline without caring to had an effect to a segment of the timeline without caring
bout what clip it is applied on. bout what clip it is applied on.
G - The GESTimelineParseLaunchEffect API:
This is a parse-launch based implementation of TimelineEffect.
/**
* ges_timeline_parse_launch_effect_new_from_bin_desc:
* @video_bin_description: The gst-launch like bin description of the effect
* @audio_bin_description: The gst-launch like bin description of the effect
*
* Creates a new #GESTimelineParseLaunchEffect from the description of the bin.
*
* Returns: a newly created #GESTimelineParseLaunchEffect, or %NULL if something went
* wrong.
*/
GESTimelineParseLaunchEffect *
ges_timeline_parse_launch_effect_new (const gchar * video_bin_description,
const gchar * audio_bin_description)
=> DONE => DONE
E - The GESEffect:
H - The GESEffect:
The GESEffect class is a subclass of GESMaterial, it is used to describe The GESEffect class is a subclass of GESMaterial, it is used to describe
effects independently of the usage which is made of it in the timeline. effects independently of the usage which is made of it in the timeline.