camerabin2: adds PORTING document
authorThiago Santos <thiago.sousa.santos@collabora.co.uk>
Tue, 14 Dec 2010 11:44:36 +0000 (08:44 -0300)
committerThiago Santos <thiago.sousa.santos@collabora.co.uk>
Thu, 23 Dec 2010 16:20:35 +0000 (13:20 -0300)
Adds a PORTING document to explain the differences from
camerabin to camerabin2 and help application developers on
porting from one to another.

gst/camerabin2/PORTING [new file with mode: 0644]

diff --git a/gst/camerabin2/PORTING b/gst/camerabin2/PORTING
new file mode 100644 (file)
index 0000000..fe090b5
--- /dev/null
@@ -0,0 +1,14 @@
+This document lists the differenced between camerabin and camerabin2 from
+the API point of view and should be used to help on porting applications
+from camerabin to camerabin2.
+
+* Setting the location for the captures:
+camerabin requires that the path of the file to save the captures is set before
+each capture. Camerabin2 allows the application to use a multifilesink-like
+approach, the application can set a file with a '%d' marker, this marker
+will be automatically replaced by a number and be autoincremented after each
+capture.
+
+* Capture signals
+The signals were renamed from capture-start/stop to start/stop-capture as
+this is the usual naming on actions.