349 lines
50 KiB
HTML
349 lines
50 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Work in progress · React Native Camera</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<h2><a class="anchor" aria-hidden="true" id="props-index"></a><a href="#props-index" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Props Index</h2>
|
||
"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Work in progress · React Native Camera"/><meta property="og:type" content="website"/><meta property="og:url" content="undefined/react-native-camera/"/><meta property="og:description" content="<h2><a class="anchor" aria-hidden="true" id="props-index"></a><a href="#props-index" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Props Index</h2>
|
||
"/><meta property="og:image" content="undefined/react-native-camera/img/undraw_online.svg"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="undefined/react-native-camera/img/undraw_tweetstorm.svg"/><link rel="shortcut icon" href="/react-native-camera/img/community.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css"/><link rel="stylesheet" href="/css/code-block-buttons.css"/><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-blocks-buttons.js"></script><script src="/react-native-camera/js/scrollSpy.js"></script><link rel="stylesheet" href="/react-native-camera/css/prism.css"/><link rel="stylesheet" href="/react-native-camera/css/main.css"/><script src="/react-native-camera/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/react-native-camera/"><img class="logo" src="/react-native-camera/img/community.png" alt="React Native Camera"/><h2 class="headerTitleWithLogo">React Native Camera</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class="siteNavGroupActive"><a href="/react-native-camera/docs/installation" target="_self">Docs</a></li><li class="siteNavGroupActive"><a href="/react-native-camera/docs/expo_usage" target="_self">Guides</a></li><li class="siteNavGroupActive siteNavItemActive"><a href="/react-native-camera/docs/api" target="_self">API</a></li><li class=""><a href="/react-native-camera/docs/qa" target="_self">Help</a></li><li class="siteNavGroupActive"><a href="/react-native-camera/docs/Tidelift" target="_self">For Enterprise</a></li><li class=""><a href="https://github.com/react-native-community/react-native-camera" target="_self">GitHub</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container docsNavContainer" id="docsNav"><nav class="toc"><div class="toggleNav"><section class="navWrapper wrapper"><div class="navBreadcrumb wrapper"><div class="navToggle" id="navToggler"><div class="hamburger-menu"><div class="line1"></div><div class="line2"></div><div class="line3"></div></div></div><h2><i>›</i><span>API</span></h2><div class="tocToggler" id="tocToggler"><i class="icon-toc"></i></div></div><div class="navGroups"><div class="navGroup"><h3 class="navGroupCategoryTitle">Getting Started</h3><ul class=""><li class="navListItem"><a class="navItem" href="/react-native-camera/docs/installation">Installation</a></li><li class="navListItem"><a class="navItem" href="/react-native-camera/docs/contributing">Contributing</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Guides</h3><ul class=""><li class="navListItem"><a class="navItem" href="/react-native-camera/docs/expo_usage">Expo Usage</a></li><li class="navListItem"><a class="navItem" href="/react-native-camera/docs/GradleUpgradeGuide">Gradle Upgrade Guide</a></li><li class="navListItem"><a class="navItem" href="/react-native-camera/docs/migration">Migrating from RCTCamera to RNCamera</a></li><li class="navListItem"><a class="navItem" href="/react-native-camera/docs/migrationv2">Migrating from version 1.x to 2.x</a></li><li class="navListItem"><a class="navItem" href="/react-native-camera/docs/react-navigation">React Navigation</a></li><li class="navListItem"><a class="navItem" href="/react-native-camera/docs/recipes">Recipes</a></li><li class="navListItem"><a class="navItem" href="/react-native-camera/docs/rncamera">RNCamera</a></li><li class="navListItem"><a class="navItem" href="/react-native-camera/docs/tests">Testing</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">API</h3><ul class=""><li class="navListItem navListItemActive"><a class="navItem" href="/react-native-camera/docs/api">Work in progress</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Help</h3><ul class=""><li class="navListItem"><a class="navItem" href="/react-native-camera/docs/qa">Q & A</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Enterprise</h3><ul class=""><li class="navListItem"><a class="navItem" href="/react-native-camera/docs/Tidelift">React-Native-Camera for Enterprise</a></li></ul></div></div></section></div><script>
|
||
var coll = document.getElementsByClassName('collapsible');
|
||
var checkActiveCategory = true;
|
||
for (var i = 0; i < coll.length; i++) {
|
||
var links = coll[i].nextElementSibling.getElementsByTagName('*');
|
||
if (checkActiveCategory){
|
||
for (var j = 0; j < links.length; j++) {
|
||
if (links[j].classList.contains('navListItemActive')){
|
||
coll[i].nextElementSibling.classList.toggle('hide');
|
||
coll[i].childNodes[1].classList.toggle('rotate');
|
||
checkActiveCategory = false;
|
||
break;
|
||
}
|
||
}
|
||
}
|
||
|
||
coll[i].addEventListener('click', function() {
|
||
var arrow = this.childNodes[1];
|
||
arrow.classList.toggle('rotate');
|
||
var content = this.nextElementSibling;
|
||
content.classList.toggle('hide');
|
||
});
|
||
}
|
||
|
||
document.addEventListener('DOMContentLoaded', function() {
|
||
createToggler('#navToggler', '#docsNav', 'docsSliderActive');
|
||
createToggler('#tocToggler', 'body', 'tocActive');
|
||
|
||
var headings = document.querySelector('.toc-headings');
|
||
headings && headings.addEventListener('click', function(event) {
|
||
var el = event.target;
|
||
while(el !== headings){
|
||
if (el.tagName === 'A') {
|
||
document.body.classList.remove('tocActive');
|
||
break;
|
||
} else{
|
||
el = el.parentNode;
|
||
}
|
||
}
|
||
}, false);
|
||
|
||
function createToggler(togglerSelector, targetSelector, className) {
|
||
var toggler = document.querySelector(togglerSelector);
|
||
var target = document.querySelector(targetSelector);
|
||
|
||
if (!toggler) {
|
||
return;
|
||
}
|
||
|
||
toggler.onclick = function(event) {
|
||
event.preventDefault();
|
||
|
||
target.classList.toggle(className);
|
||
};
|
||
}
|
||
});
|
||
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/react-native-community/react-native-camera/master/docs/API.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Work in progress</h1></header><article><div><span><h2><a class="anchor" aria-hidden="true" id="props-index"></a><a href="#props-index" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Props Index</h2>
|
||
<p>[<strong>wip</strong>]</p>
|
||
<ul>
|
||
<li><a href="/react-native-camera/docs/api#zoom"><code>zoom</code></a></li>
|
||
<li><a href="/react-native-camera/docs/api#maxzoom"><code>maxZoom</code></a></li>
|
||
<li><a href="/react-native-camera/docs/api#type"><code>type</code></a></li>
|
||
<li><a href="/react-native-camera/docs/api#cameraid"><code>cameraId</code></a></li>
|
||
<li><a href="/react-native-camera/docs/api#flashmode"><code>flashMode</code></a></li>
|
||
<li><a href="/react-native-camera/docs/api#exposure"><code>exposure</code></a></li>
|
||
<li><a href="/react-native-camera/docs/api#whiteBalance"><code>whiteBalance</code></a></li>
|
||
<li><a href="/react-native-camera/docs/api#autoFocus"><code>autoFocus</code></a></li>
|
||
<li><a href="/react-native-camera/docs/api#ratio"><code>ratio</code></a></li>
|
||
<li><a href="/react-native-camera/docs/api#focusDepth"><code>focusDepth</code></a></li>
|
||
<li><a href="/react-native-camera/docs/api#onMountError"><code>onMountError</code></a></li>
|
||
<li><a href="/react-native-camera/docs/api#onCameraReady"><code>onCameraReady</code></a></li>
|
||
</ul>
|
||
<h2><a class="anchor" aria-hidden="true" id="methods-index"></a><a href="#methods-index" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Methods Index</h2>
|
||
<ul>
|
||
<li><a href="/react-native-camera/docs/api#takepictureasync"><code>takePictureAsync</code></a></li>
|
||
<li><a href="/react-native-camera/docs/api#recordasync"><code>recordAsync</code></a></li>
|
||
<li><a href="/react-native-camera/docs/api#refreshauthorizationstatus"><code>refreshAuthorizationStatus</code></a></li>
|
||
<li><a href="/react-native-camera/docs/api#stoprecording"><code>stopRecording</code></a></li>
|
||
<li><a href="/react-native-camera/docs/api#pausepreview"><code>pausePreview</code></a></li>
|
||
<li><a href="/react-native-camera/docs/api#resumepreview"><code>resumePreview</code></a></li>
|
||
<li><a href="/react-native-camera/docs/api#getavailablepicturesizes"><code>getAvailablePictureSizes</code></a></li>
|
||
<li><a href="/react-native-camera/docs/api#getsupportedratiosasync-android-only"><code>getSupportedRatiosAsync</code></a></li>
|
||
<li><a href="/react-native-camera/docs/api#isrecording-ios-only"><code>isRecording</code></a></li>
|
||
<li><a href="/react-native-camera/docs/api#getsupportedpreviewfpsrange-android-only"><code>getSupportedPreviewFpsRange</code></a></li>
|
||
</ul>
|
||
<h2><a class="anchor" aria-hidden="true" id="props"></a><a href="#props" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Props</h2>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="zoom"></a><a href="#zoom" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>zoom</code></h3>
|
||
<p>This property specifies the zoom value of the camera. Ranges from 0 to 1. Default to 0.</p>
|
||
<table>
|
||
<thead>
|
||
<tr><th>Type</th><th>Default Value</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td>number</td><td>0</td></tr>
|
||
</tbody>
|
||
</table>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="maxzoom"></a><a href="#maxzoom" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>maxZoom</code></h3>
|
||
<p>The maximum zoom value of the camera. Defaults to 0.</p>
|
||
<table>
|
||
<thead>
|
||
<tr><th>Type</th><th>Default Value</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td>number</td><td>0</td></tr>
|
||
</tbody>
|
||
</table>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="type"></a><a href="#type" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>type</code></h3>
|
||
<p>This property defines which camera on the phone the component is using.
|
||
Possible values:</p>
|
||
<ul>
|
||
<li><code>front</code></li>
|
||
<li><code>back</code></li>
|
||
</ul>
|
||
<table>
|
||
<thead>
|
||
<tr><th>Type</th><th>Default Value</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td>number</td><td>'back'</td></tr>
|
||
</tbody>
|
||
</table>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="cameraid"></a><a href="#cameraid" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>cameraId</code></h3>
|
||
<p>For selecting from multiple cameras on Android devices. See <a href="https://github.com/react-native-community/react-native-camera/pull/2492">2492</a> for more info. Can be retrieved with <code>getCameraIds()</code></p>
|
||
<table>
|
||
<thead>
|
||
<tr><th>Type</th><th>Default Value</th><th>Platform</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td>String</td><td><code>null</code></td><td>Android</td></tr>
|
||
</tbody>
|
||
</table>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="flashmode"></a><a href="#flashmode" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>flashMode</code></h3>
|
||
<p>Determines the state of the camera flash. Has the following possible states.</p>
|
||
<pre><code class="hljs css language-off: '1',"><span class="hljs-string">on:</span> <span class="hljs-string">'auto'</span>,
|
||
<span class="hljs-string">auto:</span> <span class="hljs-string">'torch'</span>,
|
||
<span class="hljs-string">torch:</span> <span class="hljs-string">'off'</span>
|
||
</code></pre>
|
||
<table>
|
||
<thead>
|
||
<tr><th>Type</th><th>Default Value</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td>object</td><td><code>{ off: 1 }</code></td></tr>
|
||
</tbody>
|
||
</table>
|
||
<h2><a class="anchor" aria-hidden="true" id="methods"></a><a href="#methods" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Methods</h2>
|
||
<h2><a class="anchor" aria-hidden="true" id="takepictureasync"></a><a href="#takepictureasync" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>takePictureAsync()</h2>
|
||
<p>Returns a promise with TakePictureResponse.</p>
|
||
<h3><a class="anchor" aria-hidden="true" id="method-type"></a><a href="#method-type" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Method type</h3>
|
||
<pre><code class="hljs css language-ts">takePictureAsync(options?: TakePictureOptions): <span class="hljs-built_in">Promise</span><TakePictureResponse>;
|
||
</code></pre>
|
||
<pre><code class="hljs css language-ts"><span class="hljs-keyword">interface</span> TakePictureOptions {
|
||
quality?: <span class="hljs-built_in">number</span>;
|
||
orientation?: keyof Orientation | OrientationNumber;
|
||
base64?: <span class="hljs-built_in">boolean</span>;
|
||
exif?: <span class="hljs-built_in">boolean</span>;
|
||
width?: <span class="hljs-built_in">number</span>;
|
||
mirrorImage?: <span class="hljs-built_in">boolean</span>;
|
||
doNotSave?: <span class="hljs-built_in">boolean</span>;
|
||
pauseAfterCapture?: <span class="hljs-built_in">boolean</span>;
|
||
writeExif?: <span class="hljs-built_in">boolean</span> | { [name: <span class="hljs-built_in">string</span>]: <span class="hljs-built_in">any</span> };
|
||
|
||
<span class="hljs-comment">/** Android only */</span>
|
||
fixOrientation?: <span class="hljs-built_in">boolean</span>;
|
||
|
||
<span class="hljs-comment">/** iOS only */</span>
|
||
forceUpOrientation?: <span class="hljs-built_in">boolean</span>;
|
||
}
|
||
|
||
<span class="hljs-keyword">interface</span> TakePictureResponse {
|
||
width: <span class="hljs-built_in">number</span>;
|
||
height: <span class="hljs-built_in">number</span>;
|
||
uri: <span class="hljs-built_in">string</span>;
|
||
base64?: <span class="hljs-built_in">string</span>;
|
||
exif?: { [name: <span class="hljs-built_in">string</span>]: <span class="hljs-built_in">any</span> };
|
||
pictureOrientation: <span class="hljs-built_in">number</span>;
|
||
deviceOrientation: <span class="hljs-built_in">number</span>;
|
||
}
|
||
</code></pre>
|
||
<h3><a class="anchor" aria-hidden="true" id="usage-example"></a><a href="#usage-example" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Usage example</h3>
|
||
<pre><code class="hljs css language-js">takePicture = <span class="hljs-keyword">async</span> () => {
|
||
<span class="hljs-keyword">if</span> (<span class="hljs-keyword">this</span>.camera) {
|
||
<span class="hljs-keyword">const</span> data = <span class="hljs-keyword">await</span> <span class="hljs-keyword">this</span>.camera.takePictureAsync();
|
||
<span class="hljs-built_in">console</span>.warn(<span class="hljs-string">'takePictureResponse '</span>, data);
|
||
}
|
||
};
|
||
</code></pre>
|
||
<hr>
|
||
<h2><a class="anchor" aria-hidden="true" id="recordasync"></a><a href="#recordasync" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>recordAsync()</h2>
|
||
<p>Returns a promise with RecordResponse.</p>
|
||
<h3><a class="anchor" aria-hidden="true" id="method-type-1"></a><a href="#method-type-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Method type</h3>
|
||
<pre><code class="hljs css language-ts">recordAsync(options?: RecordOptions): <span class="hljs-built_in">Promise</span><RecordResponse>;
|
||
</code></pre>
|
||
<pre><code class="hljs css language-ts"><span class="hljs-keyword">interface</span> RecordOptions {
|
||
quality?: keyof VideoQuality;
|
||
orientation?: keyof Orientation | OrientationNumber;
|
||
maxDuration?: <span class="hljs-built_in">number</span>;
|
||
maxFileSize?: <span class="hljs-built_in">number</span>;
|
||
mute?: <span class="hljs-built_in">boolean</span>;
|
||
mirrorVideo?: <span class="hljs-built_in">boolean</span>;
|
||
path?: <span class="hljs-built_in">string</span>;
|
||
videoBitrate?: <span class="hljs-built_in">number</span>;
|
||
fps?: <span class="hljs-built_in">number</span>;
|
||
|
||
<span class="hljs-comment">/** iOS only */</span>
|
||
codec?: keyof VideoCodec | VideoCodec[keyof VideoCodec];
|
||
}
|
||
|
||
<span class="hljs-keyword">interface</span> RecordResponse {
|
||
<span class="hljs-comment">/** Path to the video saved on your app's cache directory. */</span>
|
||
uri: <span class="hljs-built_in">string</span>;
|
||
videoOrientation: <span class="hljs-built_in">number</span>;
|
||
deviceOrientation: <span class="hljs-built_in">number</span>;
|
||
isRecordingInterrupted: <span class="hljs-built_in">boolean</span>;
|
||
<span class="hljs-comment">/** iOS only */</span>
|
||
codec: VideoCodec[keyof VideoCodec];
|
||
}
|
||
</code></pre>
|
||
<h3><a class="anchor" aria-hidden="true" id="usage-example-1"></a><a href="#usage-example-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Usage example</h3>
|
||
<pre><code class="hljs css language-js">takeVideo = <span class="hljs-keyword">async</span> () => {
|
||
<span class="hljs-keyword">if</span> (<span class="hljs-keyword">this</span>.camera) {
|
||
<span class="hljs-keyword">try</span> {
|
||
<span class="hljs-keyword">const</span> promise = <span class="hljs-keyword">this</span>.camera.recordAsync(<span class="hljs-keyword">this</span>.state.recordOptions);
|
||
|
||
<span class="hljs-keyword">if</span> (promise) {
|
||
<span class="hljs-keyword">this</span>.setState({ <span class="hljs-attr">isRecording</span>: <span class="hljs-literal">true</span> });
|
||
<span class="hljs-keyword">const</span> data = <span class="hljs-keyword">await</span> promise;
|
||
<span class="hljs-keyword">this</span>.setState({ <span class="hljs-attr">isRecording</span>: <span class="hljs-literal">false</span> });
|
||
<span class="hljs-built_in">console</span>.warn(<span class="hljs-string">'takeVideo'</span>, data);
|
||
}
|
||
} <span class="hljs-keyword">catch</span> (e) {
|
||
<span class="hljs-built_in">console</span>.error(e);
|
||
}
|
||
}
|
||
};
|
||
</code></pre>
|
||
<hr>
|
||
<h2><a class="anchor" aria-hidden="true" id="refreshauthorizationstatus"></a><a href="#refreshauthorizationstatus" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>refreshAuthorizationStatus()</h2>
|
||
<p>Allows to make RNCamera check Permissions again and set status accordingly.
|
||
Making it possible to refresh status of RNCamera after user initially rejected the permissions.</p>
|
||
<h3><a class="anchor" aria-hidden="true" id="method-type-2"></a><a href="#method-type-2" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Method type</h3>
|
||
<pre><code class="hljs css language-ts">refreshAuthorizationStatus(): <span class="hljs-built_in">Promise</span><<span class="hljs-built_in">void</span>>;
|
||
</code></pre>
|
||
<h3><a class="anchor" aria-hidden="true" id="usage-example-2"></a><a href="#usage-example-2" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Usage example</h3>
|
||
<pre><code class="hljs css language-js"><span class="hljs-comment">/* -> {
|
||
|
||
} */</span>
|
||
</code></pre>
|
||
<hr>
|
||
<h2><a class="anchor" aria-hidden="true" id="stoprecording"></a><a href="#stoprecording" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>stopRecording()</h2>
|
||
<p>Should be called after recordAsync() to make the promise be fulfilled and get the video uri.</p>
|
||
<h3><a class="anchor" aria-hidden="true" id="method-type-3"></a><a href="#method-type-3" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Method type</h3>
|
||
<pre><code class="hljs css language-ts">stopRecording(): <span class="hljs-built_in">void</span>;
|
||
</code></pre>
|
||
<h3><a class="anchor" aria-hidden="true" id="usage-example-3"></a><a href="#usage-example-3" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Usage example</h3>
|
||
<pre><code class="hljs css language-js">stopRecording(): <span class="hljs-keyword">void</span>;
|
||
<span class="hljs-comment">/* -> {
|
||
|
||
} */</span>
|
||
</code></pre>
|
||
<hr>
|
||
<h2><a class="anchor" aria-hidden="true" id="pausepreview"></a><a href="#pausepreview" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>pausePreview()</h2>
|
||
<p>Pauses the preview. The preview can be resumed again by using resumePreview().</p>
|
||
<h3><a class="anchor" aria-hidden="true" id="method-type-4"></a><a href="#method-type-4" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Method type</h3>
|
||
<pre><code class="hljs css language-ts">pausePreview(): <span class="hljs-built_in">void</span>;
|
||
</code></pre>
|
||
<h3><a class="anchor" aria-hidden="true" id="usage-example-4"></a><a href="#usage-example-4" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Usage example</h3>
|
||
<pre><code class="hljs css language-js"><span class="hljs-comment">/* -> {
|
||
|
||
} */</span>
|
||
</code></pre>
|
||
<hr>
|
||
<h2><a class="anchor" aria-hidden="true" id="resumepreview"></a><a href="#resumepreview" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>resumePreview()</h2>
|
||
<p>Resumes the preview after pausePreview() has been called.</p>
|
||
<h3><a class="anchor" aria-hidden="true" id="method-type-5"></a><a href="#method-type-5" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Method type</h3>
|
||
<pre><code class="hljs css language-ts">resumePreview(): <span class="hljs-built_in">void</span>;
|
||
</code></pre>
|
||
<h3><a class="anchor" aria-hidden="true" id="usage-example-5"></a><a href="#usage-example-5" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Usage example</h3>
|
||
<pre><code class="hljs css language-js"><span class="hljs-comment">/* -> {
|
||
|
||
} */</span>
|
||
</code></pre>
|
||
<hr>
|
||
<h2><a class="anchor" aria-hidden="true" id="getavailablepicturesizes"></a><a href="#getavailablepicturesizes" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>getAvailablePictureSizes()</h2>
|
||
<p>Returns a promise with getAvailablePictureSizes.</p>
|
||
<h3><a class="anchor" aria-hidden="true" id="method-type-6"></a><a href="#method-type-6" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Method type</h3>
|
||
<pre><code class="hljs css language-ts">getAvailablePictureSizes(): <span class="hljs-built_in">Promise</span><<span class="hljs-built_in">string</span>[]>;
|
||
|
||
</code></pre>
|
||
<h3><a class="anchor" aria-hidden="true" id="usage-example-6"></a><a href="#usage-example-6" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Usage example</h3>
|
||
<pre><code class="hljs css language-js"><span class="hljs-comment">/* -> {
|
||
|
||
} */</span>
|
||
</code></pre>
|
||
<hr>
|
||
<h2><a class="anchor" aria-hidden="true" id="getsupportedratiosasync-android-only"></a><a href="#getsupportedratiosasync-android-only" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>getSupportedRatiosAsync() - Android only</h2>
|
||
<p>Android only. Returns a promise. The promise will be fulfilled with an object with an array containing strings with all camera aspect ratios supported by the device.</p>
|
||
<h3><a class="anchor" aria-hidden="true" id="method-type-7"></a><a href="#method-type-7" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Method type</h3>
|
||
<pre><code class="hljs css language-ts">getSupportedRatiosAsync(): <span class="hljs-built_in">Promise</span><<span class="hljs-built_in">string</span>[]>;
|
||
</code></pre>
|
||
<h3><a class="anchor" aria-hidden="true" id="usage-example-7"></a><a href="#usage-example-7" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Usage example</h3>
|
||
<pre><code class="hljs css language-js"><span class="hljs-comment">/* -> {
|
||
|
||
} */</span>
|
||
</code></pre>
|
||
<hr>
|
||
<h2><a class="anchor" aria-hidden="true" id="isrecording-ios-only"></a><a href="#isrecording-ios-only" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>isRecording() - iOS only</h2>
|
||
<p>iOS only. Returns a promise. The promise will be fulfilled with a boolean indicating if currently recording is started or stopped.</p>
|
||
<h3><a class="anchor" aria-hidden="true" id="method-type-8"></a><a href="#method-type-8" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Method type</h3>
|
||
<pre><code class="hljs css language-ts">isRecording(): <span class="hljs-built_in">Promise</span><<span class="hljs-built_in">boolean</span>>;
|
||
|
||
</code></pre>
|
||
<h3><a class="anchor" aria-hidden="true" id="usage-example-8"></a><a href="#usage-example-8" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Usage example</h3>
|
||
<pre><code class="hljs css language-js"><span class="hljs-keyword">const</span> isRecording = <span class="hljs-keyword">await</span> isRecording();
|
||
<span class="hljs-comment">/* -> {
|
||
isRecording = true
|
||
} */</span>
|
||
</code></pre>
|
||
<ul>
|
||
<li><a href="/react-native-camera/docs/api#getSupportedPreviewFpsRange`"><code>getSupportedPreviewFpsRange</code></a></li>
|
||
</ul>
|
||
<h2><a class="anchor" aria-hidden="true" id="getsupportedpreviewfpsrange-android-only"></a><a href="#getsupportedpreviewfpsrange-android-only" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>getSupportedPreviewFpsRange - Android only</h2>
|
||
<p>Android only. Returns a promise. The promise will be fulfilled with a json object including the fps ranges available for those devices (<a href="https://developer.android.com/reference/android/hardware/Camera.Parameters#getSupportedPreviewFpsRange()">android docs</a>)</p>
|
||
<h3><a class="anchor" aria-hidden="true" id="method-type-9"></a><a href="#method-type-9" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Method type</h3>
|
||
<pre><code class="hljs css language-ts">getSupportedPreviewFpsRange(): <span class="hljs-built_in">Promise</span><[{MINIMUM_FPS: <span class="hljs-built_in">string</span>, MAXIMUM_FPS: <span class="hljs-built_in">string</span>}]>;
|
||
|
||
</code></pre>
|
||
<h3><a class="anchor" aria-hidden="true" id="usage-example-9"></a><a href="#usage-example-9" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Usage example</h3>
|
||
<pre><code class="hljs css language-js"><span class="hljs-keyword">const</span> previewRange = <span class="hljs-keyword">await</span> <span class="hljs-keyword">this</span>.camera.getSupportedPreviewFpsRange();
|
||
<span class="hljs-comment">/* -> [
|
||
{
|
||
MINIMUM_FPS: "15000",
|
||
MAXIMUM_FPS: "15000"
|
||
},
|
||
{
|
||
MINIMUM_FPS: "20000",
|
||
MAXIMUM_FPS: "20000"
|
||
}
|
||
] */</span>
|
||
</code></pre>
|
||
<hr>
|
||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 6/10/2020 by luism3861</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/react-native-camera/docs/tests"><span class="arrow-prev">← </span><span>Testing</span></a><a class="docs-next button" href="/react-native-camera/docs/qa"><span>Q & A</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#props-index">Props Index</a></li><li><a href="#methods-index">Methods Index</a></li><li><a href="#props">Props</a><ul class="toc-headings"><li><a href="#zoom"><code>zoom</code></a></li><li><a href="#maxzoom"><code>maxZoom</code></a></li><li><a href="#type"><code>type</code></a></li><li><a href="#cameraid"><code>cameraId</code></a></li><li><a href="#flashmode"><code>flashMode</code></a></li></ul></li><li><a href="#methods">Methods</a></li><li><a href="#takepictureasync">takePictureAsync()</a><ul class="toc-headings"><li><a href="#method-type">Method type</a></li><li><a href="#usage-example">Usage example</a></li></ul></li><li><a href="#recordasync">recordAsync()</a><ul class="toc-headings"><li><a href="#method-type-1">Method type</a></li><li><a href="#usage-example-1">Usage example</a></li></ul></li><li><a href="#refreshauthorizationstatus">refreshAuthorizationStatus()</a><ul class="toc-headings"><li><a href="#method-type-2">Method type</a></li><li><a href="#usage-example-2">Usage example</a></li></ul></li><li><a href="#stoprecording">stopRecording()</a><ul class="toc-headings"><li><a href="#method-type-3">Method type</a></li><li><a href="#usage-example-3">Usage example</a></li></ul></li><li><a href="#pausepreview">pausePreview()</a><ul class="toc-headings"><li><a href="#method-type-4">Method type</a></li><li><a href="#usage-example-4">Usage example</a></li></ul></li><li><a href="#resumepreview">resumePreview()</a><ul class="toc-headings"><li><a href="#method-type-5">Method type</a></li><li><a href="#usage-example-5">Usage example</a></li></ul></li><li><a href="#getavailablepicturesizes">getAvailablePictureSizes()</a><ul class="toc-headings"><li><a href="#method-type-6">Method type</a></li><li><a href="#usage-example-6">Usage example</a></li></ul></li><li><a href="#getsupportedratiosasync-android-only">getSupportedRatiosAsync() - Android only</a><ul class="toc-headings"><li><a href="#method-type-7">Method type</a></li><li><a href="#usage-example-7">Usage example</a></li></ul></li><li><a href="#isrecording-ios-only">isRecording() - iOS only</a><ul class="toc-headings"><li><a href="#method-type-8">Method type</a></li><li><a href="#usage-example-8">Usage example</a></li></ul></li><li><a href="#getsupportedpreviewfpsrange-android-only">getSupportedPreviewFpsRange - Android only</a><ul class="toc-headings"><li><a href="#method-type-9">Method type</a></li><li><a href="#usage-example-9">Usage example</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/react-native-camera/" class="nav-home"><img src="/react-native-camera/img/community.png" alt="React Native Camera" width="66" height="58"/></a><div><h5>Docs</h5><a href="/react-native-camera/docs/en/installation.html">Getting Started</a><a href="/react-native-camera/docs/en/expo_usage.html">Guides</a><a href="/react-native-camera/docs/en/api.html">API Reference</a></div><div><h5>Community</h5><a href="/react-native-camera/en/users.html">User Showcase</a><a href="https://stackoverflow.com/questions/tagged/react-native-camera" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://spectrum.chat/">Project Chat</a></div><div><h5>More</h5><a href="https://github.com/react-native-community/react-native-camera">GitHub</a><a class="github-button" href="https://github.com/react-native-community/react-native-camera" data-icon="octicon-star" data-count-href="/facebook/docusaurus/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Stars</a></div></section><a href="https://opensource.facebook.com/" target="_blank" rel="noreferrer noopener" class="fbOpenSource"><img src="/react-native-camera/img/oss_logo.png" alt="Facebook Open Source" width="170" height="45"/></a><section class="copyright">Copyright © 2020</section></footer></div></body></html> |