You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by mw...@apache.org on 2013/06/12 19:51:06 UTC
[31/46] docs commit: thru media
thru media
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/45f896ae
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/45f896ae
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/45f896ae
Branch: refs/heads/master
Commit: 45f896ae7aae46d630680259895820ccf900871c
Parents: 4977836
Author: Mike Sierra <le...@gmail.com>
Authored: Fri May 17 16:24:39 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Fri May 17 16:24:39 2013 -0400
----------------------------------------------------------------------
.../en/edge/cordova/camera/camera.getPicture.md | 2 +-
.../cordova/compass/compass.watchHeading.md | 2 +-
.../cordova/events/events.batterycritical.md | 4 +-
.../en/edge/cordova/events/events.batterylow.md | 2 +-
.../edge/cordova/events/events.batterystatus.md | 2 +-
.../file/directoryentry/directoryentry.md | 12 ++---
.../en/edge/cordova/file/fileentry/fileentry.md | 4 +-
.../cordova/file/filetransfer/filetransfer.md | 6 +--
.../geolocation.getCurrentPosition.md | 4 +-
.../geolocation/geolocation.watchPosition.md | 2 +-
.../parameters/geolocation.options.md | 2 +-
.../edge/cordova/media/MediaError/mediaError.md | 10 ++--
.../edge/cordova/media/Parameters/mediaError.md | 5 +-
docs/en/edge/cordova/media/capture/CaptureCB.md | 9 ++--
.../edge/cordova/media/capture/CaptureError.md | 12 ++---
.../cordova/media/capture/CaptureErrorCB.md | 10 ++--
.../cordova/media/capture/ConfigurationData.md | 22 +++++----
.../media/capture/MediaFile.getFormatData.md | 21 +++++++--
docs/en/edge/cordova/media/capture/MediaFile.md | 6 +--
.../edge/cordova/media/capture/MediaFileData.md | 49 +++++++++++---------
docs/en/edge/cordova/media/capture/capture.md | 13 +++---
.../edge/cordova/media/capture/captureAudio.md | 27 +++++++----
.../media/capture/captureAudioOptions.md | 8 ++--
.../edge/cordova/media/capture/captureImage.md | 34 +++++++++-----
.../media/capture/captureImageOptions.md | 6 +--
.../edge/cordova/media/capture/captureVideo.md | 37 +++++++++------
.../media/capture/captureVideoOptions.md | 11 +++--
.../cordova/media/media.getCurrentPosition.md | 10 ++--
docs/en/edge/cordova/media/media.getDuration.md | 6 ++-
docs/en/edge/cordova/media/media.md | 45 ++++++++++--------
docs/en/edge/cordova/media/media.pause.md | 4 +-
docs/en/edge/cordova/media/media.play.md | 35 ++++++++------
docs/en/edge/cordova/media/media.release.md | 10 ++--
docs/en/edge/cordova/media/media.seekTo.md | 10 ++--
docs/en/edge/cordova/media/media.startRecord.md | 15 +++---
docs/en/edge/cordova/media/media.stop.md | 5 +-
docs/en/edge/cordova/media/media.stopRecord.md | 7 +--
.../notification/notification.confirm.md | 3 +-
.../edge/cordova/notification/notification.md | 10 ++--
.../cordova/notification/notification.prompt.md | 2 +-
.../storage/sqlresultset/sqlresultset.md | 5 +-
.../storage/sqltransaction/sqltransaction.md | 2 +-
42 files changed, 288 insertions(+), 203 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/camera/camera.getPicture.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/camera.getPicture.md b/docs/en/edge/cordova/camera/camera.getPicture.md
index cae7aba..3fc21d6 100644
--- a/docs/en/edge/cordova/camera/camera.getPicture.md
+++ b/docs/en/edge/cordova/camera/camera.getPicture.md
@@ -58,7 +58,7 @@ example:
- Save the data locally (`LocalStorage`, [Lawnchair](http://brianleroux.github.com/lawnchair/), etc)
- Post the data to a remote server
-**NOTE:** Photo resolution on newer devices is quite good. Photos
+__NOTE:__ Photo resolution on newer devices is quite good. Photos
selected from the device's gallery are not downscaled to a lower
quality, even if a `quality` parameter is specified. To avoid common
memory problems, set `Camera.destinationType` to `FILE_URI` rather
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/compass/compass.watchHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.watchHeading.md b/docs/en/edge/cordova/compass/compass.watchHeading.md
index b3c9fd5..c617c60 100755
--- a/docs/en/edge/cordova/compass/compass.watchHeading.md
+++ b/docs/en/edge/cordova/compass/compass.watchHeading.md
@@ -138,7 +138,7 @@ iOS Quirks
In iOS `compass.watchHeading` can also get the device's current
heading when it changes by a specified number of degrees. Each time
the heading changes by the specified number of degrees or more, the
-`headingSuccess` callback function is called. Specify the degrees of
+`headingSuccess` callback function executes. Specify the degrees of
change via the `filter` parameter in the `compassOptions` object.
Clear the watch as usual by passing the returned watch ID to
`compass.clearWatch`. This functionality replaces the previously
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/events/events.batterycritical.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.batterycritical.md b/docs/en/edge/cordova/events/events.batterycritical.md
index 166cc60..5ebea4b 100644
--- a/docs/en/edge/cordova/events/events.batterycritical.md
+++ b/docs/en/edge/cordova/events/events.batterycritical.md
@@ -31,8 +31,8 @@ Details
The event fires when the percentage of battery charge has reached the
critical battery threshold. The value is device-specific.
-The `batterycritical` handler is called with an object that contains
-two properties:
+The `batterycritical` handler is passed an object that contains two
+properties:
- __level__: The percentage of battery charge (0-100). _(Number)_
- __isPlugged__: A boolean that indicates whether the device is plugged in. _(Boolean)_
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/events/events.batterylow.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.batterylow.md b/docs/en/edge/cordova/events/events.batterylow.md
index 7014765..b156454 100644
--- a/docs/en/edge/cordova/events/events.batterylow.md
+++ b/docs/en/edge/cordova/events/events.batterylow.md
@@ -30,7 +30,7 @@ Details
The event fires when the percentage of battery charge has reached the
low battery threshold, device-specific value.
-The `batterylow` handler is called with an object that contains two
+The `batterylow` handler is passed an object that contains two
properties:
- __level__: The percentage of battery charge (0-100). _(Number)_
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/events/events.batterystatus.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.batterystatus.md b/docs/en/edge/cordova/events/events.batterystatus.md
index 57ed6ef..728aca2 100644
--- a/docs/en/edge/cordova/events/events.batterystatus.md
+++ b/docs/en/edge/cordova/events/events.batterystatus.md
@@ -30,7 +30,7 @@ Details
This event fires when the percentage of battery charge changes by at
least 1 percent, or if the device is plugged in or unplugged.
-The battery status handler is called with an object that contains two
+The battery status handler is passed an object that contains two
properties:
- __level__: The percentage of battery charge (0-100). _(Number)_
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/file/directoryentry/directoryentry.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/directoryentry/directoryentry.md b/docs/en/edge/cordova/file/directoryentry/directoryentry.md
index 661768d..a5b54e3 100644
--- a/docs/en/edge/cordova/file/directoryentry/directoryentry.md
+++ b/docs/en/edge/cordova/file/directoryentry/directoryentry.md
@@ -246,8 +246,8 @@ Deletes a directory. An error results if the app attempts to:
__Parameters:__
-- __successCallback__: A callback that is called after the directory has been deleted. Invoked with no parameters. _(Function)_
-- __errorCallback__: A callback that is called if an error occurs when attempting to delete the directory. Invoked with a `FileError` object. _(Function)_
+- __successCallback__: A callback that executes after the directory is deleted. Invoked with no parameters. _(Function)_
+- __errorCallback__: A callback that executes if an error occurs when attempting to delete the directory. Invoked with a `FileError` object. _(Function)_
__Quick Example__
@@ -265,12 +265,12 @@ __Quick Example__
getParent
---------
-Look up the parent DirectoryEntry containing the directory.
+Look up the parent `DirectoryEntry` containing the directory.
__Parameters:__
-- __successCallback__: A callback that is called with the directory's parent DirectoryEntry. _(Function)_
-- __errorCallback__: A callback that is called if an error occurs when attempting to retrieve the parent DirectoryEntry. Invoked with a `FileError` object. _(Function)_
+- __successCallback__: A callback that is passed the directory's parent `DirectoryEntry`. _(Function)_
+- __errorCallback__: A callback that executes if an error occurs when attempting to retrieve the parent `DirectoryEntry`. Invoked with a `FileError` object. _(Function)_
__Quick Example__
@@ -334,7 +334,7 @@ __Parameters:__
- __path__: The path to the file to be looked up or created. Either an absolute path, or a relative path from this `DirectoryEntry`. _(DOMString)_
- __options__: Options to specify whether the file is created if it doesn't exist. _(Flags)_
- __successCallback__: A callback that is passed a `FileEntry` object. _(Function)_
-- __errorCallback__: A callback that is called if an error occurs when creating or looking up the file. Invoked with a `FileError` object. _(Function)_
+- __errorCallback__: A callback that executes if an error occurs when creating or looking up the file. Invoked with a `FileError` object. _(Function)_
__Quick Example__
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/file/fileentry/fileentry.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/fileentry/fileentry.md b/docs/en/edge/cordova/file/fileentry/fileentry.md
index 9689f26..4b6f651 100644
--- a/docs/en/edge/cordova/file/fileentry/fileentry.md
+++ b/docs/en/edge/cordova/file/fileentry/fileentry.md
@@ -259,8 +259,8 @@ Look up the parent `DirectoryEntry` containing the file.
__Parameters:__
-- __successCallback__: A callback that is passed the file's parent DirectoryEntry. _(Function)_
-- __errorCallback__: A callback that executes if an error occurs when attempting to retrieve the parent DirectoryEntry. Invoked with a `FileError` object. _(Function)_
+- __successCallback__: A callback that is passed the file's parent `DirectoryEntry`. _(Function)_
+- __errorCallback__: A callback that executes if an error occurs when attempting to retrieve the parent `DirectoryEntry`. Invoked with a `FileError` object. _(Function)_
__Quick Example__
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/file/filetransfer/filetransfer.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/filetransfer/filetransfer.md b/docs/en/edge/cordova/file/filetransfer/filetransfer.md
index d1cfc08..46aca45 100644
--- a/docs/en/edge/cordova/file/filetransfer/filetransfer.md
+++ b/docs/en/edge/cordova/file/filetransfer/filetransfer.md
@@ -64,8 +64,8 @@ __Parameters:__
- __filePath__: Full path of the file on the device.
- __server__: URL of the server to receive the file, as encoded by `encodeURI()`.
-- __successCallback__: A callback that is called with a `Metadata` object. _(Function)_
-- __errorCallback__: A callback that is called if an error occurs retrieving the `Metadata`. Invoked with a `FileTransferError` object. _(Function)_
+- __successCallback__: A callback that is passed a `Metadata` object. _(Function)_
+- __errorCallback__: A callback that executes if an error occurs retrieving the `Metadata`. Invoked with a `FileTransferError` object. _(Function)_
- __options__: Optional parameters such as file name and mimetype.
- __trustAllHosts__: Optional parameter, defaults to `false`. If set to true, it accepts all security certificates. This is useful since Android rejects self-signed security certificates. Not recommended for production use. Supported on Android and iOS. _(boolean)_
@@ -239,7 +239,7 @@ __Quick Example__
abort
--------------
-Aborts an in-progress transfer. The onerror callback is called with a FileTransferError object which has an error code of FileTransferError.ABORT_ERR.
+Aborts an in-progress transfer. The onerror callback is passed a FileTransferError object which has an error code of FileTransferError.ABORT_ERR.
__Supported Platforms__
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md b/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
index 96c8be1..51beb4a 100644
--- a/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
+++ b/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
@@ -29,8 +29,8 @@ Returns the device's current position as a `Position` object.
Parameters
----------
-- __geolocationSuccess__: The callback that is called with the current position.
-- __geolocationError__: _(Optional)_ The callback that is called if there was an error.
+- __geolocationSuccess__: The callback that is passed the current position.
+- __geolocationError__: _(Optional)_ The callback that executes if an error occurs.
- __geolocationOptions__: _(Optional)_ The geolocation options.
Description
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md b/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md
index 72693e4..21877dc 100644
--- a/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md
+++ b/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md
@@ -30,7 +30,7 @@ Parameters
----------
- __geolocationSuccess__: The callback that is passed the current position.
-- __geolocationError__: (Optional) The callback that executes if there was an error.
+- __geolocationError__: (Optional) The callback that executes if an error occurs.
- __geolocationOptions__: (Optional) The geolocation options.
Returns
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md b/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md
index ff4d540..ba6cd54 100644
--- a/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md
+++ b/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md
@@ -29,7 +29,7 @@ Options
-------
- __enableHighAccuracy__: Provides a hint that the application needs the best possible results. By default, the device attempts to retrieve a `Position` using network-based methods. Setting this property to `true` tells the framework to use more accurate methods, such as satellite positioning. _(Boolean)_
-- __timeout__: The maximum length of time (milliseconds) that is allowed to pass from the call to `geolocation.getCurrentPosition` or `geolocation.watchPosition` until the corresponding `geolocationSuccess` callback is invoked. If the `geolocationSuccess` callback is not invoked within this time, the `geolocationError` callback is passed a `PositionError.TIMEOUT` error code. (Note that when used in conjunction with `geolocation.watchPosition`, the `geolocationError` callback could be called on an interval every `timeout` milliseconds!) _(Number)_
+- __timeout__: The maximum length of time (milliseconds) that is allowed to pass from the call to `geolocation.getCurrentPosition` or `geolocation.watchPosition` until the corresponding `geolocationSuccess` callback executes. If the `geolocationSuccess` callback is not invoked within this time, the `geolocationError` callback is passed a `PositionError.TIMEOUT` error code. (Note that when used in conjunction with `geolocation.watchPosition`, the `geolocationError` callback could be called on an interval every `timeout` milliseconds!) _(Number)_
- __maximumAge__: Accept a cached position whose age is no greater than the specified time in milliseconds. _(Number)_
Android Quirks
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/MediaError/mediaError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/MediaError/mediaError.md b/docs/en/edge/cordova/media/MediaError/mediaError.md
index e65d471..5652a27 100644
--- a/docs/en/edge/cordova/media/MediaError/mediaError.md
+++ b/docs/en/edge/cordova/media/MediaError/mediaError.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,13 +20,14 @@ license: Licensed to the Apache Software Foundation (ASF) under one
MediaError
==========
-A `MediaError` object is returned to the `mediaError` callback function when an error occurs.
+A `MediaError` object is returned to the `mediaError` callback
+function when an error occurs.
Properties
----------
- __code__: One of the predefined error codes listed below.
-- __message__: Error message describing the details of the error.
+- __message__: An error message describing the details of the error.
Constants
---------
@@ -39,5 +40,6 @@ Constants
Description
-----------
-The `MediaError` object is returned to the user through the `mediaError` callback function when an error occurs.
+The `MediaError` object is passed to a `mediaError` callback function
+when an error occurs.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/Parameters/mediaError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/Parameters/mediaError.md b/docs/en/edge/cordova/media/Parameters/mediaError.md
index f152ab4..08b4400 100644
--- a/docs/en/edge/cordova/media/Parameters/mediaError.md
+++ b/docs/en/edge/cordova/media/Parameters/mediaError.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,7 +20,8 @@ license: Licensed to the Apache Software Foundation (ASF) under one
mediaError
==========
-A user specified callback function that is invoked when there is an error in media functions.
+A user-specified callback function that executes when there is an
+error in media functions.
function(error) {
// Handle the error
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/capture/CaptureCB.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/CaptureCB.md b/docs/en/edge/cordova/media/capture/CaptureCB.md
index b020fb0..d1d7599 100644
--- a/docs/en/edge/cordova/media/capture/CaptureCB.md
+++ b/docs/en/edge/cordova/media/capture/CaptureCB.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -27,9 +27,12 @@ CaptureCB
Description
-----------
-This function is invoked after a successful capture operation has completed. This means a media file has been captured, and either the user has exited the media capture application, or the capture limit has been reached.
+This function executes after a successful capture operation completes.
+At this point a media file has been captured, and either the user has
+exited the media capture application, or the capture limit has been
+reached.
-Each MediaFile object describes a captured media file.
+Each `MediaFile` object describes a captured media file.
Quick Example
-------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/capture/CaptureError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/CaptureError.md b/docs/en/edge/cordova/media/capture/CaptureError.md
index 310f3e9..0268f06 100644
--- a/docs/en/edge/cordova/media/capture/CaptureError.md
+++ b/docs/en/edge/cordova/media/capture/CaptureError.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -30,8 +30,8 @@ Properties
Constants
---------
-- CaptureError.`CAPTURE_INTERNAL_ERR`: Camera or microphone failed to capture image or sound.
-- CaptureError.`CAPTURE_APPLICATION_BUSY`: Camera application or audio capture application is currently serving other capture request.
-- CaptureError.`CAPTURE_INVALID_ARGUMENT`: Invalid use of the API (e.g. limit parameter has value less than one).
-- CaptureError.`CAPTURE_NO_MEDIA_FILES`: User exited camera application or audio capture application before capturing anything.
-- CaptureError.`CAPTURE_NOT_SUPPORTED`: The requested capture operation is not supported.
+- `CaptureError.CAPTURE_INTERNAL_ERR`: The camera or microphone failed to capture image or sound.
+- `CaptureError.CAPTURE_APPLICATION_BUSY`: The camera or audio capture application is currently serving another capture request.
+- `CaptureError.CAPTURE_INVALID_ARGUMENT`: Invalid use of the API (e.g. the value of `limit` is less than one).
+- `CaptureError.CAPTURE_NO_MEDIA_FILES`: The user exits the camera or audio capture application before capturing anything.
+- `CaptureError.CAPTURE_NOT_SUPPORTED`: The requested capture operation is not supported.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/capture/CaptureErrorCB.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/CaptureErrorCB.md b/docs/en/edge/cordova/media/capture/CaptureErrorCB.md
index b54e646..f3771e6 100644
--- a/docs/en/edge/cordova/media/capture/CaptureErrorCB.md
+++ b/docs/en/edge/cordova/media/capture/CaptureErrorCB.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -27,9 +27,13 @@ CaptureErrorCB
Description
-----------
-This function is invoked if an error occurs when trying to launch a media capture operation and the capture application is busy, if an error occurs while the capture operation is taking place, or if the capture operation has been canceled by the user before any media files have been captured.
+This function executes if an error occurs when trying to launch a
+media capture operation. Failure scenarios include when the capture
+application is busy, a capture operation is already taking place, or
+the user cancels the operation before any media files are captured.
-This function is invoked with a CaptureError object containing an appropriate error code.
+This function executes with a `CaptureError` object containing an
+appropriate error `code`.
Quick Example
-------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/capture/ConfigurationData.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/ConfigurationData.md b/docs/en/edge/cordova/media/capture/ConfigurationData.md
index c86eafb..361f45a 100644
--- a/docs/en/edge/cordova/media/capture/ConfigurationData.md
+++ b/docs/en/edge/cordova/media/capture/ConfigurationData.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -25,22 +25,24 @@ ConfigurationData
Description
-----------
-This object is used to describe media capture modes supported by the device. The configuration data includes the MIME type, and capture dimensions (for video or image capture).
+Describes media capture modes supported by the device. The
+configuration data includes the MIME type, and capture dimensions for
+video or image capture.
The MIME types should adhere to [RFC2046](http://www.ietf.org/rfc/rfc2046.txt). Examples:
-- video/3gpp
-- video/quicktime
-- image/jpeg
-- audio/amr
-- audio/wav
+- `video/3gpp`
+- `video/quicktime`
+- `image/jpeg`
+- `audio/amr`
+- `audio/wav`
Properties
----------
-- __type__: The ASCII-encoded string in lower case representing the media type. (DOMString)
-- __height__: The height of the image or video in pixels. In the case of a sound clip, this attribute has value 0. (Number)
-- __width__: The width of the image or video in pixels. In the case of a sound clip, this attribute has value 0. (Number)
+- __type__: The ASCII-encoded lowercase string representing the media type. (DOMString)
+- __height__: The height of the image or video in pixels. The value is zero for sound clips. (Number)
+- __width__: The width of the image or video in pixels. The value is zero for sound clips. (Number)
Quick Example
-------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/capture/MediaFile.getFormatData.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/MediaFile.getFormatData.md b/docs/en/edge/cordova/media/capture/MediaFile.getFormatData.md
index 76662ae..03fdd00 100644
--- a/docs/en/edge/cordova/media/capture/MediaFile.getFormatData.md
+++ b/docs/en/edge/cordova/media/capture/MediaFile.getFormatData.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -30,7 +30,11 @@ MediaFile.getFormatData
Description
-----------
-This function asynchronously attempts to retrieve the format information for the media file. If successful, it invokes the MediaFileDataSuccessCB callback with a MediaFileData object. If the attempt fails, this function will invoke the MediaFileDataErrorCB callback.
+This function asynchronously attempts to retrieve the format
+information for the media file. If successful, it invokes the
+`MediaFileDataSuccessCB` callback with a `MediaFileData` object. If
+the attempt fails, this function invokes the `MediaFileDataErrorCB`
+callback.
Supported Platforms
-------------------
@@ -43,12 +47,19 @@ Supported Platforms
BlackBerry WebWorks Quirks
--------------------------
-There is no API that provides format information of media files. Therefore, all MediaFileData objects will be returned with default values. See MediaFileData documentation.
+
+Does not provide an API for information about media files, so all
+`MediaFileData` objects return with default values.
Android Quirks
--------------
-The API for retrieving media file format information is limited. Therefore, not all MediaFileData properties are supported. See MediaFileData documentation.
+
+The API to access media file format information is limited, so not all
+`MediaFileData` properties are supported.
iOS Quirks
----------
-The API for retrieving media file format information is limited. Therefore, not all MediaFileData properties are supported. See MediaFileData documentation.
+
+The API to access media file format information is limited, so not all
+`MediaFileData` properties are supported.
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/capture/MediaFile.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/MediaFile.md b/docs/en/edge/cordova/media/capture/MediaFile.md
index eae4810..3bca7aa 100644
--- a/docs/en/edge/cordova/media/capture/MediaFile.md
+++ b/docs/en/edge/cordova/media/capture/MediaFile.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -27,8 +27,8 @@ Properties
- __name__: The name of the file, without path information. (DOMString)
- __fullPath__: The full path of the file, including the name. (DOMString)
-- __type__: The mime type (DOMString)
-- __lastModifiedDate__: The date and time that the file was last modified. (Date)
+- __type__: The file's mime type (DOMString)
+- __lastModifiedDate__: The date and time when the file was last modified. (Date)
- __size__: The size of the file, in bytes. (Number)
Methods
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/capture/MediaFileData.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/MediaFileData.md b/docs/en/edge/cordova/media/capture/MediaFileData.md
index 4ff8939..545b549 100644
--- a/docs/en/edge/cordova/media/capture/MediaFileData.md
+++ b/docs/en/edge/cordova/media/capture/MediaFileData.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -26,37 +26,40 @@ Properties
----------
- __codecs__: The actual format of the audio and video content. (DOMString)
-- __bitrate__: The average bitrate of the content. In case of an image, this attribute has value 0. (Number)
-- __height__: The height of the image or video in pixels. In the case of a sound clip, this attribute has value 0. (Number)
-- __width__: The width of the image or video in pixels. In the case of a sound clip, this attribute has value 0. (Number)
-- __duration__: The length of the video or sound clip in seconds. In the case of an image, this attribute has value 0. (Number)
+- __bitrate__: The average bitrate of the content. The value is zero for images. (Number)
+- __height__: The height of the image or video in pixels. The value is zero for audio clips. (Number)
+- __width__: The width of the image or video in pixels. The value is zero for audio clips. (Number)
+- __duration__: The length of the video or sound clip in seconds. The value is zero for images. (Number)
BlackBerry WebWorks Quirks
--------------------------
-There is no API that provides format information of media files. So the MediaFileData object returned by the MediaFile.getFormatData function will have the following default values:
-- __codecs__: Not supported. The attribute will always be null.
-- __bitrate__: Not supported. The attribute will always be 0.
-- __height__: Not supported. The attribute will always be 0.
-- __width__: Not supported. The attribute will always be 0.
-- __duration__: Not supported. The attribute will always be 0.
+No API provides format information for media files, so the
+`MediaFileData` object returned by `MediaFile.getFormatData` features
+the following default values:
+
+- __codecs__: Not supported, and returns `null`.
+- __bitrate__: Not supported, and returns zero.
+- __height__: Not supported, and returns zero.
+- __width__: Not supported, and returns zero.
+- __duration__: Not supported, and returns zero.
Android Quirks
--------------
-Support for the MediaFileData properties is as follows:
+Supports the following `MediaFileData` properties:
-- __codecs__: Not supported. The attribute will always be null.
-- __bitrate__: Not supported. The attribute will always be 0.
-- __height__: Supported. (Image and video files only).
-- __width__: Supported. (Image and video files only).
-- __duration__: Supported. (Audio and video files only).
+- __codecs__: Not supported, and returns `null`.
+- __bitrate__: Not supported, and returns zero.
+- __height__: Supported: image and video files only.
+- __width__: Supported: image and video files only.
+- __duration__: Supported: audio and video files only.
iOS Quirks
----------
-Support for the MediaFileData properties is as follows:
+Supports the following `MediaFileData` properties:
-- __codecs__: Not supported. The attribute will always be null.
-- __bitrate__: Supported on iOS4 devices for audio only. The attribute will always be 0 for image and video.
-- __height__: Supported. (Image and video files only).
-- __width__: Supported. (Image and video files only).
-- __duration__: Supported. (Audio and video files only).
+- __codecs__: Not supported, and returns null.
+- __bitrate__: Supported on iOS4 devices for audio only. Returns zero for images and videos.
+- __height__: Supported: image and video files only.
+- __width__: Supported: image and video files only.
+- __duration__: Supported: audio and video files only.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/capture/capture.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/capture.md b/docs/en/edge/cordova/media/capture/capture.md
index ffa8553..013d11b 100644
--- a/docs/en/edge/cordova/media/capture/capture.md
+++ b/docs/en/edge/cordova/media/capture/capture.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
Capture
=======
-> Provides access to the audio, image, and video capture capabilities of the device.
+> Provides access to the device's audio, image, and video capture capabilities.
Objects
-------
@@ -46,7 +46,8 @@ Methods
Scope
-----
-The __capture__ object is assigned to the __navigator.device__ object, and therefore has global scope.
+The `capture` object is assigned to the `navigator.device` object, and
+therefore has global scope.
// The global capture object
var capture = navigator.device.capture;
@@ -61,9 +62,9 @@ Properties
Methods
-------
-- capture.captureAudio: Launch the device audio recording application for recording audio clip(s).
-- capture.captureImage: Launch the device camera application for taking image(s).
-- capture.captureVideo: Launch the device video recorder application for recording video(s).
+- `capture.captureAudio`: Launch the device's audio recording application to record audio clips.
+- `capture.captureImage`: Launch the device's camera application to take photos.
+- `capture.captureVideo`: Launch the device's video recorder application to record videos.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/capture/captureAudio.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/captureAudio.md b/docs/en/edge/cordova/media/capture/captureAudio.md
index e32d96c..cfc318a 100644
--- a/docs/en/edge/cordova/media/capture/captureAudio.md
+++ b/docs/en/edge/cordova/media/capture/captureAudio.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
capture.captureAudio
====================
-> Start the audio recorder application and return information about captured audio clip file(s).
+> Start the audio recorder application and return information about the captured audio clip file(s).
navigator.device.capture.captureAudio(
CaptureCB captureSuccess, CaptureErrorCB captureError, [CaptureAudioOptions options]
@@ -29,11 +29,22 @@ capture.captureAudio
Description
-----------
-This method starts an asynchronous operation to capture audio recordings using the device's default audio recording application. The operation allows the device user to capture multiple recordings in a single session.
+Starts an asynchronous operation to capture audio recordings using the
+device's default audio recording application. The operation allows
+the device user to capture multiple recordings in a single session.
-The capture operation ends when either the user exits the audio recording application, or the maximum number of recordings, specified by the __limit__ parameter in CaptureAudioOptions, has been reached. If no value is provided for the __limit__ parameter, a default value of one (1) is used, and the capture operation will terminate after the user records a single audio clip.
+The capture operation ends when either the user exits the audio
+recording application, or the maximum number of recordings specified
+by `CaptureAudioOptions.limit` is reached. If no `limit` parameter
+value is specified, it defaults to one (1), and the capture operation
+terminates after the user records a single audio clip.
-When the capture operation is finished, it will invoke the CaptureCallback callback with an array of MediaFile objects describing each captured audio clip file. If the operation is terminated by the user before an audio clip is captured, the CaptureErrorCallback callback will be invoked with a CaptureError object with the CaptureError.`CAPTURE_NO_MEDIA_FILES` error code.
+When the capture operation finishes, the `CaptureCallback` executes
+with an array of `MediaFile` objects describing each captured audio
+clip file. If the user terminates the operation before an audio clip
+is captured, the `CaptureErrorCallback` executes with a `CaptureError`
+object, featuring the `CaptureError.CAPTURE_NO_MEDIA_FILES` error
+code.
Supported Platforms
-------------------
@@ -128,14 +139,14 @@ Full Example
BlackBerry WebWorks Quirks
--------------------------
-- Cordova for BlackBerry WebWorks attempts to launch the __Voice Notes Recorder__ application, provided by RIM, to capture the audio recordings. The developer will receive a CaptureError.`CAPTURE_NOT_SUPPORTED` error code if the application is not installed on the device.
+- Cordova for BlackBerry WebWorks attempts to launch the __Voice Notes Recorder__ application, provided by RIM, to capture audio recordings. The app receives a `CaptureError.CAPTURE_NOT_SUPPORTED` error code if the application is not installed on the device.
iOS Quirks
----------
-- iOS does not have a default audio recording application so a simple user interface is provided.
+- iOS does not have a default audio recording application, so a simple user interface is provided.
Windows Phone 7 and 8 Quirks
----------
-- Windows Phone 7 does not have a default audio recording application so a simple user interface is provided.
+- Windows Phone 7 does not have a default audio recording application, so a simple user interface is provided.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/capture/captureAudioOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/captureAudioOptions.md b/docs/en/edge/cordova/media/capture/captureAudioOptions.md
index 583a7f5..c7d7ac2 100644
--- a/docs/en/edge/cordova/media/capture/captureAudioOptions.md
+++ b/docs/en/edge/cordova/media/capture/captureAudioOptions.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -39,14 +39,14 @@ Quick Example
Android Quirks
--------------
-- The __duration__ parameter is not supported. Recording lengths cannot be limited programmatically.
+- The `duration` parameter is not supported. Recording lengths cannot be limited programmatically.
BlackBerry WebWorks Quirks
--------------------------
-- The __duration__ parameter is not supported. Recording lengths cannot be limited programmatically.
+- The `duration` parameter is not supported. Recording lengths cannot be limited programmatically.
iOS Quirks
----------
-- The __limit__ parameter is not supported. One recording can be created for each invocation.
+- The `limit` parameter is not supported, so only one recording can be created for each invocation.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/capture/captureImage.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/captureImage.md b/docs/en/edge/cordova/media/capture/captureImage.md
index 5930897..3bbc124 100644
--- a/docs/en/edge/cordova/media/capture/captureImage.md
+++ b/docs/en/edge/cordova/media/capture/captureImage.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -29,11 +29,21 @@ capture.captureImage
Description
-----------
-This method starts an asynchronous operation to capture images using the device camera application. The operation allows the device user to capture multiple images in a single session.
+Starts an asynchronous operation to capture images using the device's
+camera application. The operation allows users to capture more than
+one image in a single session.
-The capture operation ends when either the user exits the camera application, or the maximum number of images, specified by the __limit__ parameter in CaptureImageOptions, has been reached. If no value is provided for the __limit__ parameter, a default value of one (1) is used, and the capture operation will terminate after the user captures a single image.
+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
+specified, it defaults to one (1), and the capture operation
+terminates after the user captures a single image.
-When the capture operation is finished, it will invoke the CaptureCB callback with an array of MediaFile objects describing each captured image file. If the operation is terminated by the user before an image is captured, the CaptureErrorCB callback will be invoked with a CaptureError object with the CaptureError.`CAPTURE_NO_MEDIA_FILES` error code.
+When the capture operation finishes, it invokes the `CaptureCB`
+callback with an array of `MediaFile` objects describing each captured
+image file. If the user terminates the operation before capturing an
+image, the `CaptureErrorCB` callback executes with a `CaptureError`
+object featuring a `CaptureError.CAPTURE_NO_MEDIA_FILES` error code.
Supported Platforms
-------------------
@@ -49,7 +59,7 @@ Windows Phone 7 Quirks
----------------------
Invoking the native camera application while your device is connected
-via Zune will not work, and the error callback will be triggered.
+via Zune does not work, and the error callback executes.
Quick Example
-------------
@@ -135,24 +145,24 @@ Full Example
Bada Quirks
-----------
-Bada supports _captureImage_ just like the other platforms. However there is _another_ mode where you can capture a video or an image straight in the webview without launching any camera app. In order to do that you need to:
+Bada supports `captureImage` just like the other platforms, but
+features _another_ mode allowing video or image capture straight into
+the WebView without launching any camera app. Here's how:
-1. create a _<div>_ element somewhere in your document and give it an id (such as "preview").
+1. Create an element with an `id` attribute somewhere in the HTML:
<div id="preview"></div>
-2. Initialize the camera preview with the following method
+2. Initialize the camera preview as follows:
navigator.camera.showPreview("preview");
-3. Once you get the preview you can
-
- 3.1 Capture an image with
+3. Once you the preview displays, capture the image with code such as the following:
var options = { destinationFilename: "images/cam01.jpg", highRes: false};
navigator.capture.captureImage(success, fail, options);
-3. Hide the camera preview with the following method
+4. Dismiss the camera preview as follows:
navigator.camera.hidePreview("preview");
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/capture/captureImageOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/captureImageOptions.md b/docs/en/edge/cordova/media/capture/captureImageOptions.md
index 4dcda3b..b751bd1 100644
--- a/docs/en/edge/cordova/media/capture/captureImageOptions.md
+++ b/docs/en/edge/cordova/media/capture/captureImageOptions.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -25,7 +25,7 @@ CaptureImageOptions
Properties
----------
-- __limit__: The maximum number of images the device user can capture in a single capture operation. The value must be greater than or equal to 1 (defaults to 1).
+- __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).
Quick Example
-------------
@@ -38,4 +38,4 @@ Quick Example
iOS Quirks
----------
-- The __limit__ parameter is not supported. One image is taken per invocation.
+- The __limit__ parameter is not supported, and only one image is taken per invocation.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/capture/captureVideo.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/captureVideo.md b/docs/en/edge/cordova/media/capture/captureVideo.md
index 7a75725..cb9c591 100644
--- a/docs/en/edge/cordova/media/capture/captureVideo.md
+++ b/docs/en/edge/cordova/media/capture/captureVideo.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -29,11 +29,22 @@ capture.captureVideo
Description
-----------
-This method starts an asynchronous operation to capture video recordings using the device video recording application. The operation allows the device user to capture multiple recordings in a single session.
+Starts an asynchronous operation to capture video recordings using the
+device's video recording application. The operation allows the user
+to capture more than one recordings in a single session.
-The capture operation ends when either the user exits the video recording application, or the maximum number of recordings, specified by the __limit__ parameter in CaptureVideoOptions, has been reached. If no value is provided for the __limit__ parameter, a default value of one (1) is used, and the capture operation will terminate after the user records a single video clip.
+The capture operation ends when either the user exits the video
+recording application, or the maximum number of recordings specified
+by `CaptureVideoOptions.limit` is reached. If no `limit` parameter
+value is specified, it defaults to one (1), and the capture operation
+terminates after the user records a single video clip.
-When the capture operation is finished, it will invoke the CaptureCB callback with an array of MediaFile objects describing each captured video clip file. If the operation is terminated by the user before an video clip is captured, the CaptureErrorCB callback will be invoked with a CaptureError object with the CaptureError.`CAPTURE_NO_MEDIA_FILES` error code.
+When the capture operation finishes, it the `CaptureCB` callback
+executes with an array of `MediaFile` objects describing each captured
+video clip file. If the user terminates the operation before
+capturing a video clip, the `CaptureErrorCB` callback executes with a
+`CaptureError` object featuring a
+`CaptureError.CAPTURE_NO_MEDIA_FILES` error code.
Supported Platforms
-------------------
@@ -129,32 +140,32 @@ Full Example
BlackBerry WebWorks Quirks
--------------------------
-- Cordova for BlackBerry WebWorks attempts to launch the __Video Recorder__ application, provided by RIM, to capture the video recordings. The developer will receive a CaptureError.`CAPTURE_NOT_SUPPORTED` error code if the application is not installed on the device.
+- Cordova for BlackBerry WebWorks 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.
Bada 2.x Quirks
---------------
-Bada supports _captureVideo_ just like the other platforms. However there is _another_ mode where you can capture a video or an image straight in the webview without launching any camera apps. In order to do that you need to:
+Bada supports `captureVideo` just like the other platforms, but
+features _another_ mode allowing video or image capture straight into
+the WebView without launching any camera app. Here's how:
-1. create a _<div>_ element somewhere in your document and give it an id (such as "preview").
+1. Create an element with an `id` attribute somewhere in the HTML:
<div id="preview"></div>
-2. Initialize the camera preview with the following method
+2. Initialize the camera preview as follows:
navigator.camera.showPreview("preview");
-3. Once you get the preview you can
-
- 3.1 Start capturing a video with
+3. Once the preview is available, use code such as this to start capturing a video:
navigator.capture.startVideoCapture(success, fail, {duration: 5000, destinationFilename: "videos/a.3gp"});
- 3.2 Stop the video capture with
+4. Use this to stop the video capture:
navigator.capture.stopVideoCapture();
-3. Hide the camera preview with the following method
+5. Dismiss the camera preview as follows:
navigator.camera.hidePreview("preview");
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/capture/captureVideoOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/captureVideoOptions.md b/docs/en/edge/cordova/media/capture/captureVideoOptions.md
index f3072fa..1df0a72 100644
--- a/docs/en/edge/cordova/media/capture/captureVideoOptions.md
+++ b/docs/en/edge/cordova/media/capture/captureVideoOptions.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -25,7 +25,7 @@ CaptureVideoOptions
Properties
----------
-- __limit__: The maximum number of video clips the device user can capture in a single capture operation. The value must be greater than or equal to 1 (defaults to 1).
+- __limit__: The maximum number of video clips the device's user can capture in a single capture operation. The value must be greater than or equal to 1 (defaults to 1).
- __duration__: The maximum duration of a video clip, in seconds.
Quick Example
@@ -39,10 +39,11 @@ Quick Example
BlackBerry WebWorks Quirks
--------------------------
-- The __duration__ parameter is not supported. Recording lengths cannot be limited programmatically.
+- The __duration__ parameter is not supported, so the length of recordings cannot be limited programmatically.
iOS Quirks
----------
-- The __limit__ parameter is not supported. One video is recorded per invocation.
-- The __duration__ parameter is not supported. Recording lengths cannot be limited programmatically.
+- The __limit__ parameter is not supported. Only one video is recorded per invocation.
+- The __duration__ parameter is not supported. The length of recordings cannot be limited programmatically.
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/media.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.getCurrentPosition.md b/docs/en/edge/cordova/media/media.getCurrentPosition.md
index f858bb1..2284b5c 100644
--- a/docs/en/edge/cordova/media/media.getCurrentPosition.md
+++ b/docs/en/edge/cordova/media/media.getCurrentPosition.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -27,13 +27,15 @@ Returns the current position within an audio file.
Parameters
----------
-- __mediaSuccess__: The callback that is called with the current position in seconds.
-- __mediaError__: (Optional) The callback that is called if there was an error.
+- __mediaSuccess__: The callback that is passed the current position in seconds.
+- __mediaError__: (Optional) The callback to execute if an error occurs.
Description
-----------
-Function `media.getCurrentPosition` is an asynchronous function that returns the current position of the underlying audio file of a Media object. Also updates the ___position__ parameter within the Media object.
+An asynchronous function that returns the current position of the
+underlying audio file of a `Media` object. Also updates the `Media`
+object's `position` parameter.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/media.getDuration.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.getDuration.md b/docs/en/edge/cordova/media/media.getDuration.md
index a558f31..b7825dd 100644
--- a/docs/en/edge/cordova/media/media.getDuration.md
+++ b/docs/en/edge/cordova/media/media.getDuration.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -27,7 +27,9 @@ Returns the duration of an audio file.
Description
-----------
-Function `media.getDuration` is a synchronous function that returns the duration of the audio file in seconds, if known. If the duration is unknown, a value of -1 is returned.
+The `media.getDuration` method executes synchronously, returning the
+duration of the audio file in seconds, if known. If the duration is
+unknown, it returns a value of -1.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/media.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.md b/docs/en/edge/cordova/media/media.md
index 1632c1e..09c7037 100644
--- a/docs/en/edge/cordova/media/media.md
+++ b/docs/en/edge/cordova/media/media.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -24,20 +24,24 @@ Media
var media = new Media(src, mediaSuccess, [mediaError], [mediaStatus]);
-Note: The current implementation does not adhere to a W3C specification for media capture, and is provided for convenience only. A future implementation will adhere to the latest W3C specification and may deprecate the current APIs.
+__NOTE:__ The current implementation does not adhere to a W3C
+specification for media capture, and is provided for convenience only.
+A future implementation will adhere to the latest W3C specification
+and may deprecate the current APIs.
Parameters
----------
- __src__: A URI containing the audio content. _(DOMString)_
-- __mediaSuccess__: (Optional) The callback that is invoked after a Media object has completed the current play/record or stop action. _(Function)_
-- __mediaError__: (Optional) The callback that is invoked if there was an error. _(Function)_
-- __mediaStatus__: (Optional) The callback that is invoked to indicate status changes. _(Function)_
+- __mediaSuccess__: (Optional) The callback that executes after a `Media` object has completed the current play, record, or stop action. _(Function)_
+- __mediaError__: (Optional) The callback that executes if an error occurs. _(Function)_
+- __mediaStatus__: (Optional) The callback that executes to indicate status changes. _(Function)_
Constants
---------
-The following constants are reported as the only parameter to the __mediaStatus__ callback function.
+The following constants are reported as the only parameter to the
+`mediaStatus` callback:
- `Media.MEDIA_NONE` = 0;
- `Media.MEDIA_STARTING` = 1;
@@ -48,22 +52,22 @@ The following constants are reported as the only parameter to the __mediaStatus_
Methods
-------
-- media.getCurrentPosition: Returns the current position within an audio file.
-- media.getDuration: Returns the duration of an audio file.
-- media.play: Start or resume playing audio file.
-- media.pause: Pause playing audio file.
-- media.release: Releases the underlying OS'es audio resources.
-- media.seekTo: Moves the position within the audio file.
-- media.startRecord: Start recording audio file.
-- media.stopRecord: Stop recording audio file.
-- media.stop: Stop playing audio file.
+- `media.getCurrentPosition`: Returns the current position within an audio file.
+- `media.getDuration`: Returns the duration of an audio file.
+- `media.play`: Start or resume playing an audio file.
+- `media.pause`: Pause playback of an audio file.
+- `media.release`: Releases the underlying operating system's audio resources.
+- `media.seekTo`: Moves the position within the audio file.
+- `media.startRecord`: Start recording an audio file.
+- `media.stopRecord`: Stop recording an audio file.
+- `media.stop`: Stop playing an audio file.
Additional ReadOnly Parameters
---------------------
-- __position__: The position within the audio playback in seconds.
- - Not automatically updated during play, call `getCurrentPosition` to update.
-- __duration__: The duration of the media in seconds.
+- __position__: The position within the audio playback, in seconds.
+ - Not automatically updated during play; call `getCurrentPosition` to update.
+- __duration__: The duration of the media, in seconds.
Supported Platforms
-------------------
@@ -133,5 +137,6 @@ Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en
No permissions are required.
### Windows Phone Quirks
- Only one media file can be played back at a time.
- There are strict restrictions as to how your application interacts with other media. See http://msdn.microsoft.com/en-us/library/windowsphone/develop/hh184838(v=vs.92).aspx
+- Only one media file can be played back at a time.
+
+- There are strict restrictions on how your application interacts with other media. See [Windows Phone Developer Center](http://msdn.microsoft.com/en-us/library/windowsphone/develop/hh184838(v=vs.92).aspx).
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/media.pause.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.pause.md b/docs/en/edge/cordova/media/media.pause.md
index 4910c37..116e3ea 100644
--- a/docs/en/edge/cordova/media/media.pause.md
+++ b/docs/en/edge/cordova/media/media.pause.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -27,7 +27,7 @@ Pauses playing an audio file.
Description
-----------
-Function `media.pause` is a synchronous function that pauses playing an audio file.
+The `media.pause` method executes synchronously, and pauses playing an audio file.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/media.play.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.play.md b/docs/en/edge/cordova/media/media.play.md
index 67b508d..c489704 100644
--- a/docs/en/edge/cordova/media/media.play.md
+++ b/docs/en/edge/cordova/media/media.play.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -27,7 +27,8 @@ Starts or resumes playing an audio file.
Description
-----------
-Function `media.play` is a synchronous function that starts or resumes playing an audio file.
+The `media.play` method executes synchronously, and starts or resumes
+playing an audio file.
Supported Platforms
-------------------
@@ -168,28 +169,32 @@ Full Example
BlackBerry WebWorks Quirks
----------
-- BlackBerry devices support a limited number of simultaneous audio channels. CDMA devices only support a single audio channel. Other devices support up to two simultaneous channels. Attempting to play more audio files then the supported amount will result in previous playback being stopped.
+- BlackBerry devices support a limited number of simultaneous audio
+ channels. CDMA devices only support a single audio channel. Other
+ devices support up to two simultaneous channels. An attempt to play
+ more audio files than the supported amount results in previous
+ playback being stopped.
-iOS Quirk
----------
+iOS Quirks
+----------
-- __numberOfLoops__
-
- Pass in this option to the **play** method to specify the number of times you want the media file to play. e.g:
+- __numberOfLoops__: Pass this option to the `play` method to specify
+ the number of times you want the media file to play, e.g.:
var myMedia = new Media("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3")
myMedia.play({ numberOfLoops: 2 })
-- __playAudioWhenScreenIsLocked__
-
- Pass in this option to the **play** method to specify whether you want to play the audio of the media file when the screen is locked (this defaults to true if not set). If this is set to true, it will ignore the state of the hardware mute button. e.g:
+- __playAudioWhenScreenIsLocked__: Pass in this option to the `play`
+ method to specify whether you want to allow playback when the screen
+ is locked. If set to `true` (the default value), the state of the
+ hardware mute button is ignored, e.g.:
var myMedia = new Media("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3")
myMedia.play({ playAudioWhenScreenIsLocked : false })
-- __order of file search__
-
- When only a file name or simple path is provided, iOS will search in the www for the file and then in the application documents/tmp directory.
+- __order of file search__: When only a file name or simple path is
+ provided, iOS searches in the `www` directory for the file, then in
+ the application's `documents/tmp` directory:
var myMedia = new Media("audio/beer.mp3")
- myMedia.play() // will first look for file in www/audio/beer.mp3 then in <application>/documents/tmp/audio/beer.mp3
+ myMedia.play() // first looks for file in www/audio/beer.mp3 then in <application>/documents/tmp/audio/beer.mp3
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/media.release.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.release.md b/docs/en/edge/cordova/media/media.release.md
index 6528cdc..d7f933d 100644
--- a/docs/en/edge/cordova/media/media.release.md
+++ b/docs/en/edge/cordova/media/media.release.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,14 +20,18 @@ license: Licensed to the Apache Software Foundation (ASF) under one
media.release
=================
-Releases the underlying operating systems audio resources.
+Releases the underlying operating system's audio resources.
media.release();
Description
-----------
-Function `media.release` is a synchronous function that releases the underlying operating systems audio resources. This function is particularly important for Android as there are a finite amount of OpenCore instances for media playback. Developers should call the 'release' function when they no longer need the Media resource.
+The `media.release` method executes synchronously, releasing the
+underlying operating system's audio resources. This is particularly
+important for Android, since there are a finite amount of OpenCore
+instances for media playback. Applications should call the `release`
+function for any `Media` resource that is no longer needed.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/media.seekTo.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.seekTo.md b/docs/en/edge/cordova/media/media.seekTo.md
index f737480..f1e47c0 100644
--- a/docs/en/edge/cordova/media/media.seekTo.md
+++ b/docs/en/edge/cordova/media/media.seekTo.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -27,12 +27,14 @@ Sets the current position within an audio file.
Parameters
----------
-- __milliseconds__: The position to set the playback position within the audio in milliseconds. .
+- __milliseconds__: The position to set the playback position within the audio, in milliseconds.
Description
-----------
-Function `media.seekTo` is an asynchronous function that updates the current position of the underlying audio file of a Media object. Also updates the ___position__ parameter within the Media object.
+The `media.seekTo` executes asynchronously, updating the current
+playback position within an audio file referenced by a `Media`
+object. Also updates the `Media` object's `position` parameter.
Supported Platforms
-------------------
@@ -154,4 +156,4 @@ Full Example
BlackBerry WebWorks Quirks
----------
-- This API is not supported on BlackBerry OS 5 devices.
+- Not supported on BlackBerry OS 5 devices.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/media.startRecord.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.startRecord.md b/docs/en/edge/cordova/media/media.startRecord.md
index f4f2d42..e4e7d2d 100644
--- a/docs/en/edge/cordova/media/media.startRecord.md
+++ b/docs/en/edge/cordova/media/media.startRecord.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -27,7 +27,8 @@ Starts recording an audio file.
Description
-----------
-Function `media.startRecord` is a synchronous function that starts recording an audio file.
+The `media.startRecord` method executes synchronously, starts a
+recording for an audio file.
Supported Platforms
-------------------
@@ -132,18 +133,18 @@ Full Example
Android Quirks
----------
-- Android devices record audio in Adaptive Multi-Rate format. The specified file should end with a .amr extension.
+- Android devices record audio in Adaptive Multi-Rate format. The specified file should end with a _.amr_ extension.
BlackBerry WebWorks Quirks
----------
-- BlackBerry devices record audio in Adaptive Multi-Rate format. The specified file must end with a .amr extension.
+- BlackBerry devices record audio in Adaptive Multi-Rate format. The specified file must end with a _.amr_ extension.
iOS Quirks
----------
-- iOS only records to files of type .wav and returns an error if the file name extension is not correct.
-- If a full path is not provided the recording will be placed in the <application>/documents/tmp directory. This can be accessed via the File apis using LocalFileSystem.TEMPORARY. Subdirectories are not created at record time and must already exist. Thus, myRecording.wav will work but recordings/myRecording.wav will not if the recordings directory does not already exist at <application>/documents/tmp/.
+- iOS only records to files of type _.wav_ and returns an error if the file name extension is not correct.
+- If a full path is not provided, the recording is placed in the application's _documents/tmp_ directory. This can be accessed via the `File` API using `LocalFileSystem.TEMPORARY`. Any subdirectory specified at record time must already exist.
- Files can be recorded and played back using the documents URI:
var myMedia = new Media("documents://beer.mp3")
@@ -151,4 +152,4 @@ iOS Quirks
Tizen Quirks
----------
-- This API is not supported on Tizen devices.
+- Not supported on Tizen devices.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/media.stop.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.stop.md b/docs/en/edge/cordova/media/media.stop.md
index 52b9037..00b311b 100644
--- a/docs/en/edge/cordova/media/media.stop.md
+++ b/docs/en/edge/cordova/media/media.stop.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -27,7 +27,8 @@ Stops playing an audio file.
Description
-----------
-Function `media.stop` is a synchronous function that stops playing an audio file.
+The `media.stop` method executes synchronously to stop playing an
+audio file.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/media.stopRecord.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.stopRecord.md b/docs/en/edge/cordova/media/media.stopRecord.md
index e04e7cb..0a97e6c 100644
--- a/docs/en/edge/cordova/media/media.stopRecord.md
+++ b/docs/en/edge/cordova/media/media.stopRecord.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -27,7 +27,8 @@ Stops recording an audio file.
Description
-----------
-Function `media.stopRecord` is a synchronous function that stops recording an audio file.
+The `media.stopRecord` method executes synchronously, stopping the
+recording of an audio file.
Supported Platforms
-------------------
@@ -137,4 +138,4 @@ Full Example
Tizen Quirks
----------
-- This API is not supported on Tizen devices.
+- Not supported on Tizen devices.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/notification/notification.confirm.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.confirm.md b/docs/en/edge/cordova/notification/notification.confirm.md
index 086b943..b7c8c16 100755
--- a/docs/en/edge/cordova/notification/notification.confirm.md
+++ b/docs/en/edge/cordova/notification/notification.confirm.md
@@ -37,7 +37,8 @@ Function `notification.confirm` displays a native dialog box that is more custom
confirmCallback
---------------
-The `confirmCallback` is called when the user has pressed one of the buttons on the confirmation dialog box.
+The `confirmCallback` executes when the user presses one of the
+buttons on the confirmation dialog box.
The callback takes the argument `buttonIndex` _(Number)_, which is the index of the pressed button. It's important to note that the index uses one-based indexing, so the value will be `1`, `2`, `3`, etc.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/notification/notification.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.md b/docs/en/edge/cordova/notification/notification.md
index 68f838d..e18b13b 100644
--- a/docs/en/edge/cordova/notification/notification.md
+++ b/docs/en/edge/cordova/notification/notification.md
@@ -25,11 +25,11 @@ Notification
Methods
-------
-- notification.alert
-- notification.confirm
-- notification.prompt
-- notification.beep
-- notification.vibrate
+- `notification.alert`
+- `notification.confirm`
+- `notification.prompt`
+- `notification.beep`
+- `notification.vibrate`
Permissions
-----------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/notification/notification.prompt.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.prompt.md b/docs/en/edge/cordova/notification/notification.prompt.md
index ce947d2..631c80d 100644
--- a/docs/en/edge/cordova/notification/notification.prompt.md
+++ b/docs/en/edge/cordova/notification/notification.prompt.md
@@ -37,7 +37,7 @@ Function `notification.prompt` displays a native dialog box that is more customi
promptCallback
---------------
-The `promptCallback` is called when the user has pressed one of the buttons on the prompt dialog box.
+The `promptCallback` executes when the user has pressed one of the buttons on the prompt dialog box.
The callback takes the argument `results` which contains the following properties:
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md b/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md
index 13d0402..6f1d86c 100644
--- a/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md
+++ b/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md
@@ -20,7 +20,8 @@ license: Licensed to the Apache Software Foundation (ASF) under one
SQLResultSet
=======
-When the executeSql method of a SQLTransaction is called it will invoke it's callback with a SQLResultSet.
+When the `executeSql` method of a `SQLTransaction` is called it
+invokes its callback with a `SQLResultSet`.
Properties
-------
@@ -32,7 +33,7 @@ Properties
Details
-------
-When you call the SQLTransaction executeSql method its callback methods is called with a SQLResultSet object. The result object has three properties. The first is the `insertId` which will return the row number of a success SQL insert statement. If the SQL statement is not an insert then the `insertId` is not set. The `rowsAffected` is always 0 for a SQL select statement. For insert or update statements it returns the number of rows that have been modified. The final property is of type SQLResultSetList and it contains the data returned from a SQL select statement.
+When you call the SQLTransaction executeSql method its callback methods is passed a SQLResultSet object. The result object has three properties. The first is the `insertId` which will return the row number of a success SQL insert statement. If the SQL statement is not an insert then the `insertId` is not set. The `rowsAffected` is always 0 for a SQL select statement. For insert or update statements it returns the number of rows that have been modified. The final property is of type SQLResultSetList and it contains the data returned from a SQL select statement.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md b/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md
index 107668e..ea61b30 100644
--- a/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md
+++ b/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md
@@ -30,7 +30,7 @@ Methods
Details
-------
-When you call a Database objects transaction method, its callback methods is called with a SQLTransaction object. The user can build up a database transaction by calling the executeSql method multiple times.
+When you call a Database objects transaction method, its callback method is passed a SQLTransaction object. The user can build up a database transaction by calling the executeSql method multiple times.
Supported Platforms
-------------------