Return-Path: X-Original-To: apmail-cordova-commits-archive@www.apache.org Delivered-To: apmail-cordova-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 4FE99D818 for ; Thu, 1 Nov 2012 17:32:14 +0000 (UTC) Received: (qmail 33943 invoked by uid 500); 1 Nov 2012 17:32:14 -0000 Delivered-To: apmail-cordova-commits-archive@cordova.apache.org Received: (qmail 33815 invoked by uid 500); 1 Nov 2012 17:32:13 -0000 Mailing-List: contact commits-help@cordova.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: callback-dev@cordova.apache.org Delivered-To: mailing list commits@cordova.apache.org Received: (qmail 33625 invoked by uid 500); 1 Nov 2012 17:32:11 -0000 Delivered-To: apmail-incubator-callback-commits@incubator.apache.org Received: (qmail 33598 invoked by uid 99); 1 Nov 2012 17:32:11 -0000 Received: from tyr.zones.apache.org (HELO tyr.zones.apache.org) (140.211.11.114) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 01 Nov 2012 17:32:11 +0000 Received: by tyr.zones.apache.org (Postfix, from userid 65534) id CF3F051809; Thu, 1 Nov 2012 17:32:10 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: mwbrooks@apache.org To: callback-commits@incubator.apache.org X-Mailer: ASF-Git Admin Mailer Subject: [6/10] Version 2.2.0 Message-Id: <20121101173210.CF3F051809@tyr.zones.apache.org> Date: Thu, 1 Nov 2012 17:32:10 +0000 (UTC) http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/media/capture/ConfigurationData.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/media/capture/ConfigurationData.md b/docs/en/2.2.0/cordova/media/capture/ConfigurationData.md new file mode 100644 index 0000000..c166b3e --- /dev/null +++ b/docs/en/2.2.0/cordova/media/capture/ConfigurationData.md @@ -0,0 +1,62 @@ +--- +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. +--- + +ConfigurationData +================= + +> Encapsulates a set of media capture parameters that a device supports. + +Description +----------- + +This object is used to describe media capture modes supported by the device. The configuration data includes the MIME type, and capture dimensions (for video or image capture). + +The MIME types should adhere to [RFC2046](http://www.ietf.org/rfc/rfc2046.txt). Examples: + +- video/3gpp +- video/quicktime +- image/jpeg +- audio/amr +- audio/wav + +Properties +---------- + +- __type:__ The ASCII-encoded string in lower case representing the media type. (DOMString) +- __height:__ The height of the image or video in pixels. In the case of a sound clip, this attribute has value 0. (Number) +- __width:__ The width of the image or video in pixels. In the case of a sound clip, this attribute has value 0. (Number) + +Quick Example +------------- + + // retrieve supported image modes + var imageModes = navigator.device.capture.supportedImageModes; + + // Select mode that has the highest horizontal resolution + var width = 0; + var selectedmode; + for each (var mode in imageModes) { + if (mode.width > width) { + width = mode.width; + selectedmode = mode; + } + } + + +Not supported by any platform. All configuration data arrays are empty. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/media/capture/MediaFile.getFormatData.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/media/capture/MediaFile.getFormatData.md b/docs/en/2.2.0/cordova/media/capture/MediaFile.getFormatData.md new file mode 100644 index 0000000..40736cd --- /dev/null +++ b/docs/en/2.2.0/cordova/media/capture/MediaFile.getFormatData.md @@ -0,0 +1,53 @@ +--- +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/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/media/capture/MediaFile.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/media/capture/MediaFile.md b/docs/en/2.2.0/cordova/media/capture/MediaFile.md new file mode 100644 index 0000000..fe3d9a1 --- /dev/null +++ b/docs/en/2.2.0/cordova/media/capture/MediaFile.md @@ -0,0 +1,37 @@ +--- +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/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/media/capture/MediaFileData.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/media/capture/MediaFileData.md b/docs/en/2.2.0/cordova/media/capture/MediaFileData.md new file mode 100644 index 0000000..93ed349 --- /dev/null +++ b/docs/en/2.2.0/cordova/media/capture/MediaFileData.md @@ -0,0 +1,62 @@ +--- +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/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/media/capture/capture.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/media/capture/capture.md b/docs/en/2.2.0/cordova/media/capture/capture.md new file mode 100644 index 0000000..5fbf0a4 --- /dev/null +++ b/docs/en/2.2.0/cordova/media/capture/capture.md @@ -0,0 +1,134 @@ +--- +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 + + + +#### app/AndroidManifest.xml + + + + +### Bada + +#### manifest.xml + + + RECORDING + + +### BlackBerry WebWorks + +#### www/plugins.xml + + + +#### www/config.xml + + + + +### iOS + +#### App/Supporting Files/Cordova.plist + + Plugins + + Capture + CDVCapture + + +### webOS + + No permissions are required. + +### Windows Phone + +#### Properties/WPAppManifest.xml + + + + + + + + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/media/capture/captureAudio.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/media/capture/captureAudio.md b/docs/en/2.2.0/cordova/media/capture/captureAudio.md new file mode 100644 index 0000000..077b2a7 --- /dev/null +++ b/docs/en/2.2.0/cordova/media/capture/captureAudio.md @@ -0,0 +1,140 @@ +--- +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 +------------ + + + + + Capture Audio + + + + + + +
+ + + +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/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/media/capture/captureAudioOptions.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/media/capture/captureAudioOptions.md b/docs/en/2.2.0/cordova/media/capture/captureAudioOptions.md new file mode 100644 index 0000000..19ec58b --- /dev/null +++ b/docs/en/2.2.0/cordova/media/capture/captureAudioOptions.md @@ -0,0 +1,56 @@ +--- +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/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/media/capture/captureImage.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/media/capture/captureImage.md b/docs/en/2.2.0/cordova/media/capture/captureImage.md new file mode 100644 index 0000000..1182c4d --- /dev/null +++ b/docs/en/2.2.0/cordova/media/capture/captureImage.md @@ -0,0 +1,158 @@ +--- +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 ) +- Bada 2.x + +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 +------------ + + + + + Capture Image + + + + + + +
+ + + + +Bada Quirks +----------- + +Bada supports _captureImage_ just like the other platforms. However there is _another_ mode where you can capture a video or an image straight in the webview without launching any camera app. In order to do that you need to: + +1. create a _<div>_ element somewhere in your document and give it an id (such as "preview"). + +
+ +2. Initialize the camera preview with the following method + + navigator.camera.showPreview("preview"); + +3. Once you get the preview you can + + 3.1 Capture an image with + + var options = { destinationFilename: "images/cam01.jpg", highRes: false}; + navigator.capture.captureImage(success, fail, options); + +3. Hide the camera preview with the following method + + navigator.camera.hidePreview("preview"); + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/media/capture/captureImageOptions.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/media/capture/captureImageOptions.md b/docs/en/2.2.0/cordova/media/capture/captureImageOptions.md new file mode 100644 index 0000000..763a389 --- /dev/null +++ b/docs/en/2.2.0/cordova/media/capture/captureImageOptions.md @@ -0,0 +1,53 @@ +--- +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/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/media/capture/captureVideo.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/media/capture/captureVideo.md b/docs/en/2.2.0/cordova/media/capture/captureVideo.md new file mode 100644 index 0000000..052f3d6 --- /dev/null +++ b/docs/en/2.2.0/cordova/media/capture/captureVideo.md @@ -0,0 +1,159 @@ +--- +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 ) +- Bada 2.x + +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 +------------ + + + + + Capture Video + + + + + + +
+ + + +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. + +Bada 2.x Quirks +--------------- + +Bada supports _captureVideo_ just like the other platforms. However there is _another_ mode where you can capture a video or an image straight in the webview without launching any camera apps. In order to do that you need to: + +1. create a _<div>_ element somewhere in your document and give it an id (such as "preview"). + +
+ +2. Initialize the camera preview with the following method + + navigator.camera.showPreview("preview"); + +3. Once you get the preview you can + + 3.1 Start capturing a video with + + navigator.capture.startVideoCapture(success, fail, {duration: 5000, destinationFilename: "videos/a.3gp"}); + + 3.2 Stop the video capture with + + navigator.capture.stopVideoCapture(); + +3. Hide the camera preview with the following method + + navigator.camera.hidePreview("preview"); + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/media/capture/captureVideoOptions.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/media/capture/captureVideoOptions.md b/docs/en/2.2.0/cordova/media/capture/captureVideoOptions.md new file mode 100644 index 0000000..95711f1 --- /dev/null +++ b/docs/en/2.2.0/cordova/media/capture/captureVideoOptions.md @@ -0,0 +1,59 @@ +--- +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/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/media/media.getCurrentPosition.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/media/media.getCurrentPosition.md b/docs/en/2.2.0/cordova/media/media.getCurrentPosition.md new file mode 100644 index 0000000..c5a1e89 --- /dev/null +++ b/docs/en/2.2.0/cordova/media/media.getCurrentPosition.md @@ -0,0 +1,174 @@ +--- +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 ) +- Tizen + +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 +------------ + + + + + Media Example + + + + + + Play Audio + Pause Playing Audio + Stop Playing Audio +

+ + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/media/media.getDuration.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/media/media.getDuration.md b/docs/en/2.2.0/cordova/media/media.getDuration.md new file mode 100644 index 0000000..6b82130 --- /dev/null +++ b/docs/en/2.2.0/cordova/media/media.getDuration.md @@ -0,0 +1,166 @@ +--- +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 ) +- Tizen + +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 +------------ + + + + + Media Example + + + + + + Play Audio + Pause Playing Audio + Stop Playing Audio +

+ + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/media/media.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/media/media.md b/docs/en/2.2.0/cordova/media/media.md new file mode 100644 index 0000000..aec611e --- /dev/null +++ b/docs/en/2.2.0/cordova/media/media.md @@ -0,0 +1,142 @@ +--- +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)_ + +Constants +--------- + +The following constants are reported as the only parameter to the __mediaStatus__ callback function. + +- `Media.MEDIA_NONE` = 0; +- `Media.MEDIA_STARTING` = 1; +- `Media.MEDIA_RUNNING` = 2; +- `Media.MEDIA_PAUSED` = 3; +- `Media.MEDIA_STOPPED` = 4; + +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.5 +- Tizen + +Permissions +----------- + +### Android + +#### app/res/xml/config.xml + + + +#### app/AndroidManifest.xml + + + + + +### Bada + +#### manifest.xml + + + RECORDING + + +### BlackBerry WebWorks + +#### www/plugins.xml + + + +### iOS + +#### App/Supporting Files/Cordova.plist + + Plugins + + Media + CDVSound + + +### webOS + + No permissions are required. + +### Windows Phone + +#### Properties/WPAppManifest.xml + + + + + + + + + +Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx) + +### Tizen + + No permissions are required. + + +### Windows Phone Quirks + Only one media file can be played back at a time. + There are strict restrictions as to how your application interacts with other media. See http://msdn.microsoft.com/en-us/library/windowsphone/develop/hh184838(v=vs.92).aspx http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/media/media.pause.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/media/media.pause.md b/docs/en/2.2.0/cordova/media/media.pause.md new file mode 100644 index 0000000..822a961 --- /dev/null +++ b/docs/en/2.2.0/cordova/media/media.pause.md @@ -0,0 +1,171 @@ +--- +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 ) +- Tizen + +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 +------------ + + + + + Media Example + + + + + + Play Audio + Pause Playing Audio + Stop Playing Audio +

+ + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/media/media.play.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/media/media.play.md b/docs/en/2.2.0/cordova/media/media.play.md new file mode 100644 index 0000000..d5b9838 --- /dev/null +++ b/docs/en/2.2.0/cordova/media/media.play.md @@ -0,0 +1,189 @@ +--- +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 ) +- Tizen + +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 +------------ + + + + + Media Example + + + + + + Play Audio + Pause Playing Audio + Stop Playing Audio +

+ + + +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 }) + +- __playAudioWhenScreenIsLocked__ + + Pass in this option to the **play** method to specify whether you want to play the audio of the media file when the screen is locked (this defaults to true if not set). If this is set to true, it will ignore the state of the hardware mute button. e.g: + + var myMedia = new Media("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3") + myMedia.play({ playAudioWhenScreenIsLocked : false }) http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/media/media.release.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/media/media.release.md b/docs/en/2.2.0/cordova/media/media.release.md new file mode 100644 index 0000000..18ddf07 --- /dev/null +++ b/docs/en/2.2.0/cordova/media/media.release.md @@ -0,0 +1,155 @@ +--- +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 ) +- Tizen + +Quick Example +------------- + + // Audio player + // + var my_media = new Media(src, onSuccess, onError); + + my_media.play(); + my_media.stop(); + my_media.release(); + +Full Example +------------ + + + + + Media Example + + + + + + Play Audio + Pause Playing Audio + Stop Playing Audio +

+ + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/media/media.seekTo.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/media/media.seekTo.md b/docs/en/2.2.0/cordova/media/media.seekTo.md new file mode 100644 index 0000000..13d05cc --- /dev/null +++ b/docs/en/2.2.0/cordova/media/media.seekTo.md @@ -0,0 +1,158 @@ +--- +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 ) +- Tizen + +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 +------------ + + + + + Media Example + + + + + + Play Audio + Stop Playing Audio +

+ + + +BlackBerry WebWorks Quirks +---------- + +- This API is not supported on BlackBerry OS 5 devices. http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/media/media.startRecord.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/media/media.startRecord.md b/docs/en/2.2.0/cordova/media/media.startRecord.md new file mode 100644 index 0000000..4801884 --- /dev/null +++ b/docs/en/2.2.0/cordova/media/media.startRecord.md @@ -0,0 +1,151 @@ +--- +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 +------------ + + + + + Device Properties Example + + + + + +

Recording audio...

+

+ + + +Android Quirks +---------- + +- Android devices record audio in Adaptive Multi-Rate format. The specified file should end with a .amr extension. + +BlackBerry WebWorks Quirks +---------- + +- BlackBerry devices record audio in Adaptive Multi-Rate format. The specified file must end with a .amr extension. + +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. + +Tizen Quirks +---------- + +- This API is not supported on Tizen devices.