design: move GESTimlineSource new API to GESTimelineObject

This commit is contained in:
Thibault Saunier 2011-01-18 20:03:51 +01:00 committed by Edward Hervey
parent 15701803bb
commit 6991d9f33d

View file

@ -156,7 +156,7 @@ C. Keyframes
const gchar *property_name, const gchar *property_name,
GValue * value); GValue * value);
B. GESTimelineSource new API B. GESTimelineObject new API
signals: signals:
------- -------
@ -165,25 +165,25 @@ C. Keyframes
* effect-moved: emited when an effect is moved * effect-moved: emited when an effect is moved
/** /**
* ges_timeline_source_add_effect: * ges_timeline_object_add_effect:
* *
* @object: The origin #GESTimelineSource * @object: The origin #GESTimelineObject
* @effect_material: The #GESMaterial from which to create the effect * @effect_material: The #GESMaterial from which to create the effect
* @position: The top position you want to give to the effect, * @position: The top position you want to give to the effect,
* -1 if you want it to be added at the end of effects. * -1 if you want it to be added at the end of effects.
* *
* Adds a new effect corresponding to @material to the #GESTimelineSource * Adds a new effect corresponding to @material to the #GESTimelineObject
* *
* Returns: The newly created #GESTrackEffect, or %NULL if there was an error. * Returns: The newly created #GESTrackEffect, or %NULL if there was an error.
*/ */
GESTrackEffect *ges_timeline_source_add_effect (GESTimelineSource *object, GESTrackEffect *ges_timeline_object_add_effect (GESTimelineObject *object,
GESMaterial *effect_material, GESMaterial *effect_material,
gint position); gint position);
/** /**
* ges_timeline_source_get_effects: * ges_timeline_object_get_effects:
* *
* @object: The origin #GESTimelineSource * @object: The origin #GESTimelineObject
* *
* Returns: a #GList of the #GESTrackEffect that are applied on * Returns: a #GList of the #GESTrackEffect that are applied on
* @object order by ascendant priorities. * @object order by ascendant priorities.
@ -191,21 +191,21 @@ C. Keyframes
* unref each #GESTrackOperation and free the #GList. * unref each #GESTrackOperation and free the #GList.
*/ */
GList * GList *
ges_timeline_source_get_effects (GESTimelineSource *object); ges_timeline_object_get_effects (GESTimelineObject *object);
-> Usecases: -> Usecases:
+ First step to allow the configuration of effects (UC-3) + First step to allow the configuration of effects (UC-3)
/** /**
* ges_timeline_source_set_top_effect_position: * ges_timeline_object_set_top_effect_position:
* *
* @object: The origin #GESTimelineSource * @object: The origin #GESTimelineObject
* @effect: The #GESTrackEffect to move * @effect: The #GESTrackEffect to move
* @newposition: the new position at which to move the @effect * @newposition: the new position at which to move the @effect
* *
* Returns: %TRUE if @effect was successfuly moved, %FALSE otherwize. * Returns: %TRUE if @effect was successfuly moved, %FALSE otherwize.
*/ */
gboolean gboolean
ges_timeline_source_set_top_effect_position (GESTimelineSource *object, ges_timeline_object_set_top_effect_position (GESTimelineObject *object,
GESTrackEffect *effect, guint newposition); GESTrackEffect *effect, guint newposition);
C - The GESTrackEffect API: C - The GESTrackEffect API: