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/12/18 02:53:04 UTC
[2/2] git commit: CB-5658 Delete stale snapshot of plugin docs
CB-5658 Delete stale snapshot of plugin docs
Project: http://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture/commit/8af169f6
Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture/tree/8af169f6
Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture/diff/8af169f6
Branch: refs/heads/dev
Commit: 8af169f6df3f165a47674a87acb55474c4a51c62
Parents: 9f7a356
Author: Andrew Grieve <ag...@chromium.org>
Authored: Tue Dec 17 20:49:39 2013 -0500
Committer: Andrew Grieve <ag...@chromium.org>
Committed: Tue Dec 17 20:49:39 2013 -0500
----------------------------------------------------------------------
docs/MediaError/mediaError.md | 45 ------
docs/Parameters/mediaError.md | 33 -----
docs/capture/CaptureCB.md | 47 -------
docs/capture/CaptureError.md | 37 -----
docs/capture/CaptureErrorCB.md | 44 ------
docs/capture/ConfigurationData.md | 63 ---------
docs/capture/MediaFile.getFormatData.md | 64 ---------
docs/capture/MediaFile.md | 37 -----
docs/capture/MediaFileData.md | 65 ---------
docs/capture/capture.md | 133 ------------------
docs/capture/captureAudio.md | 152 --------------------
docs/capture/captureAudioOptions.md | 52 -------
docs/capture/captureImage.md | 168 ----------------------
docs/capture/captureImageOptions.md | 41 ------
docs/capture/captureVideo.md | 171 -----------------------
docs/capture/captureVideoOptions.md | 47 -------
docs/media.getCurrentPosition.md | 176 -----------------------
docs/media.getDuration.md | 167 ----------------------
docs/media.md | 145 -------------------
docs/media.pause.md | 167 ----------------------
docs/media.play.md | 200 ---------------------------
docs/media.release.md | 159 ---------------------
docs/media.seekTo.md | 161 ---------------------
docs/media.setVolume.md | 178 ------------------------
docs/media.startRecord.md | 155 ---------------------
docs/media.stop.md | 172 -----------------------
docs/media.stopRecord.md | 142 -------------------
27 files changed, 3021 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture/blob/8af169f6/docs/MediaError/mediaError.md
----------------------------------------------------------------------
diff --git a/docs/MediaError/mediaError.md b/docs/MediaError/mediaError.md
deleted file mode 100644
index 5652a27..0000000
--- a/docs/MediaError/mediaError.md
+++ /dev/null
@@ -1,45 +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.
----
-
-MediaError
-==========
-
-A `MediaError` object is returned to the `mediaError` callback
-function when an error occurs.
-
-Properties
-----------
-
-- __code__: One of the predefined error codes listed below.
-- __message__: An error message describing the details of the error.
-
-Constants
----------
-
-- `MediaError.MEDIA_ERR_ABORTED`
-- `MediaError.MEDIA_ERR_NETWORK`
-- `MediaError.MEDIA_ERR_DECODE`
-- `MediaError.MEDIA_ERR_NONE_SUPPORTED`
-
-Description
------------
-
-The `MediaError` object is passed to a `mediaError` callback function
-when an error occurs.
-
http://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture/blob/8af169f6/docs/Parameters/mediaError.md
----------------------------------------------------------------------
diff --git a/docs/Parameters/mediaError.md b/docs/Parameters/mediaError.md
deleted file mode 100644
index 08b4400..0000000
--- a/docs/Parameters/mediaError.md
+++ /dev/null
@@ -1,33 +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.
----
-
-mediaError
-==========
-
-A user-specified callback function that executes when there is an
-error in media functions.
-
- function(error) {
- // Handle the error
- }
-
-Parameters
-----------
-
-- __error__: The error returned by the device. _(MediaError)_
http://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture/blob/8af169f6/docs/capture/CaptureCB.md
----------------------------------------------------------------------
diff --git a/docs/capture/CaptureCB.md b/docs/capture/CaptureCB.md
deleted file mode 100644
index d1d7599..0000000
--- a/docs/capture/CaptureCB.md
+++ /dev/null
@@ -1,47 +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.
----
-
-CaptureCB
-=========
-
-> Invoked upon a successful media capture operation.
-
- function captureSuccess( MediaFile[] mediaFiles ) { ... };
-
-Description
------------
-
-This function executes after a successful capture operation completes.
-At this point a media file has been captured, and either the user has
-exited the media capture application, or the capture limit has been
-reached.
-
-Each `MediaFile` object describes a captured media file.
-
-Quick Example
--------------
-
- // capture callback
- function captureSuccess(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
- }
- };
http://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture/blob/8af169f6/docs/capture/CaptureError.md
----------------------------------------------------------------------
diff --git a/docs/capture/CaptureError.md b/docs/capture/CaptureError.md
deleted file mode 100644
index 0268f06..0000000
--- a/docs/capture/CaptureError.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.
----
-
-CaptureError
-============
-
-> Encapsulates the error code resulting from a failed media capture operation.
-
-Properties
-----------
-
-- __code__: One of the pre-defined error codes listed below.
-
-Constants
----------
-
-- `CaptureError.CAPTURE_INTERNAL_ERR`: The camera or microphone failed to capture image or sound.
-- `CaptureError.CAPTURE_APPLICATION_BUSY`: The camera or audio capture application is currently serving another capture request.
-- `CaptureError.CAPTURE_INVALID_ARGUMENT`: Invalid use of the API (e.g. the value of `limit` is less than one).
-- `CaptureError.CAPTURE_NO_MEDIA_FILES`: The user exits the camera or audio capture application before capturing anything.
-- `CaptureError.CAPTURE_NOT_SUPPORTED`: The requested capture operation is not supported.
http://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture/blob/8af169f6/docs/capture/CaptureErrorCB.md
----------------------------------------------------------------------
diff --git a/docs/capture/CaptureErrorCB.md b/docs/capture/CaptureErrorCB.md
deleted file mode 100644
index f3771e6..0000000
--- a/docs/capture/CaptureErrorCB.md
+++ /dev/null
@@ -1,44 +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.
----
-
-CaptureErrorCB
-==============
-
-> Invoked if an error occurs during a media capture operation.
-
- function captureError( CaptureError error ) { ... };
-
-Description
------------
-
-This function executes if an error occurs when trying to launch a
-media capture operation. Failure scenarios include when the capture
-application is busy, a capture operation is already taking place, or
-the user cancels the operation before any media files are captured.
-
-This function executes with a `CaptureError` object containing an
-appropriate error `code`.
-
-Quick Example
--------------
-
- // capture error callback
- var captureError = function(error) {
- navigator.notification.alert('Error code: ' + error.code, null, 'Capture Error');
- };
http://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture/blob/8af169f6/docs/capture/ConfigurationData.md
----------------------------------------------------------------------
diff --git a/docs/capture/ConfigurationData.md b/docs/capture/ConfigurationData.md
deleted file mode 100644
index 361f45a..0000000
--- a/docs/capture/ConfigurationData.md
+++ /dev/null
@@ -1,63 +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.
----
-
-ConfigurationData
-=================
-
-> Encapsulates a set of media capture parameters that a device supports.
-
-Description
------------
-
-Describes 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 lowercase string representing the media type. (DOMString)
-- __height__: The height of the image or video in pixels. The value is zero for sound clips. (Number)
-- __width__: The width of the image or video in pixels. The value is zero for sound clips. (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.
http://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture/blob/8af169f6/docs/capture/MediaFile.getFormatData.md
----------------------------------------------------------------------
diff --git a/docs/capture/MediaFile.getFormatData.md b/docs/capture/MediaFile.getFormatData.md
deleted file mode 100644
index e922329..0000000
--- a/docs/capture/MediaFile.getFormatData.md
+++ /dev/null
@@ -1,64 +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 invokes the `MediaFileDataErrorCB`
-callback.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Windows Phone 7 and 8
-- Windows 8
-
-BlackBerry WebWorks Quirks
---------------------------
-
-Does not provide an API for information about media files, so all
-`MediaFileData` objects return with default values.
-
-Android Quirks
---------------
-
-The API to access media file format information is limited, so not all
-`MediaFileData` properties are supported.
-
-iOS Quirks
-----------
-
-The API to access media file format information is limited, so not all
-`MediaFileData` properties are supported.
http://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture/blob/8af169f6/docs/capture/MediaFile.md
----------------------------------------------------------------------
diff --git a/docs/capture/MediaFile.md b/docs/capture/MediaFile.md
deleted file mode 100644
index 3bca7aa..0000000
--- a/docs/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 file's mime type (DOMString)
-- __lastModifiedDate__: The date and time when 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.
http://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture/blob/8af169f6/docs/capture/MediaFileData.md
----------------------------------------------------------------------
diff --git a/docs/capture/MediaFileData.md b/docs/capture/MediaFileData.md
deleted file mode 100644
index 545b549..0000000
--- a/docs/capture/MediaFileData.md
+++ /dev/null
@@ -1,65 +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. The value is zero for images. (Number)
-- __height__: The height of the image or video in pixels. The value is zero for audio clips. (Number)
-- __width__: The width of the image or video in pixels. The value is zero for audio clips. (Number)
-- __duration__: The length of the video or sound clip in seconds. The value is zero for images. (Number)
-
-BlackBerry WebWorks Quirks
---------------------------
-
-No API provides format information for media files, so the
-`MediaFileData` object returned by `MediaFile.getFormatData` features
-the following default values:
-
-- __codecs__: Not supported, and returns `null`.
-- __bitrate__: Not supported, and returns zero.
-- __height__: Not supported, and returns zero.
-- __width__: Not supported, and returns zero.
-- __duration__: Not supported, and returns zero.
-
-Android Quirks
---------------
-Supports the following `MediaFileData` properties:
-
-- __codecs__: Not supported, and returns `null`.
-- __bitrate__: Not supported, and returns zero.
-- __height__: Supported: image and video files only.
-- __width__: Supported: image and video files only.
-- __duration__: Supported: audio and video files only.
-
-iOS Quirks
-----------
-Supports the following `MediaFileData` properties:
-
-- __codecs__: Not supported, and returns null.
-- __bitrate__: Supported on iOS4 devices for audio only. Returns zero for images and videos.
-- __height__: Supported: image and video files only.
-- __width__: Supported: image and video files only.
-- __duration__: Supported: audio and video files only.
http://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture/blob/8af169f6/docs/capture/capture.md
----------------------------------------------------------------------
diff --git a/docs/capture/capture.md b/docs/capture/capture.md
deleted file mode 100644
index b503965..0000000
--- a/docs/capture/capture.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
-=======
-
-> Provides access to the device's audio, image, and video capture capabilities.
-
-**Important privacy note:** Collection and use of images, video, or audio from the device's camera or microphone raises important privacy issues. Your app's [privacy policy](guide_getting-started_index.md.html) should discuss how the app uses such sensors and whether the data recorded is shared with any other parties. In addition, if the app's use of the camera or microphone is not apparent in the user interface, you should provide a just-in-time notice prior to your app accessing the camera or microphone (if the device operating system doesn't do so already). That notice should provide the same information noted above, as well as obtaining the user's permission (e.g., by presenting choices for "OK" and "No Thanks"). Note that some app marketplaces may require your app to provide just-in-time notice and obtain permission from the user prior to accessing the camera or microphone. For more information, please see the Privacy Guide.
-
-Objects
--------
-
-- Capture
-- CaptureAudioOptions
-- CaptureImageOptions
-- CaptureVideoOptions
-- CaptureCallback
-- 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's audio recording application to record audio clips.
-- `capture.captureImage`: Launch the device's camera application to take photos.
-- `capture.captureVideo`: Launch the device's video recorder application to record videos.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Windows Phone 7 and 8
-- Windows 8
-
-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
-
-#### manifest.xml
-
- <Privilege>
- <Name>RECORDING</Name>
- </Privilege>
-
-### BlackBerry WebWorks
-
-#### www/plugins.xml
-
- <plugin name="Capture" value="org.apache.cordova.capture.MediaCapture" />
-
-#### www/config.xml
-
- <feature id="blackberry.system" required="true" version="1.0.0.0" />
- <feature id="blackberry.io.file" required="true" version="1.0.0.0" />
-
-### iOS
-
-#### config.xml
-
- <plugin name="Capture" value="CDVCapture" />
-
-### webOS
-
- No permissions are required.
-
-### 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>
http://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture/blob/8af169f6/docs/capture/captureAudio.md
----------------------------------------------------------------------
diff --git a/docs/capture/captureAudio.md b/docs/capture/captureAudio.md
deleted file mode 100644
index 30ad560..0000000
--- a/docs/capture/captureAudio.md
+++ /dev/null
@@ -1,152 +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 the captured audio clip file(s).
-
- navigator.device.capture.captureAudio(
- CaptureCB captureSuccess, CaptureErrorCB captureError, [CaptureAudioOptions options]
- );
-
-Description
------------
-
-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 `CaptureAudioOptions.limit` is reached. If no `limit` parameter
-value is specified, it defaults to one (1), and the capture operation
-terminates after the user records a single audio clip.
-
-When the capture operation finishes, the `CaptureCallback` executes
-with an array of `MediaFile` objects describing each captured audio
-clip file. If the user terminates the operation before an audio clip
-is captured, the `CaptureErrorCallback` executes with a `CaptureError`
-object, featuring the `CaptureError.CAPTURE_NO_MEDIA_FILES` error
-code.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Windows Phone 7 and 8
-- Windows 8
-
-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-x.x.x.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 audio recordings. The app receives 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 and 8 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-plugin-media-capture/blob/8af169f6/docs/capture/captureAudioOptions.md
----------------------------------------------------------------------
diff --git a/docs/capture/captureAudioOptions.md b/docs/capture/captureAudioOptions.md
deleted file mode 100644
index c7d7ac2..0000000
--- a/docs/capture/captureAudioOptions.md
+++ /dev/null
@@ -1,52 +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.
-
-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.
-
-BlackBerry WebWorks Quirks
---------------------------
-
-- The `duration` parameter is not supported. Recording lengths cannot be limited programmatically.
-
-iOS Quirks
-----------
-
-- The `limit` parameter is not supported, so only one recording can be created for each invocation.
http://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture/blob/8af169f6/docs/capture/captureImage.md
----------------------------------------------------------------------
diff --git a/docs/capture/captureImage.md b/docs/capture/captureImage.md
deleted file mode 100644
index dbd79ae..0000000
--- a/docs/capture/captureImage.md
+++ /dev/null
@@ -1,168 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-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
------------
-
-Starts an asynchronous operation to capture images using the device's
-camera application. The operation allows users to capture more than
-one image in a single session.
-
-The capture operation ends either when the user closes the camera
-application, or the maximum number of recordings specified by
-`CaptureAudioOptions.limit` is reached. If no `limit` value is
-specified, it defaults to one (1), and the capture operation
-terminates after the user captures a single image.
-
-When the capture operation finishes, it invokes the `CaptureCB`
-callback with an array of `MediaFile` objects describing each captured
-image file. If the user terminates the operation before capturing an
-image, the `CaptureErrorCB` callback executes with a `CaptureError`
-object featuring a `CaptureError.CAPTURE_NO_MEDIA_FILES` error code.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Windows Phone 7 and 8
-- Bada 2.x
-- Windows 8
-
-Windows Phone 7 Quirks
-----------------------
-
-Invoking the native camera application while your device is connected
-via Zune does not work, and the error callback executes.
-
-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-x.x.x.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>
-
-Bada Quirks
------------
-
-Bada supports `captureImage` just like the other platforms, but
-features _another_ mode allowing video or image capture straight into
-the WebView without launching any camera app. Here's how:
-
-1. Create an element with an `id` attribute somewhere in the HTML:
-
- <div id="preview"></div>
-
-2. Initialize the camera preview as follows:
-
- navigator.camera.showPreview("preview");
-
-3. Once you the preview displays, capture the image with code such as the following:
-
- var options = { destinationFilename: "images/cam01.jpg", highRes: false};
- navigator.capture.captureImage(success, fail, options);
-
-4. Dismiss the camera preview as follows:
-
- navigator.camera.hidePreview("preview");
-
http://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture/blob/8af169f6/docs/capture/captureImageOptions.md
----------------------------------------------------------------------
diff --git a/docs/capture/captureImageOptions.md b/docs/capture/captureImageOptions.md
deleted file mode 100644
index b751bd1..0000000
--- a/docs/capture/captureImageOptions.md
+++ /dev/null
@@ -1,41 +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 user can capture in a single capture operation. The value must be greater than or equal to 1 (defaults to 1).
-
-Quick Example
--------------
-
- // limit capture operation to 3 images
- var options = { limit: 3 };
-
- navigator.device.capture.captureImage(captureSuccess, captureError, options);
-
-iOS Quirks
-----------
-
-- The __limit__ parameter is not supported, and only one image is taken per invocation.
http://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture/blob/8af169f6/docs/capture/captureVideo.md
----------------------------------------------------------------------
diff --git a/docs/capture/captureVideo.md b/docs/capture/captureVideo.md
deleted file mode 100644
index 6e80b3a..0000000
--- a/docs/capture/captureVideo.md
+++ /dev/null
@@ -1,171 +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
------------
-
-Starts an asynchronous operation to capture video recordings using the
-device's video recording application. The operation allows the user
-to capture more than one 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 `CaptureVideoOptions.limit` is reached. If no `limit` parameter
-value is specified, it defaults to one (1), and the capture operation
-terminates after the user records a single video clip.
-
-When the capture operation finishes, it the `CaptureCB` callback
-executes with an array of `MediaFile` objects describing each captured
-video clip file. If the user terminates the operation before
-capturing a video clip, the `CaptureErrorCB` callback executes with a
-`CaptureError` object featuring a
-`CaptureError.CAPTURE_NO_MEDIA_FILES` error code.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Windows Phone 7 and 8
-- Bada 2.x
-- Windows 8
-
-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-x.x.x.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 video recordings. The app receives 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, but
-features _another_ mode allowing video or image capture straight into
-the WebView without launching any camera app. Here's how:
-
-1. Create an element with an `id` attribute somewhere in the HTML:
-
- <div id="preview"></div>
-
-2. Initialize the camera preview as follows:
-
- navigator.camera.showPreview("preview");
-
-3. Once the preview is available, use code such as this to start capturing a video:
-
- navigator.capture.startVideoCapture(success, fail, {duration: 5000, destinationFilename: "videos/a.3gp"});
-
-4. Use this to stop the video capture:
-
- navigator.capture.stopVideoCapture();
-
-5. Dismiss the camera preview as follows:
-
- navigator.camera.hidePreview("preview");
-
http://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture/blob/8af169f6/docs/capture/captureVideoOptions.md
----------------------------------------------------------------------
diff --git a/docs/capture/captureVideoOptions.md b/docs/capture/captureVideoOptions.md
deleted file mode 100644
index fd3b761..0000000
--- a/docs/capture/captureVideoOptions.md
+++ /dev/null
@@ -1,47 +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's 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.
-
-Quick Example
--------------
-
- // limit capture operation to 3 video clips
- var options = { limit: 3 };
-
- navigator.device.capture.captureVideo(captureSuccess, captureError, options);
-
-BlackBerry WebWorks Quirks
---------------------------
-
-- The __duration__ parameter is not supported, so the length of recordings cannot be limited programmatically.
-
-iOS Quirks
-----------
-
-- The __limit__ parameter is not supported. Only one video is recorded per invocation.
http://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture/blob/8af169f6/docs/media.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/docs/media.getCurrentPosition.md b/docs/media.getCurrentPosition.md
deleted file mode 100644
index 171bec6..0000000
--- a/docs/media.getCurrentPosition.md
+++ /dev/null
@@ -1,176 +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 passed the current position in seconds.
-- __mediaError__: (Optional) The callback to execute if an error occurs.
-
-Description
------------
-
-An asynchronous function that returns the current position of the
-underlying audio file of a `Media` object. Also updates the `Media`
-object's `position` parameter.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Windows Phone 7 and 8
-- Tizen
-- Windows 8
-
-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-x.x.x.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for device API libraries to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // device APIs are available
- //
- 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-plugin-media-capture/blob/8af169f6/docs/media.getDuration.md
----------------------------------------------------------------------
diff --git a/docs/media.getDuration.md b/docs/media.getDuration.md
deleted file mode 100644
index f48f9a0..0000000
--- a/docs/media.getDuration.md
+++ /dev/null
@@ -1,167 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-media.getDuration
-=================
-
-Returns the duration of an audio file.
-
- media.getDuration();
-
-Description
------------
-
-The `media.getDuration` method executes synchronously, returning the
-duration of the audio file in seconds, if known. If the duration is
-unknown, it returns a value of -1.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Windows Phone 7 and 8
-- Tizen
-- Windows 8
-
-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-x.x.x.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for device API libraries to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // device APIs are available
- //
- 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-plugin-media-capture/blob/8af169f6/docs/media.md
----------------------------------------------------------------------
diff --git a/docs/media.md b/docs/media.md
deleted file mode 100644
index 79d706b..0000000
--- a/docs/media.md
+++ /dev/null
@@ -1,145 +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 executes after a `Media` object has completed the current play, record, or stop action. _(Function)_
-- __mediaError__: (Optional) The callback that executes if an error occurs. _(Function)_
-- __mediaStatus__: (Optional) The callback that executes to indicate status changes. _(Function)_
-
-Constants
----------
-
-The following constants are reported as the only parameter to the
-`mediaStatus` callback:
-
-- `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 an audio file.
-- `media.pause`: Pause playback of an audio file.
-- `media.release`: Releases the underlying operating system's audio resources.
-- `media.seekTo`: Moves the position within the audio file.
-- `media.setVolume`: Set the volume for audio playback.
-- `media.startRecord`: Start recording an audio file.
-- `media.stopRecord`: Stop recording an audio file.
-- `media.stop`: Stop playing an 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
-- Windows 8
-
-Permissions
------------
-
-### Android
-
-#### app/res/xml/config.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
-
-#### manifest.xml
-
- <Privilege>
- <Name>RECORDING</Name>
- </Privilege>
-
-### BlackBerry WebWorks
-
-#### www/plugins.xml
-
- <plugin name="Capture" value="org.apache.cordova.media.MediaCapture" />
-
-### iOS
-
-#### config.xml
-
- <plugin name="Media" value="CDVSound" />
-
-### webOS
-
- No permissions are required.
-
-### 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)
-
-### Tizen
-
- No permissions are required.
-
-### Windows Phone Quirks
-
-- Only one media file can be played back at a time.
-- There are strict restrictions on how your application interacts with other media. See the [Microsoft documentation for details][url].
-
-[url]: http://msdn.microsoft.com/en-us/library/windowsphone/develop/hh184838(v=vs.92).aspx
http://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture/blob/8af169f6/docs/media.pause.md
----------------------------------------------------------------------
diff --git a/docs/media.pause.md b/docs/media.pause.md
deleted file mode 100644
index aa72280..0000000
--- a/docs/media.pause.md
+++ /dev/null
@@ -1,167 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-media.pause
-===========
-
-Pauses playing an audio file.
-
- media.pause();
-
-Description
------------
-
-The `media.pause` method executes synchronously, and pauses playing an audio file.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Windows Phone 7 and 8
-- Tizen
-- Windows 8
-
-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-x.x.x.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for device API libraries to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // device APIs are available
- //
- 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-plugin-media-capture/blob/8af169f6/docs/media.play.md
----------------------------------------------------------------------
diff --git a/docs/media.play.md b/docs/media.play.md
deleted file mode 100644
index 19899db..0000000
--- a/docs/media.play.md
+++ /dev/null
@@ -1,200 +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
------------
-
-The `media.play` method executes synchronously, and starts or resumes
-playing an audio file.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Windows Phone 7 and 8
-- Tizen
-- Windows 8
-
-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-x.x.x.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for device API libraries to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // device APIs are available
- //
- 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. An attempt to play
- more audio files than the supported amount results in previous
- playback being stopped.
-
-iOS Quirks
-----------
-
-- __numberOfLoops__: Pass 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 allow playback when the screen
- is locked. If set to `true` (the default value), the state of the
- hardware mute button is ignored, e.g.:
-
- var myMedia = new Media("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3")
- myMedia.play({ playAudioWhenScreenIsLocked : false })
-
-- __order of file search__: When only a file name or simple path is
- provided, iOS searches in the `www` directory for the file, then in
- the application's `documents/tmp` directory:
-
- var myMedia = new Media("audio/beer.mp3")
- myMedia.play() // first looks for file in www/audio/beer.mp3 then in <application>/documents/tmp/audio/beer.mp3
http://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture/blob/8af169f6/docs/media.release.md
----------------------------------------------------------------------
diff --git a/docs/media.release.md b/docs/media.release.md
deleted file mode 100644
index 5ce1c4a..0000000
--- a/docs/media.release.md
+++ /dev/null
@@ -1,159 +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 system's audio resources.
-
- media.release();
-
-Description
------------
-
-The `media.release` method executes synchronously, releasing the
-underlying operating system's audio resources. This is particularly
-important for Android, since there are a finite amount of OpenCore
-instances for media playback. Applications should call the `release`
-function for any `Media` resource that is no longer needed.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Windows Phone 7 and 8
-- Tizen
-- Windows 8
-
-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-x.x.x.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for device API libraries to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // device APIs are available
- //
- 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>