cordova-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rkn...@apache.org
Subject cordova-plugin-media-capture git commit: CB-10720: Fixing README for display on Cordova website
Date Thu, 03 Mar 2016 01:37:04 GMT
Repository: cordova-plugin-media-capture
Updated Branches:
  refs/heads/master 73928dc2d -> 086789870


CB-10720: Fixing README for display on Cordova website

This closes #58


Project: http://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture/commit/08678987
Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture/tree/08678987
Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture/diff/08678987

Branch: refs/heads/master
Commit: 0867898701c9f547dddd8448bfc0f46d6ae14008
Parents: 73928dc
Author: riknoll <richard.b.knoll@gmail.com>
Authored: Tue Mar 1 17:26:53 2016 -0800
Committer: riknoll <richard.b.knoll@gmail.com>
Committed: Wed Mar 2 17:33:39 2016 -0800

----------------------------------------------------------------------
 README.md | 116 ++++++++++++++++++++++++++++-----------------------------
 1 file changed, 58 insertions(+), 58 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture/blob/08678987/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 6774f95..7877681 100644
--- a/README.md
+++ b/README.md
@@ -47,7 +47,7 @@ Although in the global scope, it is not available until after the `deviceready`
         console.log(navigator.device.capture);
     }
 
-:warning: Report issues on the [Apache Cordova issue tracker](https://issues.apache.org/jira/issues/?jql=project%20%3D%20CB%20AND%20status%20in%20%28Open%2C%20%22In%20Progress%22%2C%20Reopened%29%20AND%20resolution%20%3D%20Unresolved%20AND%20component%20%3D%20%22Plugin%20Media%20Capture%22%20ORDER%20BY%20priority%20DESC%2C%20summary%20ASC%2C%20updatedDate%20DESC)
+Report issues with this plugin on the [Apache Cordova issue tracker](https://issues.apache.org/jira/issues/?jql=project%20%3D%20CB%20AND%20status%20in%20%28Open%2C%20%22In%20Progress%22%2C%20Reopened%29%20AND%20resolution%20%3D%20Unresolved%20AND%20component%20%3D%20%22Plugin%20Media%20Capture%22%20ORDER%20BY%20priority%20DESC%2C%20summary%20ASC%2C%20updatedDate%20DESC)
 
 ## Installation
 
@@ -155,40 +155,6 @@ code.
 
 - Windows Phone 7 does not have a default audio recording application, so a simple user interface
is provided.
 
-## CaptureAudioOptions
-
-> Encapsulates audio capture configuration options.
-
-### Properties
-
-- __limit__: The maximum number of audio clips the device user can record in a single capture
operation.  The value must be greater than or equal to 1 (defaults to 1).
-
-- __duration__: The maximum duration of an audio sound clip, in seconds.
-
-### Example
-
-    // limit capture operation to 3 media files, no longer than 10 seconds each
-    var options = { limit: 3, duration: 10 };
-
-    navigator.device.capture.captureAudio(captureSuccess, captureError, options);
-
-### Amazon Fire OS Quirks
-
-- The `duration` parameter is not supported.  Recording lengths cannot be limited programmatically.
-
-### Android Quirks
-
-- The `duration` parameter is not supported.  Recording lengths can't be limited programmatically.
-
-### BlackBerry 10 Quirks
-
-- The `duration` parameter is not supported.  Recording lengths can't be limited programmatically.
-- The `limit` parameter is not supported, so only one recording can be created for each invocation.
-
-### iOS Quirks
-
-- The `limit` parameter is not supported, so only one recording can be created for each invocation.
-
 ## capture.captureImage
 
 > Start the camera application and return information about captured image files.
@@ -205,7 +171,7 @@ one image in a single session.
 
 The capture operation ends either when the user closes the camera
 application, or the maximum number of recordings specified by
-`CaptureAudioOptions.limit` is reached.  If no `limit` value is
+`CaptureImageOptions.limit` is reached.  If no `limit` value is
 specified, it defaults to one (1), and the capture operation
 terminates after the user captures a single image.
 
@@ -259,27 +225,6 @@ and due to this the only way to show captured image is to read it and
show using
     // start image capture
     navigator.device.capture.captureImage(captureSuccess, captureError, {limit:2});
 
-
-
-## CaptureImageOptions
-
-> Encapsulates image capture configuration options.
-
-### Properties
-
-- __limit__: The maximum number of images the user can capture in a single capture operation.
The value must be greater than or equal to 1 (defaults to 1).
-
-### Example
-
-    // limit capture operation to 3 images
-    var options = { limit: 3 };
-
-    navigator.device.capture.captureImage(captureSuccess, captureError, options);
-
-### iOS Quirks
-
-- The __limit__ parameter is not supported, and only one image is taken per invocation.
-
 ## capture.captureVideo
 
 > Start the video recorder application and return information about captured video clip
files.
@@ -342,6 +287,61 @@ capturing a video clip, the `CaptureErrorCB` callback executes with a
 - Cordova for BlackBerry 10 attempts to launch the __Video Recorder__ application, provided
by RIM, to capture video recordings. The app receives a `CaptureError.CAPTURE_NOT_SUPPORTED`
error code if the application is not installed on the device.
 
 
+## CaptureAudioOptions
+
+> Encapsulates audio capture configuration options.
+
+### Properties
+
+- __limit__: The maximum number of audio clips the device user can record in a single capture
operation.  The value must be greater than or equal to 1 (defaults to 1).
+
+- __duration__: The maximum duration of an audio sound clip, in seconds.
+
+### Example
+
+    // limit capture operation to 3 media files, no longer than 10 seconds each
+    var options = { limit: 3, duration: 10 };
+
+    navigator.device.capture.captureAudio(captureSuccess, captureError, options);
+
+### Amazon Fire OS Quirks
+
+- The `duration` parameter is not supported.  Recording lengths cannot be limited programmatically.
+
+### Android Quirks
+
+- The `duration` parameter is not supported.  Recording lengths can't be limited programmatically.
+
+### BlackBerry 10 Quirks
+
+- The `duration` parameter is not supported.  Recording lengths can't be limited programmatically.
+- The `limit` parameter is not supported, so only one recording can be created for each invocation.
+
+### iOS Quirks
+
+- The `limit` parameter is not supported, so only one recording can be created for each invocation.
+
+
+## CaptureImageOptions
+
+> Encapsulates image capture configuration options.
+
+### Properties
+
+- __limit__: The maximum number of images the user can capture in a single capture operation.
The value must be greater than or equal to 1 (defaults to 1).
+
+### Example
+
+    // limit capture operation to 3 images
+    var options = { limit: 3 };
+
+    navigator.device.capture.captureImage(captureSuccess, captureError, options);
+
+### iOS Quirks
+
+- The __limit__ parameter is not supported, and only one image is taken per invocation.
+
+
 ## CaptureVideoOptions
 
 > Encapsulates video capture configuration options.
@@ -370,7 +370,7 @@ capturing a video clip, the `CaptureErrorCB` callback executes with a
 ### Android Quirks
 
 - Android supports an additional __quality__ property, to allow capturing video at different
qualities.  A value of `1` ( the default ) means high quality and value of `0` means low quality,
suitable for MMS messages.
-  See http://developer.android.com/reference/android/provider/MediaStore.html#EXTRA_VIDEO_QUALITY
for more details.
+  See [here](http://developer.android.com/reference/android/provider/MediaStore.html#EXTRA_VIDEO_QUALITY)
for more details.
 
 ### Example ( Android w/ quality )
 


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org


Mime
View raw message