You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by mw...@apache.org on 2013/02/19 23:27:17 UTC
[28/52] [partial] [#2454] Remove versions pre-dating Apache Cordova.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.6/phonegap/media/capture/captureImageOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.6/phonegap/media/capture/captureImageOptions.md b/docs/en/0.9.6/phonegap/media/capture/captureImageOptions.md
deleted file mode 100644
index 763a389..0000000
--- a/docs/en/0.9.6/phonegap/media/capture/captureImageOptions.md
+++ /dev/null
@@ -1,53 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-CaptureImageOptions
-===================
-
-> Encapsulates image capture configuration options.
-
-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
--------------
-
- // limit capture operation to 3 images
- var options = { limit: 3 };
-
- navigator.device.capture.captureImage(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).
-
-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).
-
-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).
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.6/phonegap/media/capture/captureVideo.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.6/phonegap/media/capture/captureVideo.md b/docs/en/0.9.6/phonegap/media/capture/captureVideo.md
deleted file mode 100644
index 2d5d9a7..0000000
--- a/docs/en/0.9.6/phonegap/media/capture/captureVideo.md
+++ /dev/null
@@ -1,129 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-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]
- );
-
-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.
-
-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
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-
-Quick Example
--------------
-
- // capture callback
- var captureSuccess = function(mediaFiles) {
- var i, path, len;
- 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.notification.alert('Error code: ' + error.code, null, 'Capture Error');
- };
-
- // start video capture
- navigator.device.capture.captureVideo(captureSuccess, captureError, {limit:2});
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Capture Video</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap.0.9.6.js"></script>
- <script type="text/javascript" charset="utf-8" src="json2.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Called when capture operation is finished
- //
- function captureSuccess(mediaFiles) {
- var i, len;
- for (i = 0, len = mediaFiles.length; i < len; i += 1) {
- uploadFile(mediaFiles[i]);
- }
- }
-
- // Called if something bad happens.
- //
- function captureError(error) {
- var msg = 'An error occurred during capture: ' + error.code;
- navigator.notification.alert(msg, null, 'Uh oh!');
- }
-
- // A button will call this function
- //
- function captureVideo() {
- // Launch device video recording application,
- // allowing user to capture up to 2 video clips
- navigator.device.capture.captureVideo(captureSuccess, captureError, {limit: 2});
- }
-
- // Upload files to server
- function uploadFile(mediaFile) {
- var ft = new FileTransfer(),
- path = mediaFile.fullPath,
- name = mediaFile.name;
-
- ft.upload(path,
- "http://my.domain.com/upload.php",
- function(result) {
- console.log('Upload success: ' + result.responseCode);
- console.log(result.bytesSent + ' bytes sent');
- },
- function(error) {
- console.log('Error uploading file ' + path + ': ' + error.code);
- },
- { fileName: name });
- }
-
- </script>
- </head>
- <body>
- <button onclick="captureVideo();">Capture 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.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.6/phonegap/media/capture/captureVideoOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.6/phonegap/media/capture/captureVideoOptions.md b/docs/en/0.9.6/phonegap/media/capture/captureVideoOptions.md
deleted file mode 100644
index 95711f1..0000000
--- a/docs/en/0.9.6/phonegap/media/capture/captureVideoOptions.md
+++ /dev/null
@@ -1,59 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-CaptureVideoOptions
-===================
-
-> Encapsulates video capture configuration options.
-
-Properties
-----------
-
-- __limit:__ The maximum number of video clips the device user can capture in a single capture operation. The value must be greater than or equal to 1 (defaults to 1).
-- __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
--------------
-
- // limit capture operation to 3 video clips
- var options = { limit: 3 };
-
- navigator.device.capture.captureVideo(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.
-
-
-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.
-
-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.
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.6/phonegap/media/media.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.6/phonegap/media/media.getCurrentPosition.md b/docs/en/0.9.6/phonegap/media/media.getCurrentPosition.md
deleted file mode 100644
index 2be137d..0000000
--- a/docs/en/0.9.6/phonegap/media/media.getCurrentPosition.md
+++ /dev/null
@@ -1,170 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-media.getCurrentPosition
-========================
-
-Returns the current position within an audio file.
-
- media.getCurrentPosition(mediaSuccess, [mediaError]);
-
-Parameters
-----------
-
-- __mediaSuccess__: The callback that is called with the current position.
-- __mediaError__: (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.
-
-Supported Platforms
--------------------
-
-- Android
-
-Quick Example
--------------
-
- // Audio player
- //
- var my_media = new Media(src, onSuccess, onError);
-
- // Update media position every second
- var mediaTimer = setInterval(function() {
- // get media position
- my_media.getCurrentPosition(
- // success callback
- function(position) {
- if (position > -1) {
- console.log((position/1000) + " sec");
- }
- },
- // error callback
- function(e) {
- console.log("Error getting pos=" + e);
- }
- );
- }, 1000);
-
-
-Full Example
-------------
-
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
- "http://www.w3.org/TR/html4/strict.dtd">
- <html>
- <head>
- <title>Media Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap.0.9.6.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for PhoneGap to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // PhoneGap is ready
- //
- function onDeviceReady() {
- playAudio("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3");
- }
-
- // Audio player
- //
- var my_media = null;
- var mediaTimer = null;
-
- // Play audio
- //
- function playAudio(src) {
- // Create Media object from src
- my_media = new Media(src, onSuccess, onError);
-
- // Play audio
- my_media.play();
-
- // Update my_media position every second
- if (mediaTimer == null) {
- mediaTimer = setInterval(function() {
- // get my_media position
- my_media.getCurrentPosition(
- // success callback
- function(position) {
- if (position > -1) {
- setAudioPosition((position/1000) + " sec");
- }
- },
- // error callback
- function(e) {
- console.log("Error getting pos=" + e);
- setAudioPosition("Error: " + e);
- }
- );
- }, 1000);
- }
- }
-
- // Pause audio
- //
- function pauseAudio() {
- if (my_media) {
- my_media.pause();
- }
- }
-
- // Stop audio
- //
- function stopAudio() {
- if (my_media) {
- my_media.stop();
- }
- clearInterval(mediaTimer);
- mediaTimer = null;
- }
-
- // onSuccess Callback
- //
- function onSuccess() {
- console.log("playAudio():Audio Success");
- }
-
- // onError Callback
- //
- function onError(error) {
- alert('code: ' + error.code + '\n' +
- 'message: ' + error.message + '\n');
- }
-
- // Set audio position
- //
- function setAudioPosition(position) {
- document.getElementById('audio_position').innerHTML = position;
- }
-
- </script>
- </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="stopAudio();">Stop Playing Audio</a>
- <p id="audio_position"></p>
- </body>
- </html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.6/phonegap/media/media.getDuration.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.6/phonegap/media/media.getDuration.md b/docs/en/0.9.6/phonegap/media/media.getDuration.md
deleted file mode 100644
index ac6d990..0000000
--- a/docs/en/0.9.6/phonegap/media/media.getDuration.md
+++ /dev/null
@@ -1,162 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-media.getDuration
-=================
-
-Returns the duration of an audio file.
-
- media.getDuration();
-
-
-Description
------------
-
-Function `media.getDuration` is a synchronous function that returns the duration of the audio file in seconds, if known. If the duration is unknown, a value of -1 is returned.
-
-Supported Platforms
--------------------
-
-- Android
-
-Quick Example
--------------
-
- // Audio player
- //
- var my_media = new Media(src, onSuccess, onError);
-
- // Get duration
- var counter = 0;
- var timerDur = setInterval(function() {
- counter = counter + 100;
- if (counter > 2000) {
- clearInterval(timerDur);
- }
- var dur = my_media.getDuration();
- if (dur > 0) {
- clearInterval(timerDur);
- document.getElementById('audio_duration').innerHTML = (dur/1000) + " sec";
- }
- }, 100);
-
-
-Full Example
-------------
-
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
- "http://www.w3.org/TR/html4/strict.dtd">
- <html>
- <head>
- <title>Media Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap.0.9.6.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for PhoneGap to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // PhoneGap is ready
- //
- function onDeviceReady() {
- playAudio("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3");
- }
-
- // Audio player
- //
- var my_media = null;
- var mediaTimer = null;
-
- // Play audio
- //
- function playAudio(src) {
- // Create Media object from src
- my_media = new Media(src, onSuccess, onError);
-
- // Play audio
- my_media.play();
-
- // Update my_media position every second
- if (mediaTimer == null) {
- mediaTimer = setInterval(function() {
- // get my_media position
- my_media.getCurrentPosition(
- // success callback
- function(position) {
- if (position > -1) {
- setAudioPosition((position/1000) + " sec");
- }
- },
- // error callback
- function(e) {
- console.log("Error getting pos=" + e);
- setAudioPosition("Error: " + e);
- }
- );
- }, 1000);
- }
- }
-
- // Pause audio
- //
- function pauseAudio() {
- if (my_media) {
- my_media.pause();
- }
- }
-
- // Stop audio
- //
- function stopAudio() {
- if (my_media) {
- my_media.stop();
- }
- clearInterval(mediaTimer);
- mediaTimer = null;
- }
-
- // onSuccess Callback
- //
- function onSuccess() {
- console.log("playAudio():Audio Success");
- }
-
- // onError Callback
- //
- function onError(error) {
- alert('code: ' + error.code + '\n' +
- 'message: ' + error.message + '\n');
- }
-
- // Set audio position
- //
- function setAudioPosition(position) {
- document.getElementById('audio_position').innerHTML = position;
- }
-
- </script>
- </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="stopAudio();">Stop Playing Audio</a>
- <p id="audio_position"></p>
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.6/phonegap/media/media.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.6/phonegap/media/media.md b/docs/en/0.9.6/phonegap/media/media.md
deleted file mode 100644
index 89e11ef..0000000
--- a/docs/en/0.9.6/phonegap/media/media.md
+++ /dev/null
@@ -1,58 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-Media
-=====
-
-> The `Media` object provides the ability to record and play back audio files on a device.
-
- var media = new Media(src, mediaSuccess, [mediaError]);
-
-
-Note: The current implementation does not adhere to a W3C specification for media capture, and is provided for convenience only. A future implementation will adhere to the latest W3C specification and may deprecate the current APIs.
-
-Parameters
-----------
-
-- __src__: A URI containing the audio content. _(DOMString)_
-- __mediaSuccess__: (Optional) The callback that is invoked after a Media object has completed the current play/record or stop action. _(Function)_
-- __mediaError__: (Optional) The callback that is invoked if there was an error. _(Function)_
-
-Methods
--------
-
-- media.getCurrentPosition: Returns the current position within an audio file.
-- media.getDuration: Returns the duration of an audio file.
-- media.play: Start or resume playing audio file.
-- media.pause: Pause playing audio file.
-- media.release: Releases the underlying OS'es audio resources.
-- media.startRecord: Start recording audio file.
-- media.stopRecord: Stop recording audio file.
-- media.stop: Stop playing audio file.
-
-Supported Platforms
--------------------
-
-- Android
-- iOS
-
-iOS Quirks
-----------
-- The callback functions must be global in scope (version 0.9.4 and earlier).
-- In the media constructor iOS calls a prepare method to load the file into the player in preparation for playing. An optional downloadCompleteCallback can be passed as the final parameter to the Media constructor. It will be called when the the call to prepare completes.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.6/phonegap/media/media.pause.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.6/phonegap/media/media.pause.md b/docs/en/0.9.6/phonegap/media/media.pause.md
deleted file mode 100644
index bc9ba1c..0000000
--- a/docs/en/0.9.6/phonegap/media/media.pause.md
+++ /dev/null
@@ -1,168 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-media.pause
-===========
-
-Pauses playing an audio file.
-
- media.pause();
-
-
-Description
------------
-
-Function `media.pause` is a synchronous function that pauses playing an audio file.
-
-Supported Platforms
--------------------
-
-- Android
-- iOS
-
-Quick Example
--------------
-
- // Play audio
- //
- function playAudio(url) {
- // Play the audio file at url
- var my_media = new Media(url,
- // success callback
- function() {
- console.log("playAudio():Audio Success");
- },
- // error callback
- function(err) {
- console.log("playAudio():Audio Error: "+err);
- });
-
- // Play audio
- my_media.play();
-
- // Pause after 10 seconds
- setTimeout(function() {
- media.pause();
- }, 10000);
- }
-
-
-Full Example
-------------
-
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
- "http://www.w3.org/TR/html4/strict.dtd">
- <html>
- <head>
- <title>Media Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap.0.9.6.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for PhoneGap to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // PhoneGap is ready
- //
- function onDeviceReady() {
- playAudio("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3");
- }
-
- // Audio player
- //
- var my_media = null;
- var mediaTimer = null;
-
- // Play audio
- //
- function playAudio(src) {
- // Create Media object from src
- my_media = new Media(src, onSuccess, onError);
-
- // Play audio
- my_media.play();
-
- // Update my_media position every second
- if (mediaTimer == null) {
- mediaTimer = setInterval(function() {
- // get my_media position
- my_media.getCurrentPosition(
- // success callback
- function(position) {
- if (position > -1) {
- setAudioPosition((position/1000) + " sec");
- }
- },
- // error callback
- function(e) {
- console.log("Error getting pos=" + e);
- setAudioPosition("Error: " + e);
- }
- );
- }, 1000);
- }
- }
-
- // Pause audio
- //
- function pauseAudio() {
- if (my_media) {
- my_media.pause();
- }
- }
-
- // Stop audio
- //
- function stopAudio() {
- if (my_media) {
- my_media.stop();
- }
- clearInterval(mediaTimer);
- mediaTimer = null;
- }
-
- // onSuccess Callback
- //
- function onSuccess() {
- console.log("playAudio():Audio Success");
- }
-
- // onError Callback
- //
- function onError(error) {
- alert('code: ' + error.code + '\n' +
- 'message: ' + error.message + '\n');
- }
-
- // Set audio position
- //
- function setAudioPosition(position) {
- document.getElementById('audio_position').innerHTML = position;
- }
-
- </script>
- </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="stopAudio();">Stop Playing Audio</a>
- <p id="audio_position"></p>
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.6/phonegap/media/media.play.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.6/phonegap/media/media.play.md b/docs/en/0.9.6/phonegap/media/media.play.md
deleted file mode 100644
index a5fc831..0000000
--- a/docs/en/0.9.6/phonegap/media/media.play.md
+++ /dev/null
@@ -1,163 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-media.play
-==========
-
-Starts or resumes playing an audio file.
-
- media.play();
-
-
-Description
------------
-
-Function `media.play` is a synchronous function that starts or resumes playing an audio file.
-
-Supported Platforms
--------------------
-
-- Android
-- iOS
-
-Quick Example
--------------
-
- // Play audio
- //
- function playAudio(url) {
- // Play the audio file at url
- var my_media = new Media(url,
- // success callback
- function() {
- console.log("playAudio():Audio Success");
- },
- // error callback
- function(err) {
- console.log("playAudio():Audio Error: "+err);
- });
-
- // Play audio
- my_media.play();
- }
-
-
-Full Example
-------------
-
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
- "http://www.w3.org/TR/html4/strict.dtd">
- <html>
- <head>
- <title>Media Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap.0.9.6.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for PhoneGap to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // PhoneGap is ready
- //
- function onDeviceReady() {
- playAudio("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3");
- }
-
- // Audio player
- //
- var my_media = null;
- var mediaTimer = null;
-
- // Play audio
- //
- function playAudio(src) {
- // Create Media object from src
- my_media = new Media(src, onSuccess, onError);
-
- // Play audio
- my_media.play();
-
- // Update my_media position every second
- if (mediaTimer == null) {
- mediaTimer = setInterval(function() {
- // get my_media position
- my_media.getCurrentPosition(
- // success callback
- function(position) {
- if (position > -1) {
- setAudioPosition((position/1000) + " sec");
- }
- },
- // error callback
- function(e) {
- console.log("Error getting pos=" + e);
- setAudioPosition("Error: " + e);
- }
- );
- }, 1000);
- }
- }
-
- // Pause audio
- //
- function pauseAudio() {
- if (my_media) {
- my_media.pause();
- }
- }
-
- // Stop audio
- //
- function stopAudio() {
- if (my_media) {
- my_media.stop();
- }
- clearInterval(mediaTimer);
- mediaTimer = null;
- }
-
- // onSuccess Callback
- //
- function onSuccess() {
- console.log("playAudio():Audio Success");
- }
-
- // onError Callback
- //
- function onError(error) {
- alert('code: ' + error.code + '\n' +
- 'message: ' + error.message + '\n');
- }
-
- // Set audio position
- //
- function setAudioPosition(position) {
- document.getElementById('audio_position').innerHTML = position;
- }
-
- </script>
- </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="stopAudio();">Stop Playing Audio</a>
- <p id="audio_position"></p>
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.6/phonegap/media/media.release.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.6/phonegap/media/media.release.md b/docs/en/0.9.6/phonegap/media/media.release.md
deleted file mode 100644
index 35d6ae3..0000000
--- a/docs/en/0.9.6/phonegap/media/media.release.md
+++ /dev/null
@@ -1,151 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-media.release
-=================
-
-Releases the underlying operating systems audio resources.
-
- media.release();
-
-
-Description
------------
-
-Function `media.release` is a synchronous function that releases the underlying operating systems audio resources. This function is particularly important for Android as there are a finite amount of OpenCore instances for media playback. Developers should call the 'release' function when they no longer need the Media resource.
-
-Supported Platforms
--------------------
-
-- Android
-
-Quick Example
--------------
-
- // Audio player
- //
- var my_media = new Media(src, onSuccess, onError);
-
- my_media.play();
- my_media.stop();
- my_media.release();
-
-Full Example
-------------
-
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
- "http://www.w3.org/TR/html4/strict.dtd">
- <html>
- <head>
- <title>Media Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap.0.9.6.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for PhoneGap to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // PhoneGap is ready
- //
- function onDeviceReady() {
- playAudio("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3");
- }
-
- // Audio player
- //
- var my_media = null;
- var mediaTimer = null;
-
- // Play audio
- //
- function playAudio(src) {
- // Create Media object from src
- my_media = new Media(src, onSuccess, onError);
-
- // Play audio
- my_media.play();
-
- // Update my_media position every second
- if (mediaTimer == null) {
- mediaTimer = setInterval(function() {
- // get my_media position
- my_media.getCurrentPosition(
- // success callback
- function(position) {
- if (position > -1) {
- setAudioPosition((position/1000) + " sec");
- }
- },
- // error callback
- function(e) {
- console.log("Error getting pos=" + e);
- setAudioPosition("Error: " + e);
- }
- );
- }, 1000);
- }
- }
-
- // Pause audio
- //
- function pauseAudio() {
- if (my_media) {
- my_media.pause();
- }
- }
-
- // Stop audio
- //
- function stopAudio() {
- if (my_media) {
- my_media.stop();
- }
- clearInterval(mediaTimer);
- mediaTimer = null;
- }
-
- // onSuccess Callback
- //
- function onSuccess() {
- console.log("playAudio():Audio Success");
- }
-
- // onError Callback
- //
- function onError(error) {
- alert('code: ' + error.code + '\n' +
- 'message: ' + error.message + '\n');
- }
-
- // Set audio position
- //
- function setAudioPosition(position) {
- document.getElementById('audio_position').innerHTML = position;
- }
-
- </script>
- </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="stopAudio();">Stop Playing Audio</a>
- <p id="audio_position"></p>
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.6/phonegap/media/media.startRecord.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.6/phonegap/media/media.startRecord.md b/docs/en/0.9.6/phonegap/media/media.startRecord.md
deleted file mode 100644
index 16f65c1..0000000
--- a/docs/en/0.9.6/phonegap/media/media.startRecord.md
+++ /dev/null
@@ -1,136 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-media.startRecord
-=================
-
-Starts recording an audio file.
-
- media.startRecord();
-
-
-Description
------------
-
-Function `media.startRecord` is a synchronous function that starts recording an audio file.
-
-Supported Platforms
--------------------
-
-- Android
-- iOS
-
-Quick Example
--------------
-
- // Record audio
- //
- function recordAudio() {
- var src = "myrecording.mp3";
- var mediaRec = new Media(src,
- // success callback
- function() {
- console.log("recordAudio():Audio Success");
- },
-
- // error callback
- function(err) {
- console.log("recordAudio():Audio Error: "+ err.code);
- });
-
- // Record audio
- mediaRec.startRecord();
- }
-
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Device Properties Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap.0.9.6.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for PhoneGap to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Record audio
- //
- function recordAudio() {
- var src = "myrecording.mp3";
- var mediaRec = new Media(src, onSuccess, onError);
-
- // Record audio
- mediaRec.startRecord();
-
- // Stop recording after 10 sec
- var recTime = 0;
- var recInterval = setInterval(function() {
- recTime = recTime + 1;
- setAudioPosition(recTime + " sec");
- if (recTime >= 10) {
- clearInterval(recInterval);
- mediaRec.stopRecord();
- }
- }, 1000);
- }
-
- // PhoneGap is ready
- //
- function onDeviceReady() {
- recordAudio();
- }
-
- // onSuccess Callback
- //
- function onSuccess() {
- console.log("recordAudio():Audio Success");
- }
-
- // onError Callback
- //
- function onError(error) {
- alert('code: ' + error.code + '\n' +
- 'message: ' + error.message + '\n');
- }
-
- // Set audio position
- //
- function setAudioPosition(position) {
- document.getElementById('audio_position').innerHTML = position;
- }
-
- </script>
- </head>
- <body>
- <p id="media">Recording audio...</p>
- <p id="audio_position"></p>
- </body>
- </html>
-
-
-iOS Quirks
-----------
-
-- The method name is `startAudioRecord` on iOS.
-- The file to record to must already exist.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.6/phonegap/media/media.stop.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.6/phonegap/media/media.stop.md b/docs/en/0.9.6/phonegap/media/media.stop.md
deleted file mode 100644
index d263e78..0000000
--- a/docs/en/0.9.6/phonegap/media/media.stop.md
+++ /dev/null
@@ -1,167 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-media.stop
-==========
-
-Stops playing an audio file.
-
- media.stop();
-
-
-Description
------------
-
-Function `media.stop` is a synchronous function that stops playing an audio file.
-
-Supported Platforms
--------------------
-
-- Android
-- iOS
-
-Quick Example
--------------
-
- // Play audio
- //
- function playAudio(url) {
- // Play the audio file at url
- var my_media = new Media(url,
- // success callback
- function() {
- console.log("playAudio():Audio Success");
- },
- // error callback
- function(err) {
- console.log("playAudio():Audio Error: "+err);
- });
-
- // Play audio
- my_media.play();
-
- // Pause after 10 seconds
- setTimeout(function() {
- my_media.stop();
- }, 10000);
- }
-
-Full Example
-------------
-
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
- "http://www.w3.org/TR/html4/strict.dtd">
- <html>
- <head>
- <title>Media Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap.0.9.6.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for PhoneGap to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // PhoneGap is ready
- //
- function onDeviceReady() {
- playAudio("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3");
- }
-
- // Audio player
- //
- var my_media = null;
- var mediaTimer = null;
-
- // Play audio
- //
- function playAudio(src) {
- // Create Media object from src
- my_media = new Media(src, onSuccess, onError);
-
- // Play audio
- my_media.play();
-
- // Update my_media position every second
- if (mediaTimer == null) {
- mediaTimer = setInterval(function() {
- // get my_media position
- my_media.getCurrentPosition(
- // success callback
- function(position) {
- if (position > -1) {
- setAudioPosition((position/1000) + " sec");
- }
- },
- // error callback
- function(e) {
- console.log("Error getting pos=" + e);
- setAudioPosition("Error: " + e);
- }
- );
- }, 1000);
- }
- }
-
- // Pause audio
- //
- function pauseAudio() {
- if (my_media) {
- my_media.pause();
- }
- }
-
- // Stop audio
- //
- function stopAudio() {
- if (my_media) {
- my_media.stop();
- }
- clearInterval(mediaTimer);
- mediaTimer = null;
- }
-
- // onSuccess Callback
- //
- function onSuccess() {
- console.log("playAudio():Audio Success");
- }
-
- // onError Callback
- //
- function onError(error) {
- alert('code: ' + error.code + '\n' +
- 'message: ' + error.message + '\n');
- }
-
- // Set audio position
- //
- function setAudioPosition(position) {
- document.getElementById('audio_position').innerHTML = position;
- }
-
- </script>
- </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="stopAudio();">Stop Playing Audio</a>
- <p id="audio_position"></p>
- </body>
- </html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.6/phonegap/media/media.stopRecord.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.6/phonegap/media/media.stopRecord.md b/docs/en/0.9.6/phonegap/media/media.stopRecord.md
deleted file mode 100644
index 4692165..0000000
--- a/docs/en/0.9.6/phonegap/media/media.stopRecord.md
+++ /dev/null
@@ -1,140 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-media.stopRecord
-================
-
-Stops recording an audio file.
-
- media.stopRecord();
-
-
-Description
------------
-
-Function `media.stopRecord` is a synchronous function that stops recording an audio file.
-
-Supported Platforms
--------------------
-
-- Android
-- iOS
-
-Quick Example
--------------
-
- // Record audio
- //
- function recordAudio() {
- var src = "myrecording.mp3";
- var mediaRec = new Media(src,
- // success callback
- function() {
- console.log("recordAudio():Audio Success");
- },
-
- // error callback
- function(err) {
- console.log("recordAudio():Audio Error: "+ err.code);
- });
-
- // Record audio
- mediaRec.startRecord();
-
- // Stop recording after 10 seconds
- setTimeout(function() {
- mediaRec.stopRecord();
- }, 10000);
- }
-
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Device Properties Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap.0.9.6.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for PhoneGap to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Record audio
- //
- function recordAudio() {
- var src = "myrecording.mp3";
- var mediaRec = new Media(src, onSuccess, onError);
-
- // Record audio
- mediaRec.startRecord();
-
- // Stop recording after 10 sec
- var recTime = 0;
- var recInterval = setInterval(function() {
- recTime = recTime + 1;
- setAudioPosition(recTime + " sec");
- if (recTime >= 10) {
- clearInterval(recInterval);
- mediaRec.stopRecord();
- }
- }, 1000);
- }
-
- // PhoneGap is ready
- //
- function onDeviceReady() {
- recordAudio();
- }
-
- // onSuccess Callback
- //
- function onSuccess() {
- console.log("recordAudio():Audio Success");
- }
-
- // onError Callback
- //
- function onError(error) {
- alert('code: ' + error.code + '\n' +
- 'message: ' + error.message + '\n');
- }
-
- // Set audio position
- //
- function setAudioPosition(position) {
- document.getElementById('audio_position').innerHTML = position;
- }
-
- </script>
- </head>
- <body>
- <p id="media">Recording audio...</p>
- <p id="audio_position"></p>
- </body>
- </html>
-
-iOS Quirks
-----------
-
-- The method name is `stopAudioRecord` on iOS.
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.6/phonegap/network/NetworkStatus/NetworkStatus.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.6/phonegap/network/NetworkStatus/NetworkStatus.md b/docs/en/0.9.6/phonegap/network/NetworkStatus/NetworkStatus.md
deleted file mode 100644
index 2314cc1..0000000
--- a/docs/en/0.9.6/phonegap/network/NetworkStatus/NetworkStatus.md
+++ /dev/null
@@ -1,30 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-NetworkStatus
-=============
-
-`NetworkStatus` defines a set of constants that describe the state of the network connection. The `reachability` argument of `network.isReachable` is a `NetworkStatus` constant.
-
-Constants
----------
-
-- `NetworkStatus.NOT_REACHABLE`
-- `NetworkStatus.REACHABLE_VIA_WIFI_NETWORK`
-- `NetworkStatus.REACHABLE_VIA_CARRIER_DATA_NETWORK`
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.6/phonegap/network/network.isReachable.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.6/phonegap/network/network.isReachable.md b/docs/en/0.9.6/phonegap/network/network.isReachable.md
deleted file mode 100644
index af900e8..0000000
--- a/docs/en/0.9.6/phonegap/network/network.isReachable.md
+++ /dev/null
@@ -1,100 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-network.isReachable
-===================
-
-Checks if a connection can be established with a specific domain.
-
- network.isReachable(reachableHostname, reachableCallback, [reachableOptions])
-
-Description
------------
-
-This is a fast way to determine the device's network connection state, type of connection, and whether a specific domain is online.
-
-Since `network.isReachable` is an asynchronous function, the network state is returned using a callback function.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
-
-Quick Example
--------------
-
- function reachableCallback(reachability) {
- // There is no consistency on the format of reachability
- var networkState = reachability.code || reachability;
-
- var states = {};
- states[NetworkStatus.NOT_REACHABLE] = 'No network connection';
- states[NetworkStatus.REACHABLE_VIA_CARRIER_DATA_NETWORK] = 'Carrier data connection';
- states[NetworkStatus.REACHABLE_VIA_WIFI_NETWORK] = 'WiFi connection';
-
- alert('Connection type: ' + states[networkState]);
- }
-
- navigator.network.isReachable('phonegap.com', reachableCallback);
-
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>isReachable Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap.0.9.6.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for PhoneGap to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // PhoneGap is loaded and it is now safe to make calls PhoneGap methods
- //
- function onDeviceReady() {
- navigator.network.isReachable("phonegap.com", reachableCallback, {});
- }
-
- // Check network status
- //
- function reachableCallback(reachability) {
- // There is no consistency on the format of reachability
- var networkState = reachability.code || reachability;
-
- var states = {};
- states[NetworkStatus.NOT_REACHABLE] = 'No network connection';
- states[NetworkStatus.REACHABLE_VIA_CARRIER_DATA_NETWORK] = 'Carrier data connection';
- states[NetworkStatus.REACHABLE_VIA_WIFI_NETWORK] = 'WiFi connection';
-
- alert('Connection type: ' + states[networkState]);
- }
-
- </script>
- </head>
- <body>
- <p>A dialog box will report the network state.</p>
- </body>
- </html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.6/phonegap/network/network.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.6/phonegap/network/network.md b/docs/en/0.9.6/phonegap/network/network.md
deleted file mode 100644
index 06aeb89..0000000
--- a/docs/en/0.9.6/phonegap/network/network.md
+++ /dev/null
@@ -1,40 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-Network
-=======
-
-> The `network` object gives access to the device's cellular and wifi connection information.
-
-Methods
--------
-
-- network.isReachable
-
-Arguments
----------
-
-- reachableHostname
-- reachableCallback
-- reachableOptions
-
-Constants
----------
-
-- NetworkStatus
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.6/phonegap/network/parameters/reachableCallback.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.6/phonegap/network/parameters/reachableCallback.md b/docs/en/0.9.6/phonegap/network/parameters/reachableCallback.md
deleted file mode 100644
index aeecfef..0000000
--- a/docs/en/0.9.6/phonegap/network/parameters/reachableCallback.md
+++ /dev/null
@@ -1,72 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-reachableCallback
-=================
-
-A callback function that provides the reachability status of a hostname.
-
- function reachableCallback(reachability) {
- // Check the reachability state
- }
-
-Parameters
-----------
-
-- __reachability:__ The device's network state. (`NetworkStatus`)
- - Unfortunately, there is no consistency across the platforms on the `reachability` format. See the quirks below for platform details.
-
-Description
------------
-
-This callback accepts a single argument called `reachability`, which is a `NetworkStatus` constant.
-
-Example
--------
-
- function reachableCallback(reachability) {
- // There is no consistency on the format of reachability
- var networkState = reachability.code || reachability;
-
- var states = {};
- states[NetworkStatus.NOT_REACHABLE] = 'No network connection';
- states[NetworkStatus.REACHABLE_VIA_CARRIER_DATA_NETWORK] = 'Carrier data connection';
- states[NetworkStatus.REACHABLE_VIA_WIFI_NETWORK] = 'WiFi connection';
-
- alert('Connection type: ' + states[networkState]);
- }
-
-BlackBerry Quirks
------------------
-
-Provides the network status as the value of `reachability`
-
- function reachableCallback(reachability) {
- var hasConnection = (reachability !== NetworkStatus.NOT_REACHABLE);
- }
-
-iPhone Quirks
--------------
-
-The iPhone implementation only provides information about the type of connection available. It does not verify that the host is actually available.
-
- function reachableCallback(reachability) {
- var networkState = reachability.code;
- alert('Connection type: ' + networkState + ' - ' + reachability.message);
- }
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.6/phonegap/network/parameters/reachableHostname.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.6/phonegap/network/parameters/reachableHostname.md b/docs/en/0.9.6/phonegap/network/parameters/reachableHostname.md
deleted file mode 100644
index f3f67fa..0000000
--- a/docs/en/0.9.6/phonegap/network/parameters/reachableHostname.md
+++ /dev/null
@@ -1,31 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-reachableHostname
-=================
-
-A `String` that specifies the remote host.
-
-The hostname can be a domain name or a network address:
-
- // Valid host names
- //
- var hostname = 'phonegap.com';
- var hostname = '192.168.0.1';
- var hostname = 'localhost';
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.6/phonegap/network/parameters/reachableOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.6/phonegap/network/parameters/reachableOptions.md b/docs/en/0.9.6/phonegap/network/parameters/reachableOptions.md
deleted file mode 100644
index b46f814..0000000
--- a/docs/en/0.9.6/phonegap/network/parameters/reachableOptions.md
+++ /dev/null
@@ -1,23 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-reachableOptions
-================
-
-None.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.6/phonegap/notification/notification.alert.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.6/phonegap/notification/notification.alert.md b/docs/en/0.9.6/phonegap/notification/notification.alert.md
deleted file mode 100644
index d58cda1..0000000
--- a/docs/en/0.9.6/phonegap/notification/notification.alert.md
+++ /dev/null
@@ -1,107 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-notification.alert
-==================
-
-Shows a custom alert or dialog box.
-
- navigator.notification.alert(message, alertCallback, [title], [buttonName])
-
-- __message:__ Dialog message (`String`)
-- __alertCallback:__ Callback to invoke when alert dialog is dismissed. (`Function`)
-- __title:__ Dialog title (`String`) (Optional, Default: "Alert")
-- __buttonName:__ Button name (`String`) (Optional, Default: "OK")
-
-Description
------------
-
-Most PhoneGap implementations use a native dialog box for this feature. However, some platforms simply use the browser's `alert` function, which is typically less customizable.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry (OS 4.6)
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
-
-Quick Example
--------------
-
- // Android / BlackBerry WebWorks (OS 5.0 and higher) / iPhone
- //
- function alertDismissed() {
- // do something
- }
-
- navigator.notification.alert(
- 'You are the winner!', // message
- alertDismissed, // callback
- 'Game Over', // title
- 'Done' // buttonName
- );
-
- // BlackBerry (OS 4.6) / webOS
- //
- navigator.notification.alert('You are the winner!');
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Notification Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap.0.9.6.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for PhoneGap to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // PhoneGap is ready
- //
- function onDeviceReady() {
- // Empty
- }
-
- // alert dialog dismissed
- function alertDismissed() {
- // do something
- }
-
- // Show a custom alert
- //
- function showAlert() {
- navigator.notification.alert(
- 'You are the winner!', // message
- alertDismissed, // callback
- 'Game Over', // title
- 'Done' // buttonName
- );
- }
-
- </script>
- </head>
- <body>
- <p><a href="#" onclick="showAlert(); return false;">Show Alert</a></p>
- </body>
- </html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.6/phonegap/notification/notification.beep.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.6/phonegap/notification/notification.beep.md b/docs/en/0.9.6/phonegap/notification/notification.beep.md
deleted file mode 100644
index ed96830..0000000
--- a/docs/en/0.9.6/phonegap/notification/notification.beep.md
+++ /dev/null
@@ -1,107 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-notification.beep
-=================
-
-The device will play a beep sound.
-
- navigator.notification.beep(times);
-
-- __times:__ The number of times to repeat the beep (`Number`)
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry (OS 4.6)
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
-
-Quick Example
--------------
-
- // Beep twice!
- navigator.notification.beep(2);
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Notification Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap.0.9.6.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for PhoneGap to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // PhoneGap is ready
- //
- function onDeviceReady() {
- // Empty
- }
-
- // Show a custom alert
- //
- function showAlert() {
- navigator.notification.alert(
- 'You are the winner!', // message
- 'Game Over', // title
- 'Done' // buttonName
- );
- }
-
- // Beep three times
- //
- function playBeep() {
- navigator.notification.beep(3);
- }
-
- // Vibrate for 2 seconds
- //
- function vibrate() {
- navigator.notification.vibrate(2000);
- }
-
- </script>
- </head>
- <body>
- <p><a href="#" onclick="showAlert(); return false;">Show Alert</a></p>
- <p><a href="#" onclick="playBeep(); return false;">Play Beep</a></p>
- <p><a href="#" onclick="vibrate(); return false;">Vibrate</a></p>
- </body>
- </html>
-
-Android Quirks
---------------
-
-- Android plays the default "Notification ringtone" specified under the "Settings/Sound & Display" panel.
-
-iPhone Quirks
--------------
-
-- Ignores the beep count argument.
-- There is no native beep API for iPhone.
- - PhoneGap implements beep by playing an audio file via the media API.
- - The user must provide a file with the desired beep tone.
- - This file must be less than 30 seconds long, located in the www/ root, and must be named `beep.wav`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.6/phonegap/notification/notification.confirm.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.6/phonegap/notification/notification.confirm.md b/docs/en/0.9.6/phonegap/notification/notification.confirm.md
deleted file mode 100755
index 98dbf12..0000000
--- a/docs/en/0.9.6/phonegap/notification/notification.confirm.md
+++ /dev/null
@@ -1,105 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-notification.confirm
-====================
-
-Shows a customizable confirmation dialog box.
-
- navigator.notification.confirm(message, confirmCallback, [title], [buttonLabels])
-
-- __message:__ Dialog message (`String`)
-- __confirmCallback:__ - Callback to invoke with index of button pressed (1, 2 or 3). (`Number`)
-- __title:__ Dialog title (`String`) (Optional, Default: "Confirm")
-- __buttonLabels:__ Comma separated string with button labels (`String`) (Optional, Default: "OK,Cancel")
-
-Description
------------
-
-Function `notification.confirm` displays a native dialog box that is more customizable than the browser's `confirm` function.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
-
-Quick Example
--------------
-
- // process the confirmation dialog result
- function onConfirm(button) {
- alert('You selected button ' + button);
- }
-
- // Show a custom confirmation dialog
- //
- function showConfirm() {
- navigator.notification.confirm(
- 'You are the winner!', // message
- onConfirm, // callback to invoke with index of button pressed
- 'Game Over', // title
- 'Restart,Exit' // buttonLabels
- );
- }
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Notification Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap.0.9.6.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for PhoneGap to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // PhoneGap is ready
- //
- function onDeviceReady() {
- // Empty
- }
-
- // process the confirmation dialog result
- function onConfirm(button) {
- alert('You selected button ' + button);
- }
-
- // Show a custom confirmation dialog
- //
- function showConfirm() {
- navigator.notification.confirm(
- 'You are the winner!', // message
- onConfirm, // callback to invoke with index of button pressed
- 'Game Over', // title
- 'Restart,Exit' // buttonLabels
- );
- }
-
- </script>
- </head>
- <body>
- <p><a href="#" onclick="showConfirm(); return false;">Show Confirm</a></p>
- </body>
- </html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.6/phonegap/notification/notification.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.6/phonegap/notification/notification.md b/docs/en/0.9.6/phonegap/notification/notification.md
deleted file mode 100644
index 865809f..0000000
--- a/docs/en/0.9.6/phonegap/notification/notification.md
+++ /dev/null
@@ -1,31 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-Notification
-============
-
-> Visual, audible, and tactile device notifications.
-
-Methods
--------
-
-- notification.alert
-- notification.confirm
-- notification.beep
-- notification.vibrate
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.6/phonegap/notification/notification.vibrate.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.6/phonegap/notification/notification.vibrate.md b/docs/en/0.9.6/phonegap/notification/notification.vibrate.md
deleted file mode 100644
index 197e5e1..0000000
--- a/docs/en/0.9.6/phonegap/notification/notification.vibrate.md
+++ /dev/null
@@ -1,102 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-notification.vibrate
-====================
-
-Vibrates the device for the specified amount of time.
-
- navigator.notification.vibrate(milliseconds)
-
-- __time:__ Milliseconds to vibrate the device. 1000 milliseconds equals 1 second (`Number`)
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry (OS 4.6)
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
-
-Quick Example
--------------
-
- // Vibrate for 2.5 seconds
- //
- navigator.notification.vibrate(2500);
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Notification Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap.0.9.6.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for PhoneGap to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // PhoneGap is ready
- //
- function onDeviceReady() {
- // Empty
- }
-
- // Show a custom alert
- //
- function showAlert() {
- navigator.notification.alert(
- 'You are the winner!', // message
- 'Game Over', // title
- 'Done' // buttonName
- );
- }
-
- // Beep three times
- //
- function playBeep() {
- navigator.notification.beep(3);
- }
-
- // Vibrate for 2 seconds
- //
- function vibrate() {
- navigator.notification.vibrate(2000);
- }
-
- </script>
- </head>
- <body>
- <p><a href="#" onclick="showAlert(); return false;">Show Alert</a></p>
- <p><a href="#" onclick="playBeep(); return false;">Play Beep</a></p>
- <p><a href="#" onclick="vibrate(); return false;">Vibrate</a></p>
- </body>
- </html>
-
-iPhone Quirks
--------------
-
-- __time:__ Ignores the time and vibrates for a pre-set amount of time.
-
- navigator.notification.vibrate();
- navigator.notification.vibrate(2500); // 2500 is ignored
\ No newline at end of file