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/10 23:28:30 UTC
[30/51] [partial] docs commit: Solidifying 'automatic' links.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.5.0/phonegap/geolocation/PositionError/positionError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/geolocation/PositionError/positionError.md b/www/docs/en/1.5.0/phonegap/geolocation/PositionError/positionError.md
index 45bef69..4450441 100644
--- a/www/docs/en/1.5.0/phonegap/geolocation/PositionError/positionError.md
+++ b/www/docs/en/1.5.0/phonegap/geolocation/PositionError/positionError.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-PositionError
+<a href="../Position/position.html">Position</a>Error
========
-A `PositionError` object is returned to the geolocationError callback when an error occurs.
+A `<a href="../Position/position.html">Position</a>Error` object is returned to the <a href="../parameters/geolocationError.html">geolocationError</a> callback when an error occurs.
Properties
----------
@@ -32,12 +32,12 @@ Properties
Constants
---------
-- `PositionError.PERMISSION_DENIED`
-- `PositionError.POSITION_UNAVAILABLE`
-- `PositionError.TIMEOUT`
+- `<a href="../Position/position.html">Position</a>Error.PERMISSION_DENIED`
+- `<a href="../Position/position.html">Position</a>Error.POSITION_UNAVAILABLE`
+- `<a href="../Position/position.html">Position</a>Error.TIMEOUT`
Description
-----------
-The `PositionError` object is returned to the user through the `geolocationError` callback function when an error occurs with geolocation.
+The `<a href="../Position/position.html">Position</a>Error` object is returned to the user through the `<a href="../parameters/geolocationError.html">geolocationError</a>` callback function when an error occurs with geolocation.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.5.0/phonegap/geolocation/geolocation.clearWatch.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/geolocation/geolocation.clearWatch.md b/www/docs/en/1.5.0/phonegap/geolocation/geolocation.clearWatch.md
index 454158c..a41c93b 100644
--- a/www/docs/en/1.5.0/phonegap/geolocation/geolocation.clearWatch.md
+++ b/www/docs/en/1.5.0/phonegap/geolocation/geolocation.clearWatch.md
@@ -28,12 +28,12 @@ Stop watching for changes to the device's location referenced by the `watchID` p
Parameters
----------
-- __watchID:__ The id of the `watchPosition` interval to clear. (String)
+- __watchID:__ The id of the `watch<a href="Position/position.html">Position</a>` interval to clear. (String)
Description
-----------
-Function `geolocation.clearWatch` stops watching changes to the device's location by clearing the `geolocation.watchPosition` referenced by `watchID`.
+Function `geolocation.clearWatch` stops watching changes to the device's location by clearing the `geolocation.watch<a href="Position/position.html">Position</a>` referenced by `watchID`.
Supported Platforms
-------------------
@@ -44,44 +44,44 @@ Supported Platforms
- iPhone
- Windows Phone 7 ( Mango )
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
// Options: retrieve the location every 3 seconds
//
- var watchID = navigator.geolocation.watchPosition(onSuccess, onError, { frequency: 3000 });
+ var watchID = navigator.geolocation.watch<a href="Position/position.html">Position</a>(onSuccess, onError, { frequency: 3000 });
// ...later on...
navigator.geolocation.clearWatch(watchID);
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Device Properties Example</title>
+ <title><a href="../device/device.html">Device</a> Properties <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for PhoneGap to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
var watchID = null;
// PhoneGap is ready
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
// Update every 3 seconds
var options = { frequency: 3000 };
- watchID = navigator.geolocation.watchPosition(onSuccess, onError, options);
+ watchID = navigator.geolocation.watch<a href="Position/position.html">Position</a>(onSuccess, onError, options);
}
- // onSuccess Geolocation
+ // onSuccess <a href="geolocation.html">Geolocation</a>
//
function onSuccess(position) {
var element = document.getElementById('geolocation');
@@ -99,7 +99,7 @@ Full Example
}
}
- // onError Callback receives a PositionError object
+ // onError Callback receives a <a href="<a href="Position/position.html">Position</a>Error/positionError.html"><a href="Position/position.html">Position</a>Error</a> object
//
function onError(error) {
alert('code: ' + error.code + '\n' +
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.5.0/phonegap/geolocation/geolocation.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/geolocation/geolocation.getCurrentPosition.md b/www/docs/en/1.5.0/phonegap/geolocation/geolocation.getCurrentPosition.md
index cc4297b..ead623f 100644
--- a/www/docs/en/1.5.0/phonegap/geolocation/geolocation.getCurrentPosition.md
+++ b/www/docs/en/1.5.0/phonegap/geolocation/geolocation.getCurrentPosition.md
@@ -18,26 +18,26 @@ license: >
under the License.
---
-geolocation.getCurrentPosition
+geolocation.getCurrent<a href="Position/position.html">Position</a>
==============================
-Returns the device's current position as a `Position` object.
+Returns the device's current position as a `<a href="Position/position.html">Position</a>` object.
- navigator.geolocation.getCurrentPosition(geolocationSuccess,
- [geolocationError],
- [geolocationOptions]);
+ navigator.geolocation.getCurrent<a href="Position/position.html">Position</a>(<a href="parameters/geolocationSuccess.html">geolocationSuccess</a>,
+ [<a href="parameters/geolocationError.html">geolocationError</a>],
+ [<a href="parameters/geolocation.options.html">geolocationOptions</a>]);
Parameters
----------
-- __geolocationSuccess__: The callback that is called with the current position.
-- __geolocationError__: (Optional) The callback that is called if there was an error.
-- __geolocationOptions__: (Optional) The geolocation options.
+- __<a href="parameters/geolocationSuccess.html">geolocationSuccess</a>__: The callback that is called with the current position.
+- __<a href="parameters/geolocationError.html">geolocationError</a>__: (Optional) The callback that is called if there was an error.
+- __<a href="parameters/geolocation.options.html">geolocationOptions</a>__: (Optional) The geolocation options.
Description
-----------
-Function `geolocation.getCurrentPosition` is an asynchronous function. It returns the device's current position to the `geolocationSuccess` callback with a `Position` object as the parameter. If there is an error, the `geolocationError` callback is invoked with a `PositionError` object.
+Function `geolocation.getCurrent<a href="Position/position.html">Position</a>` is an asynchronous function. It returns the device's current position to the `<a href="parameters/geolocationSuccess.html">geolocationSuccess</a>` callback with a `<a href="Position/position.html">Position</a>` object as the parameter. If there is an error, the `<a href="parameters/geolocationError.html">geolocationError</a>` callback is invoked with a `<a href="<a href="Position/position.html">Position</a>Error/positionError.html"><a href="Position/position.html">Position</a>Error</a>` object.
Supported Platforms
@@ -49,11 +49,11 @@ Supported Platforms
- iPhone
- Windows Phone 7 ( Mango )
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
// onSuccess Callback
- // This method accepts a `Position` object, which contains
+ // This method accepts a `<a href="Position/position.html">Position</a>` object, which contains
// the current GPS coordinates
//
var onSuccess = function(position) {
@@ -67,37 +67,37 @@ Quick Example
'Timestamp: ' + new Date(position.timestamp) + '\n');
};
- // onError Callback receives a PositionError object
+ // onError Callback receives a <a href="<a href="Position/position.html">Position</a>Error/positionError.html"><a href="Position/position.html">Position</a>Error</a> object
//
function onError(error) {
alert('code: ' + error.code + '\n' +
'message: ' + error.message + '\n');
}
- navigator.geolocation.getCurrentPosition(onSuccess, onError);
+ navigator.geolocation.getCurrent<a href="Position/position.html">Position</a>(onSuccess, onError);
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Device Properties Example</title>
+ <title><a href="../device/device.html">Device</a> Properties <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for PhoneGap to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
// PhoneGap is ready
//
- function onDeviceReady() {
- navigator.geolocation.getCurrentPosition(onSuccess, onError);
+ function on<a href="../device/device.html">Device</a>Ready() {
+ navigator.geolocation.getCurrent<a href="Position/position.html">Position</a>(onSuccess, onError);
}
- // onSuccess Geolocation
+ // onSuccess <a href="geolocation.html">Geolocation</a>
//
function onSuccess(position) {
var element = document.getElementById('geolocation');
@@ -111,7 +111,7 @@ Full Example
'Timestamp: ' + new Date(position.timestamp) + '<br />';
}
- // onError Callback receives a PositionError object
+ // onError Callback receives a <a href="<a href="Position/position.html">Position</a>Error/positionError.html"><a href="Position/position.html">Position</a>Error</a> object
//
function onError(error) {
alert('code: ' + error.code + '\n' +
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.5.0/phonegap/geolocation/geolocation.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/geolocation/geolocation.md b/www/docs/en/1.5.0/phonegap/geolocation/geolocation.md
index 37f866a..c7b38cc 100644
--- a/www/docs/en/1.5.0/phonegap/geolocation/geolocation.md
+++ b/www/docs/en/1.5.0/phonegap/geolocation/geolocation.md
@@ -23,28 +23,28 @@ Geolocation
> The `geolocation` object provides access to the device's GPS sensor.
-Geolocation provides location information for the device, such as latitude and longitude. Common sources of location information include Global Positioning System (GPS) and location inferred from network signals such as IP address, RFID, WiFi and Bluetooth MAC addresses, and GSM/CDMA cell IDs. No guarantee is given that the API returns the device's actual location.
+Geolocation provides location information for the device, such as latitude and longitude. Common sources of location information include Global <a href="Position/position.html">Position</a>ing System (GPS) and location inferred from network signals such as IP address, RFID, WiFi and Bluetooth MAC addresses, and GSM/CDMA cell IDs. No guarantee is given that the API returns the device's actual location.
This API is based on the [W3C Geo location API Specification](http://dev.w3.org/geo/api/spec-source.html). Some devices already provide an implementation of this spec. For those devices, the built-in support is used instead of replacing it with PhoneGap's implementation. For devices that don't have geolocation support, PhoneGap's implementation should be compatible with the W3C specification.
Methods
-------
-- geolocation.getCurrentPosition
-- geolocation.watchPosition
-- geolocation.clearWatch
+- geolocation.getCurrent<a href="Position/position.html">Position</a>
+- geolocation.watch<a href="Position/position.html">Position</a>
+- <a href="geolocation.clearWatch.html">geolocation.clearWatch</a>
Arguments
---------
-- geolocationSuccess
-- geolocationError
-- geolocationOptions
+- <a href="parameters/geolocationSuccess.html">geolocationSuccess</a>
+- <a href="parameters/geolocationError.html">geolocationError</a>
+- <a href="parameters/geolocation.options.html">geolocationOptions</a>
Objects (Read-Only)
-------------------
-- Position
-- PositionError
-- Coordinates
+- <a href="Position/position.html">Position</a>
+- <a href="<a href="Position/position.html">Position</a>Error/positionError.html"><a href="Position/position.html">Position</a>Error</a>
+- <a href="Coordinates/coordinates.html">Coordinates</a>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.5.0/phonegap/geolocation/geolocation.watchPosition.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/geolocation/geolocation.watchPosition.md b/www/docs/en/1.5.0/phonegap/geolocation/geolocation.watchPosition.md
index 8b2a89d..2ca0579 100644
--- a/www/docs/en/1.5.0/phonegap/geolocation/geolocation.watchPosition.md
+++ b/www/docs/en/1.5.0/phonegap/geolocation/geolocation.watchPosition.md
@@ -18,31 +18,31 @@ license: >
under the License.
---
-geolocation.watchPosition
+geolocation.watch<a href="Position/position.html">Position</a>
=========================
Watches for changes to the device's current position.
- var watchId = navigator.geolocation.watchPosition(geolocationSuccess,
- [geolocationError],
- [geolocationOptions]);
+ var watchId = navigator.geolocation.watch<a href="Position/position.html">Position</a>(<a href="parameters/geolocationSuccess.html">geolocationSuccess</a>,
+ [<a href="parameters/geolocationError.html">geolocationError</a>],
+ [<a href="parameters/geolocation.options.html">geolocationOptions</a>]);
Parameters
----------
-- __geolocationSuccess__: The callback that is called with the current position.
-- __geolocationError__: (Optional) The callback that is called if there was an error.
-- __geolocationOptions__: (Optional) The geolocation options.
+- __<a href="parameters/geolocationSuccess.html">geolocationSuccess</a>__: The callback that is called with the current position.
+- __<a href="parameters/geolocationError.html">geolocationError</a>__: (Optional) The callback that is called if there was an error.
+- __<a href="parameters/geolocation.options.html">geolocationOptions</a>__: (Optional) The geolocation options.
Returns
-------
-- __String__: returns a watch id that references the watch position interval. The watch id can be used with `geolocation.clearWatch` to stop watching for changes in position.
+- __String__: returns a watch id that references the watch position interval. The watch id can be used with `<a href="geolocation.clearWatch.html">geolocation.clearWatch</a>` to stop watching for changes in position.
Description
-----------
-Function `geolocation.watchPosition` is an asynchronous function. It returns the device's current position when a change in position has been detected. When the device has retrieved a new location, the `geolocationSuccess` callback is invoked with a `Position` object as the parameter. If there is an error, the `geolocationError` callback is invoked with a `PositionError` object.
+Function `geolocation.watch<a href="Position/position.html">Position</a>` is an asynchronous function. It returns the device's current position when a change in position has been detected. When the device has retrieved a new location, the `<a href="parameters/geolocationSuccess.html">geolocationSuccess</a>` callback is invoked with a `<a href="Position/position.html">Position</a>` object as the parameter. If there is an error, the `<a href="parameters/geolocationError.html">geolocationError</a>` callback is invoked with a `<a href="<a href="Position/position.html">Position</a>Error/positionError.html"><a href="Position/position.html">Position</a>Error</a>` object.
Supported Platforms
-------------------
@@ -53,11 +53,11 @@ Supported Platforms
- iPhone
- Windows Phone 7 ( Mango )
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
// onSuccess Callback
- // This method accepts a `Position` object, which contains
+ // This method accepts a `<a href="Position/position.html">Position</a>` object, which contains
// the current GPS coordinates
//
function onSuccess(position) {
@@ -67,7 +67,7 @@ Quick Example
'<hr />' + element.innerHTML;
}
- // onError Callback receives a PositionError object
+ // onError Callback receives a <a href="<a href="Position/position.html">Position</a>Error/positionError.html"><a href="Position/position.html">Position</a>Error</a> object
//
function onError(error) {
alert('code: ' + error.code + '\n' +
@@ -76,35 +76,35 @@ Quick Example
// Options: retrieve the location every 3 seconds
//
- var watchID = navigator.geolocation.watchPosition(onSuccess, onError, { frequency: 3000 });
+ var watchID = navigator.geolocation.watch<a href="Position/position.html">Position</a>(onSuccess, onError, { frequency: 3000 });
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Device Properties Example</title>
+ <title><a href="../device/device.html">Device</a> Properties <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for PhoneGap to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
var watchID = null;
// PhoneGap is ready
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
// Update every 3 seconds
var options = { frequency: 3000 };
- watchID = navigator.geolocation.watchPosition(onSuccess, onError, options);
+ watchID = navigator.geolocation.watch<a href="Position/position.html">Position</a>(onSuccess, onError, options);
}
- // onSuccess Geolocation
+ // onSuccess <a href="geolocation.html">Geolocation</a>
//
function onSuccess(position) {
var element = document.getElementById('geolocation');
@@ -113,7 +113,7 @@ Full Example
'<hr />' + element.innerHTML;
}
- // onError Callback receives a PositionError object
+ // onError Callback receives a <a href="<a href="Position/position.html">Position</a>Error/positionError.html"><a href="Position/position.html">Position</a>Error</a> object
//
function onError(error) {
alert('code: ' + error.code + '\n' +
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.5.0/phonegap/geolocation/parameters/geolocation.options.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/geolocation/parameters/geolocation.options.md b/www/docs/en/1.5.0/phonegap/geolocation/parameters/geolocation.options.md
index c6ab066..9b14493 100644
--- a/www/docs/en/1.5.0/phonegap/geolocation/parameters/geolocation.options.md
+++ b/www/docs/en/1.5.0/phonegap/geolocation/parameters/geolocation.options.md
@@ -30,7 +30,7 @@ Options
- __frequency:__ How often to retrieve the position in milliseconds. This option is not part of the W3C spec and will be removed in the future. maximumAge should be used instead. _(Number)_ (Default: 10000)
- __enableHighAccuracy:__ Provides a hint that the application would like to receive the best possible results. _(Boolean)_
-- __timeout:__ The maximum length of time (msec) that is allowed to pass from the call to `geolocation.getCurrentPosition` or `geolocation.watchPosition` until the corresponding `geolocationSuccess` callback is invoked. _(Number)_
+- __timeout:__ The maximum length of time (msec) 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. _(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/89392fa8/www/docs/en/1.5.0/phonegap/geolocation/parameters/geolocationError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/geolocation/parameters/geolocationError.md b/www/docs/en/1.5.0/phonegap/geolocation/parameters/geolocationError.md
index 3408969..afe00ea 100644
--- a/www/docs/en/1.5.0/phonegap/geolocation/parameters/geolocationError.md
+++ b/www/docs/en/1.5.0/phonegap/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. (`PositionError`)
+- __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>`)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.5.0/phonegap/geolocation/parameters/geolocationSuccess.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/geolocation/parameters/geolocationSuccess.md b/www/docs/en/1.5.0/phonegap/geolocation/parameters/geolocationSuccess.md
index 95d3455..e26929c 100644
--- a/www/docs/en/1.5.0/phonegap/geolocation/parameters/geolocationSuccess.md
+++ b/www/docs/en/1.5.0/phonegap/geolocation/parameters/geolocationSuccess.md
@@ -30,9 +30,9 @@ The user's callback function that is called when a geolocation position is avail
Parameters
----------
-- __position:__ The geolocation position returned by the device. (`Position`)
+- __position:__ The geolocation position returned by the device. (`<a href="../Position/position.html">Position</a>`)
-Example
+<a href="../../storage/storage.opendatabase.html">Example</a>
-------
function geolocationSuccess(position) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.5.0/phonegap/media/MediaError/mediaError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/media/MediaError/mediaError.md b/www/docs/en/1.5.0/phonegap/media/MediaError/mediaError.md
index ad11ca5..8d8a960 100644
--- a/www/docs/en/1.5.0/phonegap/media/MediaError/mediaError.md
+++ b/www/docs/en/1.5.0/phonegap/media/MediaError/mediaError.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-MediaError
+<a href="../media.html">Media</a>Error
==========
-A `MediaError` object is returned to the `mediaError` callback function when an error occurs.
+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.
Properties
----------
@@ -32,14 +32,14 @@ Properties
Constants
---------
-- `MediaError.MEDIA_ERR_ABORTED`
-- `MediaError.MEDIA_ERR_NETWORK`
-- `MediaError.MEDIA_ERR_DECODE`
-- `MediaError.MEDIA_ERR_NONE_SUPPORTED`
+- `<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`
Description
-----------
-The `MediaError` object is returned to the user through the `mediaError` callback function when an error occurs.
+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.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.5.0/phonegap/media/Parameters/mediaError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/media/Parameters/mediaError.md b/www/docs/en/1.5.0/phonegap/media/Parameters/mediaError.md
index 1e0e3a8..1881d31 100644
--- a/www/docs/en/1.5.0/phonegap/media/Parameters/mediaError.md
+++ b/www/docs/en/1.5.0/phonegap/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. (`MediaError`)
+- __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>`)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.5.0/phonegap/media/capture/CaptureCB.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/media/capture/CaptureCB.md b/www/docs/en/1.5.0/phonegap/media/capture/CaptureCB.md
index a897c8b..81cad0a 100644
--- a/www/docs/en/1.5.0/phonegap/media/capture/CaptureCB.md
+++ b/www/docs/en/1.5.0/phonegap/media/capture/CaptureCB.md
@@ -18,28 +18,28 @@ license: >
under the License.
---
-CaptureCB
+<a href="capture.html">Capture</a>CB
=========
> Invoked upon a successful media capture operation.
- function captureSuccess( MediaFile[] mediaFiles ) { ... };
+ 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 ) { ... };
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 MediaFile object describes a captured media file.
+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.
-Quick Example
+Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------
// capture callback
- function captureSuccess(mediaFiles) {
+ function captureSuccess(media<a href="../../file/fileobj/fileobj.html">File</a>s) {
var i, path, len;
- for (i = 0, len = mediaFiles.length; i < len; i += 1) {
- path = mediaFiles[i].fullPath;
+ 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;
// do something interesting with the file
}
};
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.5.0/phonegap/media/capture/CaptureError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/media/capture/CaptureError.md b/www/docs/en/1.5.0/phonegap/media/capture/CaptureError.md
index f387287..a4f135c 100644
--- a/www/docs/en/1.5.0/phonegap/media/capture/CaptureError.md
+++ b/www/docs/en/1.5.0/phonegap/media/capture/CaptureError.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-CaptureError
+<a href="capture.html">Capture</a>Error
============
> Encapsulates the error code resulting from a failed media capture operation.
@@ -31,8 +31,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.
+- <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.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.5.0/phonegap/media/capture/CaptureErrorCB.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/media/capture/CaptureErrorCB.md b/www/docs/en/1.5.0/phonegap/media/capture/CaptureErrorCB.md
index 7d24861..02e9f62 100644
--- a/www/docs/en/1.5.0/phonegap/media/capture/CaptureErrorCB.md
+++ b/www/docs/en/1.5.0/phonegap/media/capture/CaptureErrorCB.md
@@ -18,24 +18,24 @@ license: >
under the License.
---
-CaptureErrorCB
+<a href="capture.html">Capture</a>ErrorCB
==============
> Invoked if an error occurs during a media capture operation.
- function captureError( CaptureError error ) { ... };
+ function captureError( <a href="capture.html">Capture</a>Error 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 CaptureError object containing an appropriate error code.
+This function is invoked with a <a href="capture.html">Capture</a>Error object containing an appropriate error code.
-Quick Example
+Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------
// capture error callback
var captureError = function(error) {
- navigator.notification.alert('Error code: ' + error.code, null, 'Capture Error');
+ navigator.<a href="../../notification/notification.alert.html">notification.alert</a>('Error code: ' + error.code, null, '<a href="capture.html">Capture</a> Error');
};
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.5.0/phonegap/media/capture/ConfigurationData.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/media/capture/ConfigurationData.md b/www/docs/en/1.5.0/phonegap/media/capture/ConfigurationData.md
index 2b32dfe..797d9da 100644
--- a/www/docs/en/1.5.0/phonegap/media/capture/ConfigurationData.md
+++ b/www/docs/en/1.5.0/phonegap/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). Examples:
+The MIME types should adhere to [RFC2046](http://www.ietf.org/rfc/rfc2046.txt). <a href="../../storage/storage.opendatabase.html">Example</a>s:
- 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 Example
+Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------
// retrieve supported image modes
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.5.0/phonegap/media/capture/MediaFile.getFormatData.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/media/capture/MediaFile.getFormatData.md b/www/docs/en/1.5.0/phonegap/media/capture/MediaFile.getFormatData.md
index 83b2fe8..afb3f3e 100644
--- a/www/docs/en/1.5.0/phonegap/media/capture/MediaFile.getFormatData.md
+++ b/www/docs/en/1.5.0/phonegap/media/capture/MediaFile.getFormatData.md
@@ -18,20 +18,20 @@ license: >
under the License.
---
-MediaFile.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>.getFormatData
=======================
> Retrieves format information about the media capture file.
- mediaFile.getFormatData(
- MediaFileDataSuccessCB successCallback,
- [MediaFileDataErrorCB errorCallback]
+ 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]
);
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 <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.
Supported Platforms
-------------------
@@ -43,12 +43,12 @@ 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.
+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.
Android Quirks
--------------
-The API for retrieving media file format information is limited. Therefore, not all MediaFileData properties are supported. See MediaFileData documentation.
+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.
iOS Quirks
----------
-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
+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
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.5.0/phonegap/media/capture/MediaFile.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/media/capture/MediaFile.md b/www/docs/en/1.5.0/phonegap/media/capture/MediaFile.md
index 869b0ef..cced1d1 100644
--- a/www/docs/en/1.5.0/phonegap/media/capture/MediaFile.md
+++ b/www/docs/en/1.5.0/phonegap/media/capture/MediaFile.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-MediaFile
+<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>
=========
> Encapsulates properties of a media capture file.
@@ -26,13 +26,13 @@ MediaFile
Properties
----------
-- __name:__ The name of the file, without path information. (DOMString)
-- __fullPath:__ The full path of the file, including the name. (DOMString)
+- __<a href="../../storage/parameters/name.html">name</a>:__ The <a href="../../storage/parameters/name.html">name</a> of the file, without path information. (DOMString)
+- __fullPath:__ The full path of the file, including the <a href="../../storage/parameters/name.html">name</a>. (DOMString)
- __type:__ The mime type (DOMString)
- __lastModifiedDate:__ The date and time that the file was last modified. (Date)
-- __size:__ The size of the file, in bytes. (Number)
+- __<a href="../../storage/parameters/size.html">size</a>:__ The <a href="../../storage/parameters/size.html">size</a> of the file, in bytes. (Number)
Methods
-------
-- __MediaFile.getFormatData:__ Retrieves the format information of the media file.
\ No newline at end of file
+- __<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
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.5.0/phonegap/media/capture/MediaFileData.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/media/capture/MediaFileData.md b/www/docs/en/1.5.0/phonegap/media/capture/MediaFileData.md
index cc7de58..ebac2e3 100644
--- a/www/docs/en/1.5.0/phonegap/media/capture/MediaFileData.md
+++ b/www/docs/en/1.5.0/phonegap/media/capture/MediaFileData.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-MediaFileData
+<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
=============
> 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 MediaFileData object returned by the MediaFile.getFormatData function will have the following default values:
+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:
- __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 MediaFi
Android Quirks
--------------
-Support for the MediaFileData properties is as follows:
+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:
- __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 MediaFileData properties is as follows:
iOS Quirks
----------
-Support for the MediaFileData properties is as follows:
+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:
- __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/89392fa8/www/docs/en/1.5.0/phonegap/media/capture/capture.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/media/capture/capture.md b/www/docs/en/1.5.0/phonegap/media/capture/capture.md
index 24cf551..ab2d3c8 100644
--- a/www/docs/en/1.5.0/phonegap/media/capture/capture.md
+++ b/www/docs/en/1.5.0/phonegap/media/capture/capture.md
@@ -27,22 +27,22 @@ Objects
-------
- Capture
-- CaptureAudioOptions
-- CaptureImageOptions
-- CaptureVideoOptions
-- CaptureCB
-- CaptureErrorCB
-- ConfigurationData
-- MediaFile
-- MediaFileData
+- <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
Methods
-------
-- capture.captureAudio
-- capture.captureImage
-- capture.captureVideo
-- MediaFile.getFormatData
+- <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>
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. (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[])
+- __supportedAudioModes:__ The audio recording formats supported by the device. (<a href="ConfigurationData.html">ConfigurationData</a>[])
+- __supportedImageModes:__ The recording image <a href="../../storage/parameters/size.html">size</a>s 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>[])
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).
+- <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).
Supported Platforms
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.5.0/phonegap/media/capture/captureAudio.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/media/capture/captureAudio.md b/www/docs/en/1.5.0/phonegap/media/capture/captureAudio.md
index 06c90f8..e5a83df 100644
--- a/www/docs/en/1.5.0/phonegap/media/capture/captureAudio.md
+++ b/www/docs/en/1.5.0/phonegap/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(
- CaptureCB captureSuccess, CaptureErrorCB captureError, [CaptureAudioOptions options]
+ <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]
);
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 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 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.
-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.
+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.
Supported Platforms
-------------------
@@ -44,33 +44,33 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Quick Example
+Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------
// capture callback
- var captureSuccess = function(mediaFiles) {
+ var captureSuccess = function(media<a href="../../file/fileobj/fileobj.html">File</a>s) {
var i, path, len;
- for (i = 0, len = mediaFiles.length; i < len; i += 1) {
- path = mediaFiles[i].fullPath;
+ 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;
// do something interesting with the file
}
};
// capture error callback
var captureError = function(error) {
- navigator.notification.alert('Error code: ' + error.code, null, 'Capture Error');
+ navigator.<a href="../../notification/notification.alert.html">notification.alert</a>('Error code: ' + error.code, null, '<a href="capture.html">Capture</a> Error');
};
// start audio capture
navigator.device.capture.captureAudio(captureSuccess, captureError, {limit:2});
-Full Example
+Full <a href="../../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Capture Audio</title>
+ <title><a href="capture.html">Capture</a> Audio</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
<script type="text/javascript" charset="utf-8" src="json2.js"></script>
@@ -78,10 +78,10 @@ Full Example
// Called when capture operation is finished
//
- function captureSuccess(mediaFiles) {
+ function captureSuccess(media<a href="../../file/fileobj/fileobj.html">File</a>s) {
var i, len;
- for (i = 0, len = mediaFiles.length; i < len; i += 1) {
- uploadFile(mediaFiles[i]);
+ 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]);
}
}
@@ -89,7 +89,7 @@ Full Example
//
function captureError(error) {
var msg = 'An error occurred during capture: ' + error.code;
- navigator.notification.alert(msg, null, 'Uh oh!');
+ navigator.<a href="../../notification/notification.alert.html">notification.alert</a>(msg, null, 'Uh oh!');
}
// A button will call this function
@@ -101,10 +101,10 @@ Full Example
}
// Upload files to server
- function uploadFile(mediaFile) {
- var ft = new FileTransfer(),
- path = mediaFile.fullPath,
- name = mediaFile.name;
+ 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,
+ <a href="../../storage/parameters/name.html">name</a> = media<a href="../../file/fileobj/fileobj.html">File</a>.<a href="../../storage/parameters/name.html">name</a>;
ft.upload(path,
"http://my.domain.com/upload.php",
@@ -115,20 +115,20 @@ Full Example
function(error) {
console.log('Error uploading file ' + path + ': ' + error.code);
},
- { fileName: name });
+ { fileName: <a href="../../storage/parameters/name.html">name</a> });
}
</script>
</head>
<body>
- <button onclick="captureAudio();">Capture Audio</button> <br>
+ <button onclick="captureAudio();"><a href="capture.html">Capture</a> Audio</button> <br>
</body>
</html>
BlackBerry WebWorks Quirks
--------------------------
-- PhoneGap 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.
+- PhoneGap 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.
iOS Quirks
----------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.5.0/phonegap/media/capture/captureAudioOptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/media/capture/captureAudioOptions.md b/www/docs/en/1.5.0/phonegap/media/capture/captureAudioOptions.md
index ff303f5..08a05cd 100644
--- a/www/docs/en/1.5.0/phonegap/media/capture/captureAudioOptions.md
+++ b/www/docs/en/1.5.0/phonegap/media/capture/captureAudioOptions.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-CaptureAudioOptions
+<a href="capture.html">Capture</a>AudioOptions
===================
> 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 Example
+Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------
// limit capture operation to 3 media files, no longer than 10 seconds each
var options = { limit: 3, duration: 10 };
- navigator.device.capture.captureAudio(captureSuccess, captureError, options);
+ navigator.device.<a href="captureAudio.html">capture.captureAudio</a>(captureSuccess, captureError, options);
Android Quirks
--------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.5.0/phonegap/media/capture/captureImage.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/media/capture/captureImage.md b/www/docs/en/1.5.0/phonegap/media/capture/captureImage.md
index 5adbc66..998ad13 100644
--- a/www/docs/en/1.5.0/phonegap/media/capture/captureImage.md
+++ b/www/docs/en/1.5.0/phonegap/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(
- CaptureCB captureSuccess, CaptureErrorCB captureError, [CaptureImageOptions options]
+ <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]
);
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 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 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.
-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 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.
Supported Platforms
-------------------
@@ -44,33 +44,33 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Quick Example
+Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------
// capture callback
- var captureSuccess = function(mediaFiles) {
+ var captureSuccess = function(media<a href="../../file/fileobj/fileobj.html">File</a>s) {
var i, path, len;
- for (i = 0, len = mediaFiles.length; i < len; i += 1) {
- path = mediaFiles[i].fullPath;
+ 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;
// do something interesting with the file
}
};
// capture error callback
var captureError = function(error) {
- navigator.notification.alert('Error code: ' + error.code, null, 'Capture Error');
+ navigator.<a href="../../notification/notification.alert.html">notification.alert</a>('Error code: ' + error.code, null, '<a href="capture.html">Capture</a> Error');
};
// start image capture
navigator.device.capture.captureImage(captureSuccess, captureError, {limit:2});
-Full Example
+Full <a href="../../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Capture Image</title>
+ <title><a href="capture.html">Capture</a> Image</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
<script type="text/javascript" charset="utf-8" src="json2.js"></script>
@@ -78,10 +78,10 @@ Full Example
// Called when capture operation is finished
//
- function captureSuccess(mediaFiles) {
+ function captureSuccess(media<a href="../../file/fileobj/fileobj.html">File</a>s) {
var i, len;
- for (i = 0, len = mediaFiles.length; i < len; i += 1) {
- uploadFile(mediaFiles[i]);
+ 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]);
}
}
@@ -89,7 +89,7 @@ Full Example
//
function captureError(error) {
var msg = 'An error occurred during capture: ' + error.code;
- navigator.notification.alert(msg, null, 'Uh oh!');
+ navigator.<a href="../../notification/notification.alert.html">notification.alert</a>(msg, null, 'Uh oh!');
}
// A button will call this function
@@ -101,10 +101,10 @@ Full Example
}
// Upload files to server
- function uploadFile(mediaFile) {
- var ft = new FileTransfer(),
- path = mediaFile.fullPath,
- name = mediaFile.name;
+ 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,
+ <a href="../../storage/parameters/name.html">name</a> = media<a href="../../file/fileobj/fileobj.html">File</a>.<a href="../../storage/parameters/name.html">name</a>;
ft.upload(path,
"http://my.domain.com/upload.php",
@@ -115,13 +115,13 @@ Full Example
function(error) {
console.log('Error uploading file ' + path + ': ' + error.code);
},
- { fileName: name });
+ { fileName: <a href="../../storage/parameters/name.html">name</a> });
}
</script>
</head>
<body>
- <button onclick="captureImage();">Capture Image</button> <br>
+ <button onclick="captureImage();"><a href="capture.html">Capture</a> Image</button> <br>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.5.0/phonegap/media/capture/captureImageOptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/media/capture/captureImageOptions.md b/www/docs/en/1.5.0/phonegap/media/capture/captureImageOptions.md
index b9f0333..2fab5a7 100644
--- a/www/docs/en/1.5.0/phonegap/media/capture/captureImageOptions.md
+++ b/www/docs/en/1.5.0/phonegap/media/capture/captureImageOptions.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-CaptureImageOptions
+<a href="capture.html">Capture</a>ImageOptions
===================
> Encapsulates image capture configuration options.
@@ -29,26 +29,26 @@ 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 Example
+Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------
// limit capture operation to 3 images
var options = { limit: 3 };
- navigator.device.capture.captureImage(captureSuccess, captureError, options);
+ navigator.device.<a href="captureImage.html">capture.captureImage</a>(captureSuccess, captureError, options);
Android Quirks
--------------
-- The __mode__ parameter is not supported. The image size and format cannot be altered programmatically; however, the image size can be altered by the device user. Images are saved in JPEG format (image/jpeg).
+- The __mode__ parameter is not supported. The image <a href="../../storage/parameters/size.html">size</a> and format cannot be altered programmatically; however, the image <a href="../../storage/parameters/size.html">size</a> can be altered by the device user. Images are saved in JPEG format (image/jpeg).
BlackBerry WebWorks Quirks
--------------------------
-- The __mode__ parameter is not supported. The image size and format cannot be altered programmatically; however, the image size can be altered by the device user. Images are saved in JPEG format (image/jpeg).
+- The __mode__ parameter is not supported. The image <a href="../../storage/parameters/size.html">size</a> and format cannot be altered programmatically; however, the image <a href="../../storage/parameters/size.html">size</a> can be altered by the device user. Images are saved in JPEG format (image/jpeg).
iOS Quirks
----------
- The __limit__ parameter is not supported. One image is taken per invocation.
-- The __mode__ parameter is not supported. The image size and format cannot be altered programmatically. Images are saved in JPEG format (image/jpeg).
+- The __mode__ parameter is not supported. The image <a href="../../storage/parameters/size.html">size</a> and format cannot be altered programmatically. Images are saved in JPEG format (image/jpeg).
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.5.0/phonegap/media/capture/captureVideo.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/media/capture/captureVideo.md b/www/docs/en/1.5.0/phonegap/media/capture/captureVideo.md
index 46e3184..23256bf 100644
--- a/www/docs/en/1.5.0/phonegap/media/capture/captureVideo.md
+++ b/www/docs/en/1.5.0/phonegap/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(
- CaptureCB captureSuccess, CaptureErrorCB captureError, [CaptureVideoOptions options]
+ <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]
);
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 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 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.
-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 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.
Supported Platforms
-------------------
@@ -44,33 +44,33 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Quick Example
+Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------
// capture callback
- var captureSuccess = function(mediaFiles) {
+ var captureSuccess = function(media<a href="../../file/fileobj/fileobj.html">File</a>s) {
var i, path, len;
- for (i = 0, len = mediaFiles.length; i < len; i += 1) {
- path = mediaFiles[i].fullPath;
+ 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;
// do something interesting with the file
}
};
// capture error callback
var captureError = function(error) {
- navigator.notification.alert('Error code: ' + error.code, null, 'Capture Error');
+ navigator.<a href="../../notification/notification.alert.html">notification.alert</a>('Error code: ' + error.code, null, '<a href="capture.html">Capture</a> Error');
};
// start video capture
navigator.device.capture.captureVideo(captureSuccess, captureError, {limit:2});
-Full Example
+Full <a href="../../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Capture Video</title>
+ <title><a href="capture.html">Capture</a> Video</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
<script type="text/javascript" charset="utf-8" src="json2.js"></script>
@@ -78,10 +78,10 @@ Full Example
// Called when capture operation is finished
//
- function captureSuccess(mediaFiles) {
+ function captureSuccess(media<a href="../../file/fileobj/fileobj.html">File</a>s) {
var i, len;
- for (i = 0, len = mediaFiles.length; i < len; i += 1) {
- uploadFile(mediaFiles[i]);
+ 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]);
}
}
@@ -89,7 +89,7 @@ Full Example
//
function captureError(error) {
var msg = 'An error occurred during capture: ' + error.code;
- navigator.notification.alert(msg, null, 'Uh oh!');
+ navigator.<a href="../../notification/notification.alert.html">notification.alert</a>(msg, null, 'Uh oh!');
}
// A button will call this function
@@ -101,10 +101,10 @@ Full Example
}
// Upload files to server
- function uploadFile(mediaFile) {
- var ft = new FileTransfer(),
- path = mediaFile.fullPath,
- name = mediaFile.name;
+ 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,
+ <a href="../../storage/parameters/name.html">name</a> = media<a href="../../file/fileobj/fileobj.html">File</a>.<a href="../../storage/parameters/name.html">name</a>;
ft.upload(path,
"http://my.domain.com/upload.php",
@@ -115,17 +115,17 @@ Full Example
function(error) {
console.log('Error uploading file ' + path + ': ' + error.code);
},
- { fileName: name });
+ { fileName: <a href="../../storage/parameters/name.html">name</a> });
}
</script>
</head>
<body>
- <button onclick="captureVideo();">Capture Video</button> <br>
+ <button onclick="captureVideo();"><a href="capture.html">Capture</a> Video</button> <br>
</body>
</html>
BlackBerry WebWorks Quirks
--------------------------
-- PhoneGap 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.
+- PhoneGap 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.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.5.0/phonegap/media/capture/captureVideoOptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/media/capture/captureVideoOptions.md b/www/docs/en/1.5.0/phonegap/media/capture/captureVideoOptions.md
index 29667ad..b7e4c20 100644
--- a/www/docs/en/1.5.0/phonegap/media/capture/captureVideoOptions.md
+++ b/www/docs/en/1.5.0/phonegap/media/capture/captureVideoOptions.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-CaptureVideoOptions
+<a href="capture.html">Capture</a>VideoOptions
===================
> Encapsulates video capture configuration options.
@@ -30,31 +30,31 @@ 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 Example
+Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------
// limit capture operation to 3 video clips
var options = { limit: 3 };
- navigator.device.capture.captureVideo(captureSuccess, captureError, options);
+ navigator.device.<a href="captureVideo.html">capture.captureVideo</a>(captureSuccess, captureError, options);
Android Quirks
--------------
- The __duration__ parameter is not supported. Recording lengths cannot be limited programmatically.
-- The __mode__ parameter is not supported. The video size and format cannot be altered programmatically; however, these parameters can be changed by the device user. By default, videos are recorded in 3GPP (video/3gpp) format.
+- The __mode__ parameter is not supported. The video <a href="../../storage/parameters/size.html">size</a> and format cannot be altered programmatically; however, these parameters can be changed by the device user. By default, videos are recorded in 3GPP (video/3gpp) format.
BlackBerry WebWorks Quirks
--------------------------
- The __duration__ parameter is not supported. Recording lengths cannot be limited programmatically.
-- The __mode__ parameter is not supported. The video size and format cannot be altered programmatically; however, these parameters can be changed by the device user. By default, videos are recorded in 3GPP (video/3gpp) format.
+- The __mode__ parameter is not supported. The video <a href="../../storage/parameters/size.html">size</a> and format cannot be altered programmatically; however, these parameters can be changed by the device user. By default, videos are recorded in 3GPP (video/3gpp) format.
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 __mode__ parameter is not supported. The video size and format cannot be altered programmatically. By default, videos are recorded in MOV (video/quicktime) format.
+- The __mode__ parameter is not supported. The video <a href="../../storage/parameters/size.html">size</a> and format cannot be altered programmatically. By default, videos are recorded in MOV (video/quicktime) format.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.5.0/phonegap/media/media.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/media/media.getCurrentPosition.md b/www/docs/en/1.5.0/phonegap/media/media.getCurrentPosition.md
index 938d2e5..2793b72 100644
--- a/www/docs/en/1.5.0/phonegap/media/media.getCurrentPosition.md
+++ b/www/docs/en/1.5.0/phonegap/media/media.getCurrentPosition.md
@@ -18,23 +18,23 @@ license: >
under the License.
---
-media.getCurrentPosition
+media.getCurrent<a href="../geolocation/Position/position.html">Position</a>
========================
Returns the current position within an audio file.
- media.getCurrentPosition(mediaSuccess, [mediaError]);
+ media.getCurrent<a href="../geolocation/Position/position.html">Position</a>(mediaSuccess, [<a href="Parameters/mediaError.html">mediaError</a>]);
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.
+- __<a href="Parameters/mediaError.html">mediaError</a>__: (Optional) The callback that is called if there was an error.
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.
+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.
Supported Platforms
-------------------
@@ -43,17 +43,17 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
// Audio player
//
- var my_media = new Media(src, onSuccess, onError);
+ var my_media = new <a href="media.html">Media</a>(src, onSuccess, onError);
// Update media position every second
var mediaTimer = setInterval(function() {
// get media position
- my_media.getCurrentPosition(
+ my_media.getCurrent<a href="../geolocation/Position/position.html">Position</a>(
// success callback
function(position) {
if (position > -1) {
@@ -68,25 +68,25 @@ Quick Example
}, 1000);
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
- <title>Media Example</title>
+ <title><a href="media.html">Media</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for PhoneGap to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
// PhoneGap is ready
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
playAudio("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3");
}
@@ -98,27 +98,27 @@ Full Example
// Play audio
//
function playAudio(src) {
- // Create Media object from src
- my_media = new Media(src, onSuccess, onError);
+ // Create <a href="media.html">Media</a> object from src
+ my_media = new <a href="media.html">Media</a>(src, onSuccess, onError);
// Play audio
- my_media.play();
+ my_<a href="media.play.html">media.play</a>();
// Update my_media position every second
if (mediaTimer == null) {
mediaTimer = setInterval(function() {
// get my_media position
- my_media.getCurrentPosition(
+ my_media.getCurrent<a href="../geolocation/Position/position.html">Position</a>(
// success callback
function(position) {
if (position > -1) {
- setAudioPosition((position) + " sec");
+ setAudio<a href="../geolocation/Position/position.html">Position</a>((position) + " sec");
}
},
// error callback
function(e) {
console.log("Error getting pos=" + e);
- setAudioPosition("Error: " + e);
+ setAudio<a href="../geolocation/Position/position.html">Position</a>("Error: " + e);
}
);
}, 1000);
@@ -127,9 +127,9 @@ Full Example
// Pause audio
//
- function pauseAudio() {
+ function <a href="../events/events.pause.html">pause</a>Audio() {
if (my_media) {
- my_media.pause();
+ my_media.<a href="../events/events.pause.html">pause</a>();
}
}
@@ -137,7 +137,7 @@ Full Example
//
function stopAudio() {
if (my_media) {
- my_media.stop();
+ my_<a href="media.stop.html">media.stop</a>();
}
clearInterval(mediaTimer);
mediaTimer = null;
@@ -158,7 +158,7 @@ Full Example
// Set audio position
//
- function setAudioPosition(position) {
+ function setAudio<a href="../geolocation/Position/position.html">Position</a>(position) {
document.getElementById('audio_position').innerHTML = position;
}
@@ -166,7 +166,7 @@ Full Example
</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="pauseAudio();">Pause Playing 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="stopAudio();">Stop Playing Audio</a>
<p id="audio_position"></p>
</body>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org