You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by ag...@apache.org on 2013/09/04 05:11:11 UTC
[28/51] [partial] Delete rc versions of docs
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.8.0rc1/cordova/media/capture/MediaFile.getFormatData.md
----------------------------------------------------------------------
diff --git a/docs/en/1.8.0rc1/cordova/media/capture/MediaFile.getFormatData.md b/docs/en/1.8.0rc1/cordova/media/capture/MediaFile.getFormatData.md
deleted file mode 100644
index 40736cd..0000000
--- a/docs/en/1.8.0rc1/cordova/media/capture/MediaFile.getFormatData.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.
----
-
-MediaFile.getFormatData
-=======================
-
-> Retrieves format information about the media capture file.
-
- mediaFile.getFormatData(
- MediaFileDataSuccessCB successCallback,
- [MediaFileDataErrorCB errorCallback]
- );
-
-Description
------------
-
-This function asynchronously attempts to retrieve the format information for the media file. If successful, it invokes the MediaFileDataSuccessCB callback with a MediaFileData object. If the attempt fails, this function will invoke the MediaFileDataErrorCB callback.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Windows Phone 7 ( Mango )
-
-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.
-
-Android Quirks
---------------
-The API for retrieving media file format information is limited. Therefore, not all MediaFileData properties are supported. See MediaFileData documentation.
-
-iOS Quirks
-----------
-The API for retrieving media file format information is limited. Therefore, not all MediaFileData properties are supported. See MediaFileData documentation.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.8.0rc1/cordova/media/capture/MediaFile.md
----------------------------------------------------------------------
diff --git a/docs/en/1.8.0rc1/cordova/media/capture/MediaFile.md b/docs/en/1.8.0rc1/cordova/media/capture/MediaFile.md
deleted file mode 100644
index fe3d9a1..0000000
--- a/docs/en/1.8.0rc1/cordova/media/capture/MediaFile.md
+++ /dev/null
@@ -1,37 +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.
----
-
-MediaFile
-=========
-
-> Encapsulates properties of a media capture file.
-
-Properties
-----------
-
-- __name:__ The name of the file, without path information. (DOMString)
-- __fullPath:__ The full path of the file, including the name. (DOMString)
-- __type:__ The mime type (DOMString)
-- __lastModifiedDate:__ The date and time that the file was last modified. (Date)
-- __size:__ The size of the file, in bytes. (Number)
-
-Methods
--------
-
-- __MediaFile.getFormatData:__ Retrieves the format information of the media file.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.8.0rc1/cordova/media/capture/MediaFileData.md
----------------------------------------------------------------------
diff --git a/docs/en/1.8.0rc1/cordova/media/capture/MediaFileData.md b/docs/en/1.8.0rc1/cordova/media/capture/MediaFileData.md
deleted file mode 100644
index 93ed349..0000000
--- a/docs/en/1.8.0rc1/cordova/media/capture/MediaFileData.md
+++ /dev/null
@@ -1,62 +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.
----
-
-MediaFileData
-=============
-
-> Encapsulates format information about a media file.
-
-Properties
-----------
-
-- __codecs:__ The actual format of the audio and video content. (DOMString)
-- __bitrate:__ The average bitrate of the content. In case of an image, this attribute has value 0. (Number)
-- __height:__ The height of the image or video in pixels. In the case of a sound clip, this attribute has value 0. (Number)
-- __width:__ The width of the image or video in pixels. In the case of a sound clip, this attribute has value 0. (Number)
-- __duration:__ The length of the video or sound clip in seconds. In the case of an image, this attribute has value 0. (Number)
-
-BlackBerry WebWorks Quirks
---------------------------
-There is no API that provides format information of media files. So the MediaFileData object returned by the MediaFile.getFormatData function will have the following default values:
-
-- __codecs:__ Not supported. The attribute will always be null.
-- __bitrate:__ Not supported. The attribute will always be 0.
-- __height:__ Not supported. The attribute will always be 0.
-- __width:__ Not supported. The attribute will always be 0.
-- __duration:__ Not supported. The attribute will always be 0.
-
-Android Quirks
---------------
-Support for the MediaFileData properties is as follows:
-
-- __codecs:__ Not supported. The attribute will always be null.
-- __bitrate:__ Not supported. The attribute will always be 0.
-- __height:__ Supported. (Image and video files only).
-- __width:__ Supported. (Image and video files only).
-- __duration:__ Supported. (Audio and video files only).
-
-iOS Quirks
-----------
-Support for the MediaFileData properties is as follows:
-
-- __codecs:__ Not supported. The attribute will always be null.
-- __bitrate:__ Supported on iOS4 devices for audio only. The attribute will always be 0 for image and video.
-- __height:__ Supported. (Image and video files only).
-- __width:__ Supported. (Image and video files only).
-- __duration:__ Supported. (Audio and video files only).
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.8.0rc1/cordova/media/capture/capture.md
----------------------------------------------------------------------
diff --git a/docs/en/1.8.0rc1/cordova/media/capture/capture.md b/docs/en/1.8.0rc1/cordova/media/capture/capture.md
deleted file mode 100644
index ffb522c..0000000
--- a/docs/en/1.8.0rc1/cordova/media/capture/capture.md
+++ /dev/null
@@ -1,121 +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
-=======
-
-> Provides access to the audio, image, and video capture capabilities of the device.
-
-Objects
--------
-
-- Capture
-- CaptureAudioOptions
-- CaptureImageOptions
-- CaptureVideoOptions
-- CaptureCB
-- CaptureErrorCB
-- ConfigurationData
-- MediaFile
-- MediaFileData
-
-Methods
--------
-
-- capture.captureAudio
-- capture.captureImage
-- capture.captureVideo
-- MediaFile.getFormatData
-
-Scope
------
-
-The __capture__ object is assigned to the __navigator.device__ object, and therefore has global scope.
-
- // The global capture object
- var capture = navigator.device.capture;
-
-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[])
-
-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).
-
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Windows Phone 7 ( Mango )
-
-Permissions
------------
-
-### Android
-
-#### app/res/xml/plugins.xml
-
- <plugin name="Capture" value="org.apache.cordova.Capture"/>
-
-#### app/AndroidManifest.xml
-
- <uses-permission android:name="android.permission.RECORD_AUDIO" />
- <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
-
-### Bada
-
- @TODO
-
-### BlackBerry WebWorks
-
-#### www/plugins.xml
-
- @TODO
-
-#### www/config.xml
-
- @TODO
-
-### iOS
-
-#### App/Supporting Files/Cordova.plist
-
- <key>Plugins</key>
- <dict>
- <key>Capture</key>
- <string>CDVCapture</string>
- </dict>
-
-### webOS
-
- @TODO
-
-### Windows Phone
-
- @TODO
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.8.0rc1/cordova/media/capture/captureAudio.md
----------------------------------------------------------------------
diff --git a/docs/en/1.8.0rc1/cordova/media/capture/captureAudio.md b/docs/en/1.8.0rc1/cordova/media/capture/captureAudio.md
deleted file mode 100644
index 4b7c0e5..0000000
--- a/docs/en/1.8.0rc1/cordova/media/capture/captureAudio.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.
----
-
-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]
- );
-
-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.
-
-When the capture operation is finished, it will invoke the CaptureCB callback with an array of MediaFile objects describing each captured audio clip file. If the operation is terminated by the user before an audio clip is captured, the CaptureErrorCB callback will be invoked with a CaptureError object with the CaptureError.`CAPTURE_NO_MEDIA_FILES` error code.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Windows Phone 7 ( Mango )
-
-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 audio capture
- navigator.device.capture.captureAudio(captureSuccess, captureError, {limit:2});
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Capture Audio</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
- <script type="text/javascript" charset="utf-8" src="json2.js"></script>
- <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 captureAudio() {
- // Launch device audio recording application,
- // allowing user to capture up to 2 audio clips
- navigator.device.capture.captureAudio(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="captureAudio();">Capture Audio</button> <br>
- </body>
- </html>
-
-BlackBerry WebWorks Quirks
---------------------------
-
-- Cordova for BlackBerry WebWorks attempts to launch the __Voice Notes Recorder__ application, provided by RIM, to capture the audio recordings. The developer will receive a CaptureError.`CAPTURE_NOT_SUPPORTED` error code if the application is not installed on the device.
-
-iOS Quirks
-----------
-
-- iOS does not have a default audio recording application so a simple user interface is provided.
-
-Windows Phone 7 Quirks
-----------
-
-- Windows Phone 7 does not have a default audio recording application so a simple user interface is provided.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.8.0rc1/cordova/media/capture/captureAudioOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/1.8.0rc1/cordova/media/capture/captureAudioOptions.md b/docs/en/1.8.0rc1/cordova/media/capture/captureAudioOptions.md
deleted file mode 100644
index 19ec58b..0000000
--- a/docs/en/1.8.0rc1/cordova/media/capture/captureAudioOptions.md
+++ /dev/null
@@ -1,56 +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.
----
-
-CaptureAudioOptions
-===================
-
-> Encapsulates audio capture configuration options.
-
-Properties
-----------
-
-- __limit:__ The maximum number of audio clips the device user can record in a single capture operation. The value must be greater than or equal to 1 (defaults to 1).
-- __duration:__ The maximum duration of an audio sound clip, in seconds.
-- __mode:__ The selected audio mode. The value must match one of the elements in `capture.supportedAudioModes`.
-
-Quick Example
--------------
-
- // limit capture operation to 3 media files, no longer than 10 seconds each
- var options = { limit: 3, duration: 10 };
-
- navigator.device.capture.captureAudio(captureSuccess, captureError, options);
-
-Android Quirks
---------------
-
-- The __duration__ parameter is not supported. Recording lengths cannot be limited programmatically.
-- The __mode__ parameter is not supported. The audio recording format cannot be altered programmatically. Recordings are encoded using Adaptive Multi-Rate (AMR) format (audio/amr).
-
-BlackBerry WebWorks Quirks
---------------------------
-
-- The __duration__ parameter is not supported. Recording lengths cannot be limited programmatically.
-- The __mode__ parameter is not supported. The audio recording format cannot be altered programmatically. Recordings are encoded using Adaptive Multi-Rate (AMR) format (audio/amr).
-
-iOS Quirks
-----------
-
-- The __limit__ parameter is not supported. One recording can be created for each invocation.
-- The __mode__ parameter is not supported. The audio recording format cannot be altered programmatically. Recordings are encoded using Waveform Audio (WAV) format (audio/wav).
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.8.0rc1/cordova/media/capture/captureImage.md
----------------------------------------------------------------------
diff --git a/docs/en/1.8.0rc1/cordova/media/capture/captureImage.md b/docs/en/1.8.0rc1/cordova/media/capture/captureImage.md
deleted file mode 100644
index a275cfa..0000000
--- a/docs/en/1.8.0rc1/cordova/media/capture/captureImage.md
+++ /dev/null
@@ -1,133 +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.captureImage
-====================
-
-> Start the camera application and return information about captured image file(s).
-
- navigator.device.capture.captureImage(
- CaptureCB captureSuccess, CaptureErrorCB captureError, [CaptureImageOptions options]
- );
-
-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.
-
-When the capture operation is finished, it will invoke the CaptureCB callback with an array of MediaFile objects describing each captured image file. If the operation is terminated by the user before an image is captured, the CaptureErrorCB callback will be invoked with a CaptureError object with the CaptureError.`CAPTURE_NO_MEDIA_FILES` error code.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Windows Phone 7 ( Mango )
-
-Windows Phone 7 Quirks
-----------------------
-
-Invoking the native camera application while your device is connected
-via Zune will not work, and the error callback will be triggered.
-
-Quick 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 image capture
- navigator.device.capture.captureImage(captureSuccess, captureError, {limit:2});
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Capture Image</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
- <script type="text/javascript" charset="utf-8" src="json2.js"></script>
- <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 captureImage() {
- // Launch device camera application,
- // allowing user to capture up to 2 images
- navigator.device.capture.captureImage(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="captureImage();">Capture Image</button> <br>
- </body>
- </html>
-
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.8.0rc1/cordova/media/capture/captureImageOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/1.8.0rc1/cordova/media/capture/captureImageOptions.md b/docs/en/1.8.0rc1/cordova/media/capture/captureImageOptions.md
deleted file mode 100644
index 763a389..0000000
--- a/docs/en/1.8.0rc1/cordova/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/875c8fe2/docs/en/1.8.0rc1/cordova/media/capture/captureVideo.md
----------------------------------------------------------------------
diff --git a/docs/en/1.8.0rc1/cordova/media/capture/captureVideo.md b/docs/en/1.8.0rc1/cordova/media/capture/captureVideo.md
deleted file mode 100644
index 76f2e16..0000000
--- a/docs/en/1.8.0rc1/cordova/media/capture/captureVideo.md
+++ /dev/null
@@ -1,130 +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
-- Windows Phone 7 ( Mango )
-
-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="cordova-1.8.0.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
---------------------------
-
-- Cordova for BlackBerry WebWorks attempts to launch the __Video Recorder__ application, provided by RIM, to capture the video recordings. The developer will receive a CaptureError.`CAPTURE_NOT_SUPPORTED` error code if the application is not installed on the device.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.8.0rc1/cordova/media/capture/captureVideoOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/1.8.0rc1/cordova/media/capture/captureVideoOptions.md b/docs/en/1.8.0rc1/cordova/media/capture/captureVideoOptions.md
deleted file mode 100644
index 95711f1..0000000
--- a/docs/en/1.8.0rc1/cordova/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/875c8fe2/docs/en/1.8.0rc1/cordova/media/media.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/1.8.0rc1/cordova/media/media.getCurrentPosition.md b/docs/en/1.8.0rc1/cordova/media/media.getCurrentPosition.md
deleted file mode 100644
index af048b3..0000000
--- a/docs/en/1.8.0rc1/cordova/media/media.getCurrentPosition.md
+++ /dev/null
@@ -1,173 +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 in seconds.
-- __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. Also updates the ___position__ parameter within the Media object.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Windows Phone 7 ( Mango )
-
-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) + " 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="cordova-1.8.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova 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) + " 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/875c8fe2/docs/en/1.8.0rc1/cordova/media/media.getDuration.md
----------------------------------------------------------------------
diff --git a/docs/en/1.8.0rc1/cordova/media/media.getDuration.md b/docs/en/1.8.0rc1/cordova/media/media.getDuration.md
deleted file mode 100644
index 22f50d2..0000000
--- a/docs/en/1.8.0rc1/cordova/media/media.getDuration.md
+++ /dev/null
@@ -1,165 +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
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Windows Phone 7 ( Mango )
-
-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) + " 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="cordova-1.8.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova 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) + " 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/875c8fe2/docs/en/1.8.0rc1/cordova/media/media.md
----------------------------------------------------------------------
diff --git a/docs/en/1.8.0rc1/cordova/media/media.md b/docs/en/1.8.0rc1/cordova/media/media.md
deleted file mode 100644
index d655409..0000000
--- a/docs/en/1.8.0rc1/cordova/media/media.md
+++ /dev/null
@@ -1,120 +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], [mediaStatus]);
-
-
-Note: The current implementation does not adhere to a W3C specification for media capture, and is provided for convenience only. A future implementation will adhere to the latest W3C specification and may deprecate the current APIs.
-
-Parameters
-----------
-
-- __src__: A URI containing the audio content. _(DOMString)_
-- __mediaSuccess__: (Optional) The callback that is invoked after a Media object has completed the current play/record or stop action. _(Function)_
-- __mediaError__: (Optional) The callback that is invoked if there was an error. _(Function)_
-- __mediaStatus__: (Optional) The callback that is invoked to indicate status changes. _(Function)_
-
-Methods
--------
-
-- media.getCurrentPosition: Returns the current position within an audio file.
-- media.getDuration: Returns the duration of an audio file.
-- media.play: Start or resume playing audio file.
-- media.pause: Pause playing audio file.
-- media.release: Releases the underlying OS'es audio resources.
-- media.seekTo: Moves the position within the audio file.
-- media.startRecord: Start recording audio file.
-- media.stopRecord: Stop recording audio file.
-- media.stop: Stop playing audio file.
-
-Additional ReadOnly Parameters
----------------------
-
-- ___position__: The position within the audio playback in seconds. Not automatically updated during play, call getCurrentPosition to update.
-- ___duration__: The duration of the media in seconds.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Windows Phone 7 ( Mango )
-
-Permissions
------------
-
-### Android
-
-#### app/res/xml/plugins.xml
-
- <plugin name="Media" value="org.apache.cordova.AudioHandler"/>
-
-#### app/AndroidManifest.xml
-
- <uses-permission android:name="android.permission.RECORD_AUDIO" />
- <uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
- <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
-
-### Bada
-
- @TODO
-
-### BlackBerry WebWorks
-
-#### www/plugins.xml
-
- <plugin name="Capture" value="org.apache.cordova.media.MediaCapture"/>
-
-#### www/config.xml
-
- @TODO
-
-### iOS
-
-#### App/Supporting Files/Cordova.plist
-
- <key>Plugins</key>
- <dict>
- <key>Media</key>
- <string>CDVSound</string>
- </dict>
-
-### webOS
-
- @TODO
-
-### Windows Phone
-
-#### Properties/WPAppManifest.xml
-
- <Capabilities>
- <Capability Name="ID_CAP_MEDIALIB" />
- <Capability Name="ID_CAP_MICROPHONE"/>
- <Capability Name="ID_HW_FRONTCAMERA"/>
- <Capability Name="ID_CAP_ISV_CAMERA"/>
- <Capability Name="ID_CAP_CAMERA"/>
- </Capabilities>
-
-Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.8.0rc1/cordova/media/media.pause.md
----------------------------------------------------------------------
diff --git a/docs/en/1.8.0rc1/cordova/media/media.pause.md b/docs/en/1.8.0rc1/cordova/media/media.pause.md
deleted file mode 100644
index e17c634..0000000
--- a/docs/en/1.8.0rc1/cordova/media/media.pause.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.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
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Windows Phone 7 ( Mango )
-
-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="cordova-1.8.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova 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) + " 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/875c8fe2/docs/en/1.8.0rc1/cordova/media/media.play.md
----------------------------------------------------------------------
diff --git a/docs/en/1.8.0rc1/cordova/media/media.play.md b/docs/en/1.8.0rc1/cordova/media/media.play.md
deleted file mode 100644
index 3a6b123..0000000
--- a/docs/en/1.8.0rc1/cordova/media/media.play.md
+++ /dev/null
@@ -1,181 +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
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Windows Phone 7 ( Mango )
-
-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="cordova-1.8.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova 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) {
- if (my_media == null) {
- // Create Media object from src
- my_media = new Media(src, onSuccess, onError);
- } // else play current audio
- // 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) + " 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>
-
-BlackBerry WebWorks Quirks
-----------
-
-- BlackBerry devices support a limited number of simultaneous audio channels. CDMA devices only support a single audio channel. Other devices support up to two simultaneous channels. Attempting to play more audio files then the supported amount will result in previous playback being stopped.
-
-iOS Quirk
----------
-
-- __numberOfLoops__
-
- Pass in this option to the **play** method to specify the number of times you want the media file to play. e.g:
-
- var myMedia = new Media("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3")
- myMedia.play({ numberOfLoops: 2 })
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.8.0rc1/cordova/media/media.release.md
----------------------------------------------------------------------
diff --git a/docs/en/1.8.0rc1/cordova/media/media.release.md b/docs/en/1.8.0rc1/cordova/media/media.release.md
deleted file mode 100644
index 78b7972..0000000
--- a/docs/en/1.8.0rc1/cordova/media/media.release.md
+++ /dev/null
@@ -1,154 +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
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Windows Phone 7 ( Mango )
-
-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="cordova-1.8.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova 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) + " 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/875c8fe2/docs/en/1.8.0rc1/cordova/media/media.seekTo.md
----------------------------------------------------------------------
diff --git a/docs/en/1.8.0rc1/cordova/media/media.seekTo.md b/docs/en/1.8.0rc1/cordova/media/media.seekTo.md
deleted file mode 100644
index e9836a8..0000000
--- a/docs/en/1.8.0rc1/cordova/media/media.seekTo.md
+++ /dev/null
@@ -1,157 +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.seekTo
-========================
-
-Sets the current position within an audio file.
-
- media.seekTo(milliseconds);
-
-Parameters
-----------
-
-- __milliseconds__: The position to set the playback position within the audio in milliseconds. .
-
-
-Description
------------
-
-Function `media.seekTo` is an asynchronous function that updates the current position of the underlying audio file of a Media object. Also updates the ___position__ parameter within the Media object.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 6.0 and higher)
-- iOS
-- Windows Phone 7 ( Mango )
-
-Quick Example
--------------
-
- // Audio player
- //
- var my_media = new Media(src, onSuccess, onError);
- my_media.play();
- // SeekTo to 10 seconds after 5 seconds
- setTimeout(function() {
- my_media.seekTo(10000);
- }, 5000);
-
-
-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="cordova-1.8.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova 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 media position every second
- mediaTimer = setInterval(function() {
- // get media position
- my_media.getCurrentPosition(
- // success callback
- function(position) {
- if (position > -1) {
- setAudioPosition(position + " sec");
- }
- },
- // error callback
- function(e) {
- console.log("Error getting pos=" + e);
- }
- );
- }, 1000);
- // SeekTo to 10 seconds after 5 seconds
- setTimeout(function() {
- my_media.seekTo(10000);
- }, 5000);
- }
-
- // 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="stopAudio();">Stop Playing Audio</a>
- <p id="audio_position"></p>
- </body>
- </html>
-
-BlackBerry WebWorks Quirks
-----------
-
-- This API is not supported on BlackBerry OS 5 devices.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.8.0rc1/cordova/media/media.startRecord.md
----------------------------------------------------------------------
diff --git a/docs/en/1.8.0rc1/cordova/media/media.startRecord.md b/docs/en/1.8.0rc1/cordova/media/media.startRecord.md
deleted file mode 100644
index 1eff9ad..0000000
--- a/docs/en/1.8.0rc1/cordova/media/media.startRecord.md
+++ /dev/null
@@ -1,141 +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
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Windows Phone 7 ( Mango )
-
-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="cordova-1.8.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova 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);
- }
-
- // Cordova 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>
-
-BlackBerry WebWorks Quirks
-----------
-
-- BlackBerry devices record audio in Adaptive Multi-Rate format. The specified file must end with a .amr extension.
-
-iOS Quirks
-----------
-
-- The file to record to must already exist and should be of type .wav. The File API's can be used to create the file.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.8.0rc1/cordova/media/media.stop.md
----------------------------------------------------------------------
diff --git a/docs/en/1.8.0rc1/cordova/media/media.stop.md b/docs/en/1.8.0rc1/cordova/media/media.stop.md
deleted file mode 100644
index 992dea9..0000000
--- a/docs/en/1.8.0rc1/cordova/media/media.stop.md
+++ /dev/null
@@ -1,169 +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
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Windows Phone 7 ( Mango )
-
-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="cordova-1.8.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova 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) + " 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>