Updated Capture docs for iOS support.

macdonst · Jun 22, 2011 · 226978e · 226978e
1 parent 21f2071
commit 226978e
Show file tree

Hide file tree

Showing 10 changed files with 49 additions and 1 deletion.
diff --git a/docs/phonegap/media/capture/ConfigurationData.md b/docs/phonegap/media/capture/ConfigurationData.md
@@ -11,8 +11,10 @@ This object is used to describe media capture modes supported by the device.  Th
 The MIME types should adhere to [RFC2046](http://www.ietf.org/rfc/rfc2046.txt).  Examples:
 
 - video/3gpp
+- video/quicktime
 - image/jpeg
-- audio/amr 
+- audio/amr
+- audio/wav 
 
 Properties
 ----------
@@ -36,3 +38,6 @@ Quick Example
             selectedmode = mode;
         }
     }
+
+
+Not supported by any platform.  All configuration data arrays are empty.
diff --git a/docs/phonegap/media/capture/MediaFile.getFormatData.md b/docs/phonegap/media/capture/MediaFile.getFormatData.md
@@ -18,11 +18,16 @@ Supported Platforms
 
 - Android
 - BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
 
 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.
diff --git a/docs/phonegap/media/capture/MediaFileData.md b/docs/phonegap/media/capture/MediaFileData.md
@@ -30,4 +30,14 @@ Support for the MediaFileData properties is as follows:
 - __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).
diff --git a/docs/phonegap/media/capture/capture.md b/docs/phonegap/media/capture/capture.md
@@ -52,3 +52,4 @@ Supported Platforms
 
 - Android
 - BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
diff --git a/docs/phonegap/media/capture/captureAudio.md b/docs/phonegap/media/capture/captureAudio.md
@@ -21,6 +21,7 @@ Supported Platforms
 
 - Android
 - BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
 
 Quick Example
 -------------
@@ -107,3 +108,8 @@ BlackBerry WebWorks Quirks
 --------------------------
 
 - PhoneGap for BlackBerry WebWorks attempts to launch the __Voice Notes Recorder__ application, provided by RIM, to capture the audio recordings.  The developer will receive a CaptureError.`CAPTURE_NOT_SUPPORTED` error code if the application is not installed on the device.
+
+iOS Quirks
+----------
+
+- iOS does not have a default audio recording application so a simple user interface is provided.
diff --git a/docs/phonegap/media/capture/captureAudioOptions.md b/docs/phonegap/media/capture/captureAudioOptions.md
@@ -29,3 +29,9 @@ 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).
diff --git a/docs/phonegap/media/capture/captureImage.md b/docs/phonegap/media/capture/captureImage.md
@@ -21,6 +21,7 @@ Supported Platforms
 
 - Android
 - BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
 
 Quick Example
 -------------

diff --git a/docs/phonegap/media/capture/captureImageOptions.md b/docs/phonegap/media/capture/captureImageOptions.md
@@ -26,3 +26,9 @@ 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).
diff --git a/docs/phonegap/media/capture/captureVideo.md b/docs/phonegap/media/capture/captureVideo.md
@@ -21,6 +21,7 @@ Supported Platforms
 
 - Android
 - BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
 
 Quick Example
 -------------

diff --git a/docs/phonegap/media/capture/captureVideoOptions.md b/docs/phonegap/media/capture/captureVideoOptions.md
@@ -31,3 +31,10 @@ 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.
+