summaryrefslogtreecommitdiffstats
path: root/jsapi
diff options
context:
space:
mode:
Diffstat (limited to 'jsapi')
-rw-r--r--jsapi/AudioCapture.js2
-rw-r--r--jsapi/AudioFile.js3
-rw-r--r--jsapi/AudioOutput.js7
-rw-r--r--jsapi/MovieFile.js12
-rw-r--r--jsapi/VideoCapture.js2
-rw-r--r--jsapi/VideoFilter.js2
-rw-r--r--jsapi/VideoOutput.js4
7 files changed, 22 insertions, 10 deletions
diff --git a/jsapi/AudioCapture.js b/jsapi/AudioCapture.js
index 263ff2d..743c981 100644
--- a/jsapi/AudioCapture.js
+++ b/jsapi/AudioCapture.js
@@ -1,6 +1,6 @@
/**
* @fileoverview
- * Grab samples from an audio input device
+ * Grab samples from an audio input device (Abstract Class)
*/
/**
diff --git a/jsapi/AudioFile.js b/jsapi/AudioFile.js
index 63f48d8..6fcfe65 100644
--- a/jsapi/AudioFile.js
+++ b/jsapi/AudioFile.js
@@ -1,12 +1,13 @@
/**
* @fileoverview
- * Read frames from video files
+ * Read frames from video files (Abstract Class)
*/
/**
* AudioFile
* @constructor
* @param {String} path The path of the Audio file.
+ * @param {String} type The specific backend implementation (for instance: CoreAudioFile).
* @base Entity
* @class Abstract class implementing basic functionalities for entities grabbing video frames from Audio files.
* Such objects will extract video frames from supported video file types and will provide images on their 'frame' output pin
diff --git a/jsapi/AudioOutput.js b/jsapi/AudioOutput.js
index bbb698e..3447ecb 100644
--- a/jsapi/AudioOutput.js
+++ b/jsapi/AudioOutput.js
@@ -1,15 +1,14 @@
/**
* @fileoverview
- * Send received samples to an audio output device
+ * Send received samples to an audio output device (Abstract Class)
*/
/**
* AudioOutput
* @constructor
* @param {String} device The device to open.
- * @param {String} type The specific implementation type,
- * pass a null value to use the default
- * CoreAudio-based implementation.
+ * @param {String} type The specific backend implementation (for instance: CoreAudioOutput).
+ * Pass a null value to use the default backend.
* @base Entity
* @class Send audio samples to an output device
* <h3>InputPins:</h3>
diff --git a/jsapi/MovieFile.js b/jsapi/MovieFile.js
index da4e778..90429d5 100644
--- a/jsapi/MovieFile.js
+++ b/jsapi/MovieFile.js
@@ -1,12 +1,13 @@
/**
* @fileoverview
- * Read frames from video files
+ * Read frames from video files (Abstract Class)
*/
/**
* MovieFile
* @constructor
* @param {String} path The path of the movie file.
+ * @param {String} type The specific backend implementation (for instance: QtMovieFile).
* @base VideoEntity
* @class Abstract class implementing basic functionalities for entities grabbing video frames from movie files.
* Such objects will extract video frames from supported video file types and will provide images on their 'frame' output pin
@@ -21,6 +22,15 @@
*/
function MovieFile(path, type)
{
+ if (!type) {
+ // TODO implement type selection
+ return QtMovieFile();
+ } else {
+ // TODO
+ }
+
+ /* Documenation Only */
+
this.path = "";
this.repeat = false;
this.paused = false;
diff --git a/jsapi/VideoCapture.js b/jsapi/VideoCapture.js
index 20a72fc..89d5e0a 100644
--- a/jsapi/VideoCapture.js
+++ b/jsapi/VideoCapture.js
@@ -1,6 +1,6 @@
/**
* @fileoverview
- * Grab samples from an video input device
+ * Grab samples from an video input device (Abstract Class)
*/
/**
diff --git a/jsapi/VideoFilter.js b/jsapi/VideoFilter.js
index b408086..3177498 100644
--- a/jsapi/VideoFilter.js
+++ b/jsapi/VideoFilter.js
@@ -1,6 +1,6 @@
/**
* @fileoverview
- * Apply a filter to video frames
+ * Apply a filter to video frames (Abstract Class)
*/
/**
diff --git a/jsapi/VideoOutput.js b/jsapi/VideoOutput.js
index 94312e1..3bf2bb6 100644
--- a/jsapi/VideoOutput.js
+++ b/jsapi/VideoOutput.js
@@ -1,6 +1,6 @@
/**
* @fileoverview
- * Display video frames
+ * Display video frames (Abstract Class)
*/
/**
@@ -9,6 +9,8 @@
* @constructor
* @param {int} width The width of the new video output
* @param {int} height The height of the new video output
+ * @param {String} type The specific backend implementation (for instance: OpenGLScreen).
+ * Pass a null value to use the default backend.
* @base Entity
* @class
* <h3>InputPins:</h3>