You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by db...@apache.org on 2015/09/11 06:40:53 UTC
[09/51] [partial] docs commit: Reverting autolinking change because
of inconsistencies.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.0/cordova/geolocation/parameters/geolocation.options.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/geolocation/parameters/geolocation.options.md b/www/docs/en/1.8.0/cordova/geolocation/parameters/geolocation.options.md
index 6a5b3da..ff1b80d 100644
--- a/www/docs/en/1.8.0/cordova/geolocation/parameters/geolocation.options.md
+++ b/www/docs/en/1.8.0/cordova/geolocation/parameters/geolocation.options.md
@@ -22,15 +22,15 @@ geolocationOptions
==================
Optional parameters to customize the retrieval of the geolocation
-`<a href="../Position/position.html">Position</a>`.
+`Position`.
{ maximumAge: 3000, timeout: 5000, enableHighAccuracy: true };
Options
-------
-- __enableHighAccuracy:__ Provides a hint that the application would like to receive the best possible results. By default, the device will attempt to retrieve a `<a href="../Position/position.html">Position</a>` 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.getCurrent<a href="../Position/position.html">Position</a>` or `geolocation.watch<a href="../Position/position.html">Position</a>` until the corresponding `<a href="geolocationSuccess.html">geolocationSuccess</a>` callback is invoked. If the `<a href="geolocationSuccess.html">geolocationSuccess</a>` callback is not invoked within this time, the `<a href="geolocationError.html">geolocationError</a>` callback will be invoked with a `<a href="../<a href="../Position/position.html">Position</a>Error/positionError.html"><a href="../Position/position.html">Position</a>Error</a>.TIMEOUT` error code. NOTE: when used in conjunction with `geolocation.watch<a href="../Position/position.html">Position</a>`, the `<a href="geolocationError.html">geolocationError</a>` callback could be called on an interval every `timeout` milliseconds! _(Number)_
+- __enableHighAccuracy:__ Provides a hint that the application would like to receive the best possible results. By default, the device will attempt 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 will be invoked with a `PositionError.TIMEOUT` error code. NOTE: 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/af6a5545/www/docs/en/1.8.0/cordova/geolocation/parameters/geolocationError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/geolocation/parameters/geolocationError.md b/www/docs/en/1.8.0/cordova/geolocation/parameters/geolocationError.md
index afe00ea..3408969 100644
--- a/www/docs/en/1.8.0/cordova/geolocation/parameters/geolocationError.md
+++ b/www/docs/en/1.8.0/cordova/geolocation/parameters/geolocationError.md
@@ -30,4 +30,4 @@ The user's callback function that is called when there is an error for geolocati
Parameters
----------
-- __error:__ The error returned by the device. (`<a href="../<a href="../Position/position.html">Position</a>Error/positionError.html"><a href="../Position/position.html">Position</a>Error</a>`)
+- __error:__ The error returned by the device. (`PositionError`)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.0/cordova/geolocation/parameters/geolocationSuccess.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/geolocation/parameters/geolocationSuccess.md b/www/docs/en/1.8.0/cordova/geolocation/parameters/geolocationSuccess.md
index cac8481..bffd951 100644
--- a/www/docs/en/1.8.0/cordova/geolocation/parameters/geolocationSuccess.md
+++ b/www/docs/en/1.8.0/cordova/geolocation/parameters/geolocationSuccess.md
@@ -21,7 +21,7 @@ license: >
geolocationSuccess
==================
-The user's callback function that is called when a geolocation position becomes available (when using with `geolocation.getCurrent<a href="../Position/position.html">Position</a>`), or when the position changes (when using with `geolocation.watch<a href="../Position/position.html">Position</a>`).
+The user's callback function that is called when a geolocation position becomes available (when using with `geolocation.getCurrentPosition`), or when the position changes (when using with `geolocation.watchPosition`).
function(position) {
// Do something
@@ -30,9 +30,9 @@ The user's callback function that is called when a geolocation position becomes
Parameters
----------
-- __position:__ The geolocation position returned by the device. (`<a href="../Position/position.html">Position</a>`)
+- __position:__ The geolocation position returned by the device. (`Position`)
-<a href="../../storage/storage.opendatabase.html">Example</a>
+Example
-------
function geolocationSuccess(position) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.0/cordova/media/MediaError/mediaError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/MediaError/mediaError.md b/www/docs/en/1.8.0/cordova/media/MediaError/mediaError.md
index 8d8a960..ad11ca5 100644
--- a/www/docs/en/1.8.0/cordova/media/MediaError/mediaError.md
+++ b/www/docs/en/1.8.0/cordova/media/MediaError/mediaError.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-<a href="../media.html">Media</a>Error
+MediaError
==========
-A `<a href="../media.html">Media</a>Error` object is returned to the `<a href="../Parameters/mediaError.html">mediaError</a>` callback function when an error occurs.
+A `MediaError` object is returned to the `mediaError` callback function when an error occurs.
Properties
----------
@@ -32,14 +32,14 @@ Properties
Constants
---------
-- `<a href="../media.html">Media</a>Error.MEDIA_ERR_ABORTED`
-- `<a href="../media.html">Media</a>Error.MEDIA_ERR_NETWORK`
-- `<a href="../media.html">Media</a>Error.MEDIA_ERR_DECODE`
-- `<a href="../media.html">Media</a>Error.MEDIA_ERR_NONE_SUPPORTED`
+- `MediaError.MEDIA_ERR_ABORTED`
+- `MediaError.MEDIA_ERR_NETWORK`
+- `MediaError.MEDIA_ERR_DECODE`
+- `MediaError.MEDIA_ERR_NONE_SUPPORTED`
Description
-----------
-The `<a href="../media.html">Media</a>Error` object is returned to the user through the `<a href="../Parameters/mediaError.html">mediaError</a>` callback function when an error occurs.
+The `MediaError` object is returned to the user through the `mediaError` callback function when an error occurs.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.0/cordova/media/Parameters/mediaError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/Parameters/mediaError.md b/www/docs/en/1.8.0/cordova/media/Parameters/mediaError.md
index 1881d31..1e0e3a8 100644
--- a/www/docs/en/1.8.0/cordova/media/Parameters/mediaError.md
+++ b/www/docs/en/1.8.0/cordova/media/Parameters/mediaError.md
@@ -30,4 +30,4 @@ A user specified callback function that is invoked when there is an error in med
Parameters
----------
-- __error:__ The error returned by the device. (`<a href="../<a href="../media.html">Media</a>Error/mediaError.html"><a href="../media.html">Media</a>Error</a>`)
+- __error:__ The error returned by the device. (`MediaError`)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.0/cordova/media/capture/CaptureCB.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/capture/CaptureCB.md b/www/docs/en/1.8.0/cordova/media/capture/CaptureCB.md
index 81cad0a..a897c8b 100644
--- a/www/docs/en/1.8.0/cordova/media/capture/CaptureCB.md
+++ b/www/docs/en/1.8.0/cordova/media/capture/CaptureCB.md
@@ -18,28 +18,28 @@ license: >
under the License.
---
-<a href="capture.html">Capture</a>CB
+CaptureCB
=========
> Invoked upon a successful media capture operation.
- function captureSuccess( <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>[] media<a href="../../file/fileobj/fileobj.html">File</a>s ) { ... };
+ function captureSuccess( MediaFile[] mediaFiles ) { ... };
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.
-Each <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a> object describes a captured media file.
+Each MediaFile object describes a captured media file.
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// capture callback
- function captureSuccess(media<a href="../../file/fileobj/fileobj.html">File</a>s) {
+ function captureSuccess(mediaFiles) {
var i, path, len;
- for (i = 0, len = media<a href="../../file/fileobj/fileobj.html">File</a>s.length; i < len; i += 1) {
- path = media<a href="../../file/fileobj/fileobj.html">File</a>s[i].fullPath;
+ for (i = 0, len = mediaFiles.length; i < len; i += 1) {
+ path = mediaFiles[i].fullPath;
// do something interesting with the file
}
};
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.0/cordova/media/capture/CaptureError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/capture/CaptureError.md b/www/docs/en/1.8.0/cordova/media/capture/CaptureError.md
index a4f135c..f387287 100644
--- a/www/docs/en/1.8.0/cordova/media/capture/CaptureError.md
+++ b/www/docs/en/1.8.0/cordova/media/capture/CaptureError.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-<a href="capture.html">Capture</a>Error
+CaptureError
============
> Encapsulates the error code resulting from a failed media capture operation.
@@ -31,8 +31,8 @@ Properties
Constants
---------
-- <a href="capture.html">Capture</a>Error.`CAPTURE_INTERNAL_ERR`: <a href="../../camera/camera.html">Camera</a> or microphone failed to capture image or sound.
-- <a href="capture.html">Capture</a>Error.`CAPTURE_APPLICATION_BUSY`: <a href="../../camera/camera.html">Camera</a> application or audio capture application is currently serving other capture request.
-- <a href="capture.html">Capture</a>Error.`CAPTURE_INVALID_ARGUMENT`: Invalid use of the API (e.g. limit parameter has value less than one).
-- <a href="capture.html">Capture</a>Error.`CAPTURE_NO_MEDIA_FILES`: User exited camera application or audio capture application before capturing anything.
-- <a href="capture.html">Capture</a>Error.`CAPTURE_NOT_SUPPORTED`: The requested capture operation is not supported.
+- 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.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.0/cordova/media/capture/CaptureErrorCB.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/capture/CaptureErrorCB.md b/www/docs/en/1.8.0/cordova/media/capture/CaptureErrorCB.md
index 02e9f62..7d24861 100644
--- a/www/docs/en/1.8.0/cordova/media/capture/CaptureErrorCB.md
+++ b/www/docs/en/1.8.0/cordova/media/capture/CaptureErrorCB.md
@@ -18,24 +18,24 @@ license: >
under the License.
---
-<a href="capture.html">Capture</a>ErrorCB
+CaptureErrorCB
==============
> Invoked if an error occurs during a media capture operation.
- function captureError( <a href="capture.html">Capture</a>Error error ) { ... };
+ function captureError( CaptureError error ) { ... };
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 is invoked with a <a href="capture.html">Capture</a>Error object containing an appropriate error code.
+This function is invoked with a CaptureError object containing an appropriate error code.
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// capture error callback
var captureError = function(error) {
- navigator.<a href="../../notification/notification.alert.html">notification.alert</a>('Error code: ' + error.code, null, '<a href="capture.html">Capture</a> Error');
+ navigator.notification.alert('Error code: ' + error.code, null, 'Capture Error');
};
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.0/cordova/media/capture/ConfigurationData.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/capture/ConfigurationData.md b/www/docs/en/1.8.0/cordova/media/capture/ConfigurationData.md
index 797d9da..2b32dfe 100644
--- a/www/docs/en/1.8.0/cordova/media/capture/ConfigurationData.md
+++ b/www/docs/en/1.8.0/cordova/media/capture/ConfigurationData.md
@@ -28,7 +28,7 @@ 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).
-The MIME types should adhere to [RFC2046](http://www.ietf.org/rfc/rfc2046.txt). <a href="../../storage/storage.opendatabase.html">Example</a>s:
+The MIME types should adhere to [RFC2046](http://www.ietf.org/rfc/rfc2046.txt). Examples:
- video/3gpp
- video/quicktime
@@ -43,7 +43,7 @@ Properties
- __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)
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// retrieve supported image modes
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.0/cordova/media/capture/MediaFile.getFormatData.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/capture/MediaFile.getFormatData.md b/www/docs/en/1.8.0/cordova/media/capture/MediaFile.getFormatData.md
index afb3f3e..83b2fe8 100644
--- a/www/docs/en/1.8.0/cordova/media/capture/MediaFile.getFormatData.md
+++ b/www/docs/en/1.8.0/cordova/media/capture/MediaFile.getFormatData.md
@@ -18,20 +18,20 @@ license: >
under the License.
---
-<a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>.getFormatData
+MediaFile.getFormatData
=======================
> Retrieves format information about the media capture file.
- media<a href="../../file/fileobj/fileobj.html">File</a>.getFormatData(
- <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>DataSuccessCB successCallback,
- [<a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>DataErrorCB errorCallback]
+ mediaFile.getFormatData(
+ MediaFileDataSuccessCB successCallback,
+ [MediaFileDataErrorCB errorCallback]
);
Description
-----------
-This function asynchronously attempts to retrieve the format information for the media file. If successful, it invokes the <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>DataSuccessCB callback with a <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>Data object. If the attempt fails, this function will invoke the <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>DataErrorCB 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 will invoke the MediaFileDataErrorCB callback.
Supported Platforms
-------------------
@@ -43,12 +43,12 @@ Supported Platforms
BlackBerry WebWorks Quirks
--------------------------
-There is no API that provides format information of media files. Therefore, all <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>Data objects will be returned with default values. See <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>Data documentation.
+There is no API that provides format information of media files. Therefore, all MediaFileData objects will be returned with default values. See MediaFileData documentation.
Android Quirks
--------------
-The API for retrieving media file format information is limited. Therefore, not all <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>Data properties are supported. See <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>Data documentation.
+The API for retrieving media file format information is limited. Therefore, not all MediaFileData properties are supported. See MediaFileData documentation.
iOS Quirks
----------
-The API for retrieving media file format information is limited. Therefore, not all <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>Data properties are supported. See <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>Data documentation.
\ No newline at end of file
+The API for retrieving media file format information is limited. Therefore, not all MediaFileData properties are supported. See MediaFileData documentation.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.0/cordova/media/capture/MediaFile.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/capture/MediaFile.md b/www/docs/en/1.8.0/cordova/media/capture/MediaFile.md
index 0a10254..869b0ef 100644
--- a/www/docs/en/1.8.0/cordova/media/capture/MediaFile.md
+++ b/www/docs/en/1.8.0/cordova/media/capture/MediaFile.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>
+MediaFile
=========
> Encapsulates properties of a media capture file.
@@ -35,4 +35,4 @@ Properties
Methods
-------
-- __<a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.getFormatData.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.getFormatData</a>:__ Retrieves the format information of the media file.
\ No newline at end of file
+- __MediaFile.getFormatData:__ Retrieves the format information of the media file.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.0/cordova/media/capture/MediaFileData.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/capture/MediaFileData.md b/www/docs/en/1.8.0/cordova/media/capture/MediaFileData.md
index ebac2e3..cc7de58 100644
--- a/www/docs/en/1.8.0/cordova/media/capture/MediaFileData.md
+++ b/www/docs/en/1.8.0/cordova/media/capture/MediaFileData.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-<a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>Data
+MediaFileData
=============
> Encapsulates format information about a media file.
@@ -34,7 +34,7 @@ Properties
BlackBerry WebWorks Quirks
--------------------------
-There is no API that provides format information of media files. So the <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>Data object returned by the <a href="<a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>.getFormatData.html"><a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>.getFormatData</a> function will have the following default values:
+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.
@@ -44,7 +44,7 @@ There is no API that provides format information of media files. So the <a href
Android Quirks
--------------
-Support for the <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>Data properties is as follows:
+Support for the MediaFileData properties is as follows:
- __codecs:__ Not supported. The attribute will always be null.
- __bitrate:__ Not supported. The attribute will always be 0.
@@ -54,7 +54,7 @@ Support for the <a href="<a href="../media.html">Media</a><a href="../../file/fi
iOS Quirks
----------
-Support for the <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>Data properties is as follows:
+Support for the MediaFileData properties is as follows:
- __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.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.0/cordova/media/capture/capture.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/capture/capture.md b/www/docs/en/1.8.0/cordova/media/capture/capture.md
index 4d53c33..044d06f 100644
--- a/www/docs/en/1.8.0/cordova/media/capture/capture.md
+++ b/www/docs/en/1.8.0/cordova/media/capture/capture.md
@@ -27,22 +27,22 @@ Objects
-------
- Capture
-- <a href="captureAudioOptions.html">CaptureAudioOptions</a>
-- <a href="captureImageOptions.html">CaptureImageOptions</a>
-- <a href="captureVideoOptions.html">CaptureVideoOptions</a>
-- <a href="CaptureCB.html">CaptureCB</a>
-- <a href="<a href="CaptureError.html">CaptureError</a>CB.html"><a href="CaptureError.html">CaptureError</a>CB</a>
-- <a href="ConfigurationData.html">ConfigurationData</a>
-- <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>
-- <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>Data
+- CaptureAudioOptions
+- CaptureImageOptions
+- CaptureVideoOptions
+- CaptureCB
+- CaptureErrorCB
+- ConfigurationData
+- MediaFile
+- MediaFileData
Methods
-------
-- <a href="captureAudio.html">capture.captureAudio</a>
-- <a href="captureImage.html">capture.captureImage</a>
-- <a href="captureVideo.html">capture.captureVideo</a>
-- <a href="<a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>.getFormatData.html"><a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>.getFormatData</a>
+- capture.captureAudio
+- capture.captureImage
+- capture.captureVideo
+- MediaFile.getFormatData
Scope
-----
@@ -55,16 +55,16 @@ The __capture__ object is assigned to the __navigator.device__ object, and there
Properties
----------
-- __supportedAudioModes:__ The audio recording formats supported by the device. (<a href="ConfigurationData.html">ConfigurationData</a>[])
-- __supportedImageModes:__ The recording image sizes and formats supported by the device. (<a href="ConfigurationData.html">ConfigurationData</a>[])
-- __supportedVideoModes:__ The recording video resolutions and formats supported by the device. (<a href="ConfigurationData.html">ConfigurationData</a>[])
+- __supportedAudioModes:__ The audio recording formats supported by the device. (ConfigurationData[])
+- __supportedImageModes:__ The recording image sizes and formats supported by the device. (ConfigurationData[])
+- __supportedVideoModes:__ The recording video resolutions and formats supported by the device. (ConfigurationData[])
Methods
-------
-- <a href="captureAudio.html">capture.captureAudio</a>: Launch the device audio recording application for recording audio clip(s).
-- <a href="captureImage.html">capture.captureImage</a>: Launch the device camera application for taking image(s).
-- <a href="captureVideo.html">capture.captureVideo</a>: Launch the device video recorder application for recording video(s).
+- 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).
Supported Platforms
@@ -101,7 +101,7 @@ Permissions
#### www/plugins.xml
- <plugin name="Capture" value="org.apache.cordova.capture.<a href="../media.html">Media</a>Capture" />
+ <plugin name="Capture" value="org.apache.cordova.capture.MediaCapture" />
#### www/config.xml
@@ -110,7 +110,7 @@ Permissions
### iOS
-#### App/Supporting <a href="../../file/fileobj/fileobj.html">File</a>s/Cordova.plist
+#### App/Supporting Files/Cordova.plist
<key>Plugins</key>
<dict>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.0/cordova/media/capture/captureAudio.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/capture/captureAudio.md b/www/docs/en/1.8.0/cordova/media/capture/captureAudio.md
index 6f879c7..39006bf 100644
--- a/www/docs/en/1.8.0/cordova/media/capture/captureAudio.md
+++ b/www/docs/en/1.8.0/cordova/media/capture/captureAudio.md
@@ -24,7 +24,7 @@ capture.captureAudio
> Start the audio recorder application and return information about captured audio clip file(s).
navigator.device.capture.captureAudio(
- <a href="<a href="capture.html">Capture</a>CB.html"><a href="capture.html">Capture</a>CB</a> captureSuccess, <a href="capture.html">Capture</a>ErrorCB captureError, [<a href="capture.html">Capture</a>AudioOptions options]
+ CaptureCB captureSuccess, CaptureErrorCB captureError, [CaptureAudioOptions options]
);
Description
@@ -32,9 +32,9 @@ 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.
-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 <a href="capture.html">Capture</a>AudioOptions, 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 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.
-When the capture operation is finished, it will invoke the <a href="<a href="capture.html">Capture</a>CB.html"><a href="capture.html">Capture</a>CB</a> callback with an array of <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a> objects describing each captured audio clip file. If the operation is terminated by the user before an audio clip is captured, the <a href="capture.html">Capture</a>ErrorCB callback will be invoked with a <a href="capture.html">Capture</a>Error object with the <a href="capture.html">Capture</a>Error.`CAPTURE_NO_MEDIA_FILES` error code.
+When the capture operation is finished, it will invoke the CaptureCB 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 CaptureErrorCB callback will be invoked with a CaptureError object with the CaptureError.`CAPTURE_NO_MEDIA_FILES` error code.
Supported Platforms
-------------------
@@ -44,33 +44,33 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// capture callback
- var captureSuccess = function(media<a href="../../file/fileobj/fileobj.html">File</a>s) {
+ var captureSuccess = function(mediaFiles) {
var i, path, len;
- for (i = 0, len = media<a href="../../file/fileobj/fileobj.html">File</a>s.length; i < len; i += 1) {
- path = media<a href="../../file/fileobj/fileobj.html">File</a>s[i].fullPath;
+ for (i = 0, len = mediaFiles.length; i < len; i += 1) {
+ path = mediaFiles[i].fullPath;
// do something interesting with the file
}
};
// capture error callback
var captureError = function(error) {
- navigator.<a href="../../notification/notification.alert.html">notification.alert</a>('Error code: ' + error.code, null, '<a href="capture.html">Capture</a> Error');
+ navigator.notification.alert('Error code: ' + error.code, null, 'Capture Error');
};
// start audio capture
navigator.device.capture.captureAudio(captureSuccess, captureError, {limit:2});
-Full <a href="../../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="capture.html">Capture</a> Audio</title>
+ <title>Capture Audio</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
<script type="text/javascript" charset="utf-8" src="json2.js"></script>
@@ -78,10 +78,10 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
// Called when capture operation is finished
//
- function captureSuccess(media<a href="../../file/fileobj/fileobj.html">File</a>s) {
+ function captureSuccess(mediaFiles) {
var i, len;
- for (i = 0, len = media<a href="../../file/fileobj/fileobj.html">File</a>s.length; i < len; i += 1) {
- upload<a href="../../file/fileobj/fileobj.html">File</a>(media<a href="../../file/fileobj/fileobj.html">File</a>s[i]);
+ for (i = 0, len = mediaFiles.length; i < len; i += 1) {
+ uploadFile(mediaFiles[i]);
}
}
@@ -89,7 +89,7 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
//
function captureError(error) {
var msg = 'An error occurred during capture: ' + error.code;
- navigator.<a href="../../notification/notification.alert.html">notification.alert</a>(msg, null, 'Uh oh!');
+ navigator.notification.alert(msg, null, 'Uh oh!');
}
// A button will call this function
@@ -101,10 +101,10 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
}
// Upload files to server
- function upload<a href="../../file/fileobj/fileobj.html">File</a>(media<a href="../../file/fileobj/fileobj.html">File</a>) {
- var ft = new <a href="../../file/filetransfer/filetransfer.html"><a href="../../file/fileobj/fileobj.html">File</a>Transfer</a>(),
- path = media<a href="../../file/fileobj/fileobj.html">File</a>.fullPath,
- name = media<a href="../../file/fileobj/fileobj.html">File</a>.name;
+ function uploadFile(mediaFile) {
+ var ft = new FileTransfer(),
+ path = mediaFile.fullPath,
+ name = mediaFile.name;
ft.upload(path,
"http://my.domain.com/upload.php",
@@ -121,14 +121,14 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
</script>
</head>
<body>
- <button onclick="captureAudio();"><a href="capture.html">Capture</a> Audio</button> <br>
+ <button onclick="captureAudio();">Capture Audio</button> <br>
</body>
</html>
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 <a href="capture.html">Capture</a>Error.`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 the audio recordings. The developer will receive a CaptureError.`CAPTURE_NOT_SUPPORTED` error code if the application is not installed on the device.
iOS Quirks
----------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.0/cordova/media/capture/captureAudioOptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/capture/captureAudioOptions.md b/www/docs/en/1.8.0/cordova/media/capture/captureAudioOptions.md
index 08a05cd..ff303f5 100644
--- a/www/docs/en/1.8.0/cordova/media/capture/captureAudioOptions.md
+++ b/www/docs/en/1.8.0/cordova/media/capture/captureAudioOptions.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-<a href="capture.html">Capture</a>AudioOptions
+CaptureAudioOptions
===================
> Encapsulates audio capture configuration options.
@@ -30,13 +30,13 @@ Properties
- __duration:__ The maximum duration of an audio sound clip, in seconds.
- __mode:__ The selected audio mode. The value must match one of the elements in `capture.supportedAudioModes`.
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// limit capture operation to 3 media files, no longer than 10 seconds each
var options = { limit: 3, duration: 10 };
- navigator.device.<a href="captureAudio.html">capture.captureAudio</a>(captureSuccess, captureError, options);
+ navigator.device.capture.captureAudio(captureSuccess, captureError, options);
Android Quirks
--------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.0/cordova/media/capture/captureImage.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/capture/captureImage.md b/www/docs/en/1.8.0/cordova/media/capture/captureImage.md
index 88695b2..defbde1 100644
--- a/www/docs/en/1.8.0/cordova/media/capture/captureImage.md
+++ b/www/docs/en/1.8.0/cordova/media/capture/captureImage.md
@@ -24,7 +24,7 @@ capture.captureImage
> Start the camera application and return information about captured image file(s).
navigator.device.capture.captureImage(
- <a href="<a href="capture.html">Capture</a>CB.html"><a href="capture.html">Capture</a>CB</a> captureSuccess, <a href="capture.html">Capture</a>ErrorCB captureError, [<a href="capture.html">Capture</a>ImageOptions options]
+ CaptureCB captureSuccess, CaptureErrorCB captureError, [CaptureImageOptions options]
);
Description
@@ -32,9 +32,9 @@ 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.
-The capture operation ends when either the user exits the camera application, or the maximum number of images, specified by the __limit__ parameter in <a href="capture.html">Capture</a>ImageOptions, 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 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.
-When the capture operation is finished, it will invoke the <a href="<a href="capture.html">Capture</a>CB.html"><a href="capture.html">Capture</a>CB</a> callback with an array of <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a> objects describing each captured image file. If the operation is terminated by the user before an image is captured, the <a href="capture.html">Capture</a>ErrorCB callback will be invoked with a <a href="capture.html">Capture</a>Error object with the <a href="capture.html">Capture</a>Error.`CAPTURE_NO_MEDIA_FILES` error code.
+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.
Supported Platforms
-------------------
@@ -50,33 +50,33 @@ 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.
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// capture callback
- var captureSuccess = function(media<a href="../../file/fileobj/fileobj.html">File</a>s) {
+ var captureSuccess = function(mediaFiles) {
var i, path, len;
- for (i = 0, len = media<a href="../../file/fileobj/fileobj.html">File</a>s.length; i < len; i += 1) {
- path = media<a href="../../file/fileobj/fileobj.html">File</a>s[i].fullPath;
+ for (i = 0, len = mediaFiles.length; i < len; i += 1) {
+ path = mediaFiles[i].fullPath;
// do something interesting with the file
}
};
// capture error callback
var captureError = function(error) {
- navigator.<a href="../../notification/notification.alert.html">notification.alert</a>('Error code: ' + error.code, null, '<a href="capture.html">Capture</a> Error');
+ navigator.notification.alert('Error code: ' + error.code, null, 'Capture Error');
};
// start image capture
navigator.device.capture.captureImage(captureSuccess, captureError, {limit:2});
-Full <a href="../../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="capture.html">Capture</a> Image</title>
+ <title>Capture Image</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
<script type="text/javascript" charset="utf-8" src="json2.js"></script>
@@ -84,10 +84,10 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
// Called when capture operation is finished
//
- function captureSuccess(media<a href="../../file/fileobj/fileobj.html">File</a>s) {
+ function captureSuccess(mediaFiles) {
var i, len;
- for (i = 0, len = media<a href="../../file/fileobj/fileobj.html">File</a>s.length; i < len; i += 1) {
- upload<a href="../../file/fileobj/fileobj.html">File</a>(media<a href="../../file/fileobj/fileobj.html">File</a>s[i]);
+ for (i = 0, len = mediaFiles.length; i < len; i += 1) {
+ uploadFile(mediaFiles[i]);
}
}
@@ -95,7 +95,7 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
//
function captureError(error) {
var msg = 'An error occurred during capture: ' + error.code;
- navigator.<a href="../../notification/notification.alert.html">notification.alert</a>(msg, null, 'Uh oh!');
+ navigator.notification.alert(msg, null, 'Uh oh!');
}
// A button will call this function
@@ -107,10 +107,10 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
}
// Upload files to server
- function upload<a href="../../file/fileobj/fileobj.html">File</a>(media<a href="../../file/fileobj/fileobj.html">File</a>) {
- var ft = new <a href="../../file/filetransfer/filetransfer.html"><a href="../../file/fileobj/fileobj.html">File</a>Transfer</a>(),
- path = media<a href="../../file/fileobj/fileobj.html">File</a>.fullPath,
- name = media<a href="../../file/fileobj/fileobj.html">File</a>.name;
+ function uploadFile(mediaFile) {
+ var ft = new FileTransfer(),
+ path = mediaFile.fullPath,
+ name = mediaFile.name;
ft.upload(path,
"http://my.domain.com/upload.php",
@@ -127,7 +127,7 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
</script>
</head>
<body>
- <button onclick="captureImage();"><a href="capture.html">Capture</a> Image</button> <br>
+ <button onclick="captureImage();">Capture Image</button> <br>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.0/cordova/media/capture/captureImageOptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/capture/captureImageOptions.md b/www/docs/en/1.8.0/cordova/media/capture/captureImageOptions.md
index a0891fe..b9f0333 100644
--- a/www/docs/en/1.8.0/cordova/media/capture/captureImageOptions.md
+++ b/www/docs/en/1.8.0/cordova/media/capture/captureImageOptions.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-<a href="capture.html">Capture</a>ImageOptions
+CaptureImageOptions
===================
> Encapsulates image capture configuration options.
@@ -29,13 +29,13 @@ 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).
- __mode:__ The selected image mode. The value must match one of the elements in `capture.supportedImageModes`.
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// limit capture operation to 3 images
var options = { limit: 3 };
- navigator.device.<a href="captureImage.html">capture.captureImage</a>(captureSuccess, captureError, options);
+ navigator.device.capture.captureImage(captureSuccess, captureError, options);
Android Quirks
--------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.0/cordova/media/capture/captureVideo.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/capture/captureVideo.md b/www/docs/en/1.8.0/cordova/media/capture/captureVideo.md
index bbbd18d..1e509fd 100644
--- a/www/docs/en/1.8.0/cordova/media/capture/captureVideo.md
+++ b/www/docs/en/1.8.0/cordova/media/capture/captureVideo.md
@@ -24,7 +24,7 @@ capture.captureVideo
> Start the video recorder application and return information about captured video clip file(s).
navigator.device.capture.captureVideo(
- <a href="<a href="capture.html">Capture</a>CB.html"><a href="capture.html">Capture</a>CB</a> captureSuccess, <a href="capture.html">Capture</a>ErrorCB captureError, [<a href="capture.html">Capture</a>VideoOptions options]
+ CaptureCB captureSuccess, CaptureErrorCB captureError, [CaptureVideoOptions options]
);
Description
@@ -32,9 +32,9 @@ 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.
-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 <a href="capture.html">Capture</a>VideoOptions, 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 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.
-When the capture operation is finished, it will invoke the <a href="<a href="capture.html">Capture</a>CB.html"><a href="capture.html">Capture</a>CB</a> callback with an array of <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a> objects describing each captured video clip file. If the operation is terminated by the user before an video clip is captured, the <a href="capture.html">Capture</a>ErrorCB callback will be invoked with a <a href="capture.html">Capture</a>Error object with the <a href="capture.html">Capture</a>Error.`CAPTURE_NO_MEDIA_FILES` error code.
+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.
Supported Platforms
-------------------
@@ -44,33 +44,33 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// capture callback
- var captureSuccess = function(media<a href="../../file/fileobj/fileobj.html">File</a>s) {
+ var captureSuccess = function(mediaFiles) {
var i, path, len;
- for (i = 0, len = media<a href="../../file/fileobj/fileobj.html">File</a>s.length; i < len; i += 1) {
- path = media<a href="../../file/fileobj/fileobj.html">File</a>s[i].fullPath;
+ for (i = 0, len = mediaFiles.length; i < len; i += 1) {
+ path = mediaFiles[i].fullPath;
// do something interesting with the file
}
};
// capture error callback
var captureError = function(error) {
- navigator.<a href="../../notification/notification.alert.html">notification.alert</a>('Error code: ' + error.code, null, '<a href="capture.html">Capture</a> Error');
+ navigator.notification.alert('Error code: ' + error.code, null, 'Capture Error');
};
// start video capture
navigator.device.capture.captureVideo(captureSuccess, captureError, {limit:2});
-Full <a href="../../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="capture.html">Capture</a> Video</title>
+ <title>Capture Video</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
<script type="text/javascript" charset="utf-8" src="json2.js"></script>
@@ -78,10 +78,10 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
// Called when capture operation is finished
//
- function captureSuccess(media<a href="../../file/fileobj/fileobj.html">File</a>s) {
+ function captureSuccess(mediaFiles) {
var i, len;
- for (i = 0, len = media<a href="../../file/fileobj/fileobj.html">File</a>s.length; i < len; i += 1) {
- upload<a href="../../file/fileobj/fileobj.html">File</a>(media<a href="../../file/fileobj/fileobj.html">File</a>s[i]);
+ for (i = 0, len = mediaFiles.length; i < len; i += 1) {
+ uploadFile(mediaFiles[i]);
}
}
@@ -89,7 +89,7 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
//
function captureError(error) {
var msg = 'An error occurred during capture: ' + error.code;
- navigator.<a href="../../notification/notification.alert.html">notification.alert</a>(msg, null, 'Uh oh!');
+ navigator.notification.alert(msg, null, 'Uh oh!');
}
// A button will call this function
@@ -101,10 +101,10 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
}
// Upload files to server
- function upload<a href="../../file/fileobj/fileobj.html">File</a>(media<a href="../../file/fileobj/fileobj.html">File</a>) {
- var ft = new <a href="../../file/filetransfer/filetransfer.html"><a href="../../file/fileobj/fileobj.html">File</a>Transfer</a>(),
- path = media<a href="../../file/fileobj/fileobj.html">File</a>.fullPath,
- name = media<a href="../../file/fileobj/fileobj.html">File</a>.name;
+ function uploadFile(mediaFile) {
+ var ft = new FileTransfer(),
+ path = mediaFile.fullPath,
+ name = mediaFile.name;
ft.upload(path,
"http://my.domain.com/upload.php",
@@ -121,11 +121,11 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
</script>
</head>
<body>
- <button onclick="captureVideo();"><a href="capture.html">Capture</a> Video</button> <br>
+ <button onclick="captureVideo();">Capture Video</button> <br>
</body>
</html>
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 <a href="capture.html">Capture</a>Error.`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 the video recordings. The developer will receive a CaptureError.`CAPTURE_NOT_SUPPORTED` error code if the application is not installed on the device.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.0/cordova/media/capture/captureVideoOptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/capture/captureVideoOptions.md b/www/docs/en/1.8.0/cordova/media/capture/captureVideoOptions.md
index 7b31d89..29667ad 100644
--- a/www/docs/en/1.8.0/cordova/media/capture/captureVideoOptions.md
+++ b/www/docs/en/1.8.0/cordova/media/capture/captureVideoOptions.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-<a href="capture.html">Capture</a>VideoOptions
+CaptureVideoOptions
===================
> Encapsulates video capture configuration options.
@@ -30,13 +30,13 @@ Properties
- __duration:__ The maximum duration of a video clip, in seconds.
- __mode:__ The selected video capture mode. The value must match one of the elements in `capture.supportedVideoModes`.
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// limit capture operation to 3 video clips
var options = { limit: 3 };
- navigator.device.<a href="captureVideo.html">capture.captureVideo</a>(captureSuccess, captureError, options);
+ navigator.device.capture.captureVideo(captureSuccess, captureError, options);
Android Quirks
--------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.0/cordova/media/media.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/media.getCurrentPosition.md b/www/docs/en/1.8.0/cordova/media/media.getCurrentPosition.md
index 7ee9dd0..c48a663 100644
--- a/www/docs/en/1.8.0/cordova/media/media.getCurrentPosition.md
+++ b/www/docs/en/1.8.0/cordova/media/media.getCurrentPosition.md
@@ -18,23 +18,23 @@ license: >
under the License.
---
-media.getCurrent<a href="../geolocation/Position/position.html">Position</a>
+media.getCurrentPosition
========================
Returns the current position within an audio file.
- media.getCurrent<a href="../geolocation/Position/position.html">Position</a>(mediaSuccess, [<a href="Parameters/mediaError.html">mediaError</a>]);
+ media.getCurrentPosition(mediaSuccess, [mediaError]);
Parameters
----------
- __mediaSuccess__: The callback that is called with the current position in seconds.
-- __<a href="Parameters/mediaError.html">mediaError</a>__: (Optional) The callback that is called if there was an error.
+- __mediaError__: (Optional) The callback that is called if there was an error.
Description
-----------
-Function `media.getCurrent<a href="../geolocation/Position/position.html">Position</a>` is an asynchronous function that returns the current position of the underlying audio file of a <a href="media.html">Media</a> object. Also updates the ___position__ parameter within the <a href="media.html">Media</a> object.
+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.
Supported Platforms
-------------------
@@ -44,17 +44,17 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// Audio player
//
- var my_media = new <a href="media.html">Media</a>(src, onSuccess, onError);
+ var my_media = new Media(src, onSuccess, onError);
// Update media position every second
var mediaTimer = setInterval(function() {
// get media position
- my_media.getCurrent<a href="../geolocation/Position/position.html">Position</a>(
+ my_media.getCurrentPosition(
// success callback
function(position) {
if (position > -1) {
@@ -69,25 +69,25 @@ Quick <a href="../storage/storage.opendatabase.html">Example</a>
}, 1000);
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
- <title><a href="media.html">Media</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>Media Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
playAudio("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3");
}
@@ -99,27 +99,27 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// Play audio
//
function playAudio(src) {
- // Create <a href="media.html">Media</a> object from src
- my_media = new <a href="media.html">Media</a>(src, onSuccess, onError);
+ // Create Media object from src
+ my_media = new Media(src, onSuccess, onError);
// Play audio
- my_<a href="media.play.html">media.play</a>();
+ my_media.play();
// Update my_media position every second
if (mediaTimer == null) {
mediaTimer = setInterval(function() {
// get my_media position
- my_media.getCurrent<a href="../geolocation/Position/position.html">Position</a>(
+ my_media.getCurrentPosition(
// success callback
function(position) {
if (position > -1) {
- setAudio<a href="../geolocation/Position/position.html">Position</a>((position) + " sec");
+ setAudioPosition((position) + " sec");
}
},
// error callback
function(e) {
console.log("Error getting pos=" + e);
- setAudio<a href="../geolocation/Position/position.html">Position</a>("Error: " + e);
+ setAudioPosition("Error: " + e);
}
);
}, 1000);
@@ -128,9 +128,9 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// Pause audio
//
- function <a href="../events/events.pause.html">pause</a>Audio() {
+ function pauseAudio() {
if (my_media) {
- my_media.<a href="../events/events.pause.html">pause</a>();
+ my_media.pause();
}
}
@@ -138,7 +138,7 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
//
function stopAudio() {
if (my_media) {
- my_<a href="media.stop.html">media.stop</a>();
+ my_media.stop();
}
clearInterval(mediaTimer);
mediaTimer = null;
@@ -159,7 +159,7 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// Set audio position
//
- function setAudio<a href="../geolocation/Position/position.html">Position</a>(position) {
+ function setAudioPosition(position) {
document.getElementById('audio_position').innerHTML = position;
}
@@ -167,7 +167,7 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
</head>
<body>
<a href="#" class="btn large" onclick="playAudio('http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3');">Play Audio</a>
- <a href="#" class="btn large" onclick="<a href="../events/events.pause.html">pause</a>Audio();">Pause Playing Audio</a>
+ <a href="#" class="btn large" onclick="pauseAudio();">Pause Playing Audio</a>
<a href="#" class="btn large" onclick="stopAudio();">Stop Playing Audio</a>
<p id="audio_position"></p>
</body>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.0/cordova/media/media.getDuration.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/media.getDuration.md b/www/docs/en/1.8.0/cordova/media/media.getDuration.md
index c3ae956..1b7eba1 100644
--- a/www/docs/en/1.8.0/cordova/media/media.getDuration.md
+++ b/www/docs/en/1.8.0/cordova/media/media.getDuration.md
@@ -39,12 +39,12 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// Audio player
//
- var my_media = new <a href="media.html">Media</a>(src, onSuccess, onError);
+ var my_media = new Media(src, onSuccess, onError);
// Get duration
var counter = 0;
@@ -61,25 +61,25 @@ Quick <a href="../storage/storage.opendatabase.html">Example</a>
}, 100);
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
- <title><a href="media.html">Media</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>Media Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
playAudio("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3");
}
@@ -91,27 +91,27 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// Play audio
//
function playAudio(src) {
- // Create <a href="media.html">Media</a> object from src
- my_media = new <a href="media.html">Media</a>(src, onSuccess, onError);
+ // Create Media object from src
+ my_media = new Media(src, onSuccess, onError);
// Play audio
- my_<a href="media.play.html">media.play</a>();
+ my_media.play();
// Update my_media position every second
if (mediaTimer == null) {
mediaTimer = setInterval(function() {
// get my_media position
- my_media.getCurrent<a href="../geolocation/Position/position.html">Position</a>(
+ my_media.getCurrentPosition(
// success callback
function(position) {
if (position > -1) {
- setAudio<a href="../geolocation/Position/position.html">Position</a>((position) + " sec");
+ setAudioPosition((position) + " sec");
}
},
// error callback
function(e) {
console.log("Error getting pos=" + e);
- setAudio<a href="../geolocation/Position/position.html">Position</a>("Error: " + e);
+ setAudioPosition("Error: " + e);
}
);
}, 1000);
@@ -120,9 +120,9 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// Pause audio
//
- function <a href="../events/events.pause.html">pause</a>Audio() {
+ function pauseAudio() {
if (my_media) {
- my_media.<a href="../events/events.pause.html">pause</a>();
+ my_media.pause();
}
}
@@ -130,7 +130,7 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
//
function stopAudio() {
if (my_media) {
- my_<a href="media.stop.html">media.stop</a>();
+ my_media.stop();
}
clearInterval(mediaTimer);
mediaTimer = null;
@@ -151,7 +151,7 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// Set audio position
//
- function setAudio<a href="../geolocation/Position/position.html">Position</a>(position) {
+ function setAudioPosition(position) {
document.getElementById('audio_position').innerHTML = position;
}
@@ -159,7 +159,7 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
</head>
<body>
<a href="#" class="btn large" onclick="playAudio('http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3');">Play Audio</a>
- <a href="#" class="btn large" onclick="<a href="../events/events.pause.html">pause</a>Audio();">Pause Playing Audio</a>
+ <a href="#" class="btn large" onclick="pauseAudio();">Pause Playing Audio</a>
<a href="#" class="btn large" onclick="stopAudio();">Stop Playing Audio</a>
<p id="audio_position"></p>
</body>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.0/cordova/media/media.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/media.md b/www/docs/en/1.8.0/cordova/media/media.md
index 45ed8ba..76f0b71 100644
--- a/www/docs/en/1.8.0/cordova/media/media.md
+++ b/www/docs/en/1.8.0/cordova/media/media.md
@@ -23,7 +23,7 @@ Media
> The `Media` object provides the ability to record and play back audio files on a device.
- var media = new Media(src, mediaSuccess, [<a href="Parameters/mediaError.html">mediaError</a>], [mediaStatus]);
+ 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.
@@ -33,27 +33,27 @@ 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)_
-- __<a href="Parameters/mediaError.html">mediaError</a>__: (Optional) The callback that is invoked if there was an error. _(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)_
Methods
-------
-- media.getCurrent<a href="../geolocation/Position/position.html">Position</a>: Returns the current position within an audio file.
-- <a href="media.getDuration.html">media.getDuration</a>: Returns the duration of an audio file.
-- <a href="media.play.html">media.play</a>: Start or <a href="../events/events.resume.html">resume</a> playing audio file.
-- media.<a href="../events/events.pause.html">pause</a>: Pause playing audio file.
-- <a href="media.release.html">media.release</a>: Releases the underlying OS'es audio resources.
-- <a href="media.seekTo.html">media.seekTo</a>: Moves the position within the audio file.
-- <a href="media.startRecord.html">media.startRecord</a>: Start recording audio file.
-- <a href="media.stop.html">media.stop</a>Record: Stop recording audio file.
-- <a href="media.stop.html">media.stop</a>: 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 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.
Additional ReadOnly Parameters
---------------------
- __position__: The position within the audio playback in seconds.
- - Not automatically updated during play, call `getCurrent<a href="../geolocation/Position/position.html">Position</a>` to update.
+ - Not automatically updated during play, call `getCurrentPosition` to update.
- __duration__: The duration of the media in seconds.
Supported Platforms
@@ -91,11 +91,11 @@ Permissions
#### www/plugins.xml
- <plugin name="<a href="capture/capture.html">Capture</a>" value="org.apache.cordova.media.Media<a href="capture/capture.html">Capture</a>" />
+ <plugin name="Capture" value="org.apache.cordova.media.MediaCapture" />
### iOS
-#### App/Supporting <a href="../file/fileobj/fileobj.html">File</a>s/Cordova.plist
+#### App/Supporting Files/Cordova.plist
<key>Plugins</key>
<dict>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.0/cordova/media/media.pause.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/media.pause.md b/www/docs/en/1.8.0/cordova/media/media.pause.md
index f115bd8..717f2a5 100644
--- a/www/docs/en/1.8.0/cordova/media/media.pause.md
+++ b/www/docs/en/1.8.0/cordova/media/media.pause.md
@@ -18,18 +18,18 @@ license: >
under the License.
---
-media.<a href="../events/events.pause.html">pause</a>
+media.pause
===========
Pauses playing an audio file.
- media.<a href="../events/events.pause.html">pause</a>();
+ media.pause();
Description
-----------
-Function `media.<a href="../events/events.pause.html">pause</a>` is a synchronous function that <a href="../events/events.pause.html">pause</a>s playing an audio file.
+Function `media.pause` is a synchronous function that pauses playing an audio file.
Supported Platforms
-------------------
@@ -39,14 +39,14 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// Play audio
//
function playAudio(url) {
// Play the audio file at url
- var my_media = new <a href="media.html">Media</a>(url,
+ var my_media = new Media(url,
// success callback
function() {
console.log("playAudio():Audio Success");
@@ -57,34 +57,34 @@ Quick <a href="../storage/storage.opendatabase.html">Example</a>
});
// Play audio
- my_<a href="media.play.html">media.play</a>();
+ my_media.play();
// Pause after 10 seconds
setTimeout(function() {
- media.<a href="../events/events.pause.html">pause</a>();
+ media.pause();
}, 10000);
}
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
- <title><a href="media.html">Media</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>Media Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
playAudio("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3");
}
@@ -96,27 +96,27 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// Play audio
//
function playAudio(src) {
- // Create <a href="media.html">Media</a> object from src
- my_media = new <a href="media.html">Media</a>(src, onSuccess, onError);
+ // Create Media object from src
+ my_media = new Media(src, onSuccess, onError);
// Play audio
- my_<a href="media.play.html">media.play</a>();
+ my_media.play();
// Update my_media position every second
if (mediaTimer == null) {
mediaTimer = setInterval(function() {
// get my_media position
- my_media.getCurrent<a href="../geolocation/Position/position.html">Position</a>(
+ my_media.getCurrentPosition(
// success callback
function(position) {
if (position > -1) {
- setAudio<a href="../geolocation/Position/position.html">Position</a>((position) + " sec");
+ setAudioPosition((position) + " sec");
}
},
// error callback
function(e) {
console.log("Error getting pos=" + e);
- setAudio<a href="../geolocation/Position/position.html">Position</a>("Error: " + e);
+ setAudioPosition("Error: " + e);
}
);
}, 1000);
@@ -125,9 +125,9 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// Pause audio
//
- function <a href="../events/events.pause.html">pause</a>Audio() {
+ function pauseAudio() {
if (my_media) {
- my_media.<a href="../events/events.pause.html">pause</a>();
+ my_media.pause();
}
}
@@ -135,7 +135,7 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
//
function stopAudio() {
if (my_media) {
- my_<a href="media.stop.html">media.stop</a>();
+ my_media.stop();
}
clearInterval(mediaTimer);
mediaTimer = null;
@@ -156,7 +156,7 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// Set audio position
//
- function setAudio<a href="../geolocation/Position/position.html">Position</a>(position) {
+ function setAudioPosition(position) {
document.getElementById('audio_position').innerHTML = position;
}
@@ -164,7 +164,7 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
</head>
<body>
<a href="#" class="btn large" onclick="playAudio('http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3');">Play Audio</a>
- <a href="#" class="btn large" onclick="<a href="../events/events.pause.html">pause</a>Audio();">Pause Playing Audio</a>
+ <a href="#" class="btn large" onclick="pauseAudio();">Pause Playing Audio</a>
<a href="#" class="btn large" onclick="stopAudio();">Stop Playing Audio</a>
<p id="audio_position"></p>
</body>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.0/cordova/media/media.play.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/media.play.md b/www/docs/en/1.8.0/cordova/media/media.play.md
index 6aa1ee3..c4ab8ea 100644
--- a/www/docs/en/1.8.0/cordova/media/media.play.md
+++ b/www/docs/en/1.8.0/cordova/media/media.play.md
@@ -21,7 +21,7 @@ license: >
media.play
==========
-Starts or <a href="../events/events.resume.html">resume</a>s playing an audio file.
+Starts or resumes playing an audio file.
media.play();
@@ -29,7 +29,7 @@ Starts or <a href="../events/events.resume.html">resume</a>s playing an audio fi
Description
-----------
-Function `media.play` is a synchronous function that starts or <a href="../events/events.resume.html">resume</a>s playing an audio file.
+Function `media.play` is a synchronous function that starts or resumes playing an audio file.
Supported Platforms
-------------------
@@ -39,14 +39,14 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// Play audio
//
function playAudio(url) {
// Play the audio file at url
- var my_media = new <a href="media.html">Media</a>(url,
+ var my_media = new Media(url,
// success callback
function() {
console.log("playAudio():Audio Success");
@@ -61,25 +61,25 @@ Quick <a href="../storage/storage.opendatabase.html">Example</a>
}
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
- <title><a href="media.html">Media</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>Media Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
playAudio("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3");
}
@@ -92,8 +92,8 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
//
function playAudio(src) {
if (my_media == null) {
- // Create <a href="media.html">Media</a> object from src
- my_media = new <a href="media.html">Media</a>(src, onSuccess, onError);
+ // Create Media object from src
+ my_media = new Media(src, onSuccess, onError);
} // else play current audio
// Play audio
my_media.play();
@@ -102,17 +102,17 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
if (mediaTimer == null) {
mediaTimer = setInterval(function() {
// get my_media position
- my_media.getCurrent<a href="../geolocation/Position/position.html">Position</a>(
+ my_media.getCurrentPosition(
// success callback
function(position) {
if (position > -1) {
- setAudio<a href="../geolocation/Position/position.html">Position</a>((position) + " sec");
+ setAudioPosition((position) + " sec");
}
},
// error callback
function(e) {
console.log("Error getting pos=" + e);
- setAudio<a href="../geolocation/Position/position.html">Position</a>("Error: " + e);
+ setAudioPosition("Error: " + e);
}
);
}, 1000);
@@ -121,9 +121,9 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// Pause audio
//
- function <a href="../events/events.pause.html">pause</a>Audio() {
+ function pauseAudio() {
if (my_media) {
- my_media.<a href="../events/events.pause.html">pause</a>();
+ my_media.pause();
}
}
@@ -131,7 +131,7 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
//
function stopAudio() {
if (my_media) {
- my_<a href="media.stop.html">media.stop</a>();
+ my_media.stop();
}
clearInterval(mediaTimer);
mediaTimer = null;
@@ -152,7 +152,7 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// Set audio position
//
- function setAudio<a href="../geolocation/Position/position.html">Position</a>(position) {
+ function setAudioPosition(position) {
document.getElementById('audio_position').innerHTML = position;
}
@@ -160,7 +160,7 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
</head>
<body>
<a href="#" class="btn large" onclick="playAudio('http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3');">Play Audio</a>
- <a href="#" class="btn large" onclick="<a href="../events/events.pause.html">pause</a>Audio();">Pause Playing Audio</a>
+ <a href="#" class="btn large" onclick="pauseAudio();">Pause Playing Audio</a>
<a href="#" class="btn large" onclick="stopAudio();">Stop Playing Audio</a>
<p id="audio_position"></p>
</body>
@@ -178,5 +178,5 @@ iOS Quirk
Pass in this option to the **play** method to specify the number of times you want the media file to play. e.g:
- var my<a href="media.html">Media</a> = new <a href="media.html">Media</a>("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3")
- my<a href="media.html">Media</a>.play({ numberOfLoops: 2 })
+ var myMedia = new Media("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3")
+ myMedia.play({ numberOfLoops: 2 })
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org