mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-01-10 17:35:59 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: Add some more docs about editing mode

Browse source 
Also add the documentation "Section" into ges-enum.c so the file documentation ar
 actualy taken into account in the final generated documentation.
This commit is contained in:
Thibault Saunier 2012-04-25 17:09:19 -04:00
parent 28d73a4441
commit 9e21741b90
2 changed files with 19 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
ges/ges-enums.c
View file

@ -18,6 +18,11 @@
* Boston, MA 02111-1307, USA.
*/
/**
* SECTION:ges-enums
* @short_description: Various enums for the Gstreamer Editing Services
*/
#include "ges-enums.h"
#define C_ENUM(v) ((guint) v)

18
ges/ges-enums.h
View file

@ -329,22 +329,32 @@ GType ges_pipeline_flags_get_type (void);
* @GES_EDIT_MODE_RIPPLE: The objects are edited in ripple mode.
* The Ripple mode allows you to modify the beginning/end of a clip
* and move the neighbours accordingly. This will change the overall
* timeline duration.
* timeline duration. In the case of ripple end, the duration of the
* clip being rippled can't be supperior to it max-duration - inpoint
* and if it would be the case, nothing wil happen.
* @GES_EDIT_MODE_ROLL: The object is edited in roll mode.
* The Roll mode allows you to modify the position of an editing point
* between two clips without modifying the inpoint of the first clip
* nor the out-point of the second clip. This will not change the
* overall timeline duration.
* overall timeline duration. In the case of ripple end, the duration of the
* clip being rolled can't be supperior to it max-duration - inpoint and if
* it would be the case, nothing wil happen.
* @GES_EDIT_MODE_TRIM: The object is edited in trim mode.
* The Trim mode allows you to modify the in-point/out-point of a clip without
* modifying it's duration or position in the timeline.
* modifying it's duration or position in the timeline. A clip being trim
* @GES_EDIT_MODE_SLIDE: The object is edited in slide mode.
* The Slide mode allows you to modify the position of a clip in a
* timeline without modifying it's duration or it's in-point, but will
* modify the out-point of the previous clip and in-point of the
* following clip so as not to modify the overall timeline duration.
* (not implemented yet)
*
* The various edition modes the a clip can be edited with.
* The various edition modes a clip can be edited with.
*
*
* You can also find more explanation about the behaviour of those modes at:
* <ulink url="http://pitivi.org/manual/trimming.html"> trim, ripple and roll</ulink>
* and <ulink url="http://pitivi.org/manual/usingclips.html">clip management</ulink>.
*/
typedef enum {
GES_EDIT_MODE_NORMAL,