Skip to content
This repository has been archived by the owner on Jun 16, 2023. It is now read-only.

Commit

Permalink
docs(codec): document ios codec option
Browse files Browse the repository at this point in the history
  • Loading branch information
n1ru4l committed Mar 12, 2018
1 parent c0d5aab commit 2b9d8db
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions docs/RNCamera.md
Expand Up @@ -284,8 +284,13 @@ The promise will be fulfilled with an object with some of the following properti
- `ios` Specifies capture settings suitable for VGA quality (640x480 pixel) video output. (Same as RNCamera.Constants.VideoQuality.480p).
- `android` Quality level corresponding to the 480p (720 x 480) resolution but with video frame width set to 640.

If nothing is passed the device's highest camera quality will be used as default.

If nothing is passed the device's highest camera quality will be used as default.
- `iOS` `codec`. This option specifies the codec of the output video. Setting the codec is only supported on `iOS >= 10`. The possible values are:
- `RNCamera.Constants.VideoCodec['H264']`
- `RNCamera.Constants.VideoCodec['JPEG']`
- `RNCamera.Constants.VideoCodec['HVEC']` (`iOS >= 11`)
- `RNCamera.Constants.VideoCodec['AppleProRes422']` (`iOS >= 11`)
- `RNCamera.Constants.VideoCodec['AppleProRes4444']` (`iOS >= 11`)
- `maxDuration` (float greater than 0). Specifies the maximum duration of the video to be recorded in seconds. If nothing is specified, no time limit will be used.

- `maxFileSize` (int greater than 0). Specifies the maximum file size, in bytes, of the video to be recorded. For 1mb, for example, use 1*1024*1024. If nothing is specified, no size limit will be used.
Expand All @@ -296,6 +301,8 @@ The promise will be fulfilled with an object with some of the following properti

- `uri`: returns the path to the video saved on your app's cache directory.

- `iOS` `codec`: the codec of the recorded video. One of `RNCamera.Constants.VideoCodec`

#### `stopRecording: void`

Should be called after recordAsync() to make the promise be fulfilled and get the video uri.
Expand Down

0 comments on commit 2b9d8db

Please sign in to comment.