README

   1 GStreamer Editing Services
   2 --------------------------
   3
   4  This is a high-level library for facilitating the creation of audio/video
   5 non-linear editors.
   6
   7 License:
   8 --------
   9
  10   This package and its contents are licensend under the GNU Lesser General
  11 Public License (LGPL).
  12
  13 Dependencies:
  14 -------------
  15
  16  * GStreamer core
  17  * gst-plugins-base
  18  * gnonlin
  19
  20 Classes:
  21 --------
  22
  23 <Public>
  24  TimelinePipeline : GstPipeline for Timeline playback/rendering
  25    => Add methods to save/load to/from files
  26    ?? Do we need undo/redo support ?
  27  Timeline : Top-level container (is also a GstBin)
  28    SimpleAVTimeline : Convenience A+V Timeline
  29  TimelineObject : Base-class for objects you can put in a TimelineLayer
  30    TimelineSource : Source objects to use in a TimelineLayer
  31      => _from_uri(const gchar *uri): automatically creates a TimelineSource
  32    TimelineTransition : Transitions
  33    (TimelineEffect)
  34  TimelineLayer : Layer of TimelineObject
  35    SimpleTimelineLayer : Simpler API (contiguous objects, list API)
  36
  37 <PRIVATE>
  38  Track : High-level single-media Composition (is a GstBin). Represents a 'stream'.
  39  TrackObject : Base-class for objects you can put in a Track
  40   TrackSource
  41   TrackOperation
  42
  43 Usage:
  44 ------
  45
  46  Create a TimelinePipeline...
  47
  48    pipeline = ges_timeline_pipeline_new();
  49
  50  ... with one layer
  51
  52    layer1 = ges_simple_timeline_layer_new();
  53    ges_timeline_pipeline_add_layer (layer1);
  54
  55  Add a video source to the end
  56
  57    src1 = ges_timeline_source_from_uri("/my/cool/file.avi");
  58    ges_simple_timeline_layer_add(src1, -1);
  59
  60  Set video output XID and play back the timeline
  61
  62    ges_timeline_pipeline_set_xid(1234567);
  63    ges_timeline_pipeline_play();
  64
  65  Save Timeline to a file
  66
  67    ges_timeline_save ("/my/project.ges");
  68
  69  Stop output and render to a file
  70
  71    ges_timeline_pipeline_stop();
  72    ges_timeline_pipeline_render_to_file("/my/output.mov", OUTPUT_SETTINGS);