docs: Fix Frame Processor install step and QualityPrioritization Order (#451)
* fix: switched incorrect property ordering for qualityPrioritization options fix: added extra step required for create frame processing plugin on Android * fix: adjusted the highlighted line * chore: added guidelines on how to generate and check docs updares * chore: change instructions so they aren't so unnecessarily wordy! :P
This commit is contained in:
parent
be3312e47d
commit
ef40b1db23
@ -43,6 +43,13 @@ Read the READMEs in [`android/`](android/README.md) and [`ios/`](ios/README.md)
|
|||||||
|
|
||||||
> Run `yarn check-android` to validate codestyle
|
> Run `yarn check-android` to validate codestyle
|
||||||
|
|
||||||
|
### Docs
|
||||||
|
|
||||||
|
1. Edit the relevant file, it may be easiest to search for what you're editing to find the right file
|
||||||
|
2. Install all dependencies by running `yarn` inside the `docs` folder
|
||||||
|
|
||||||
|
> Run `yarn start` to generate the docs, you can then view them in your browser to confirm your changes
|
||||||
|
|
||||||
## Committing
|
## Committing
|
||||||
|
|
||||||
We love to keep our codebases clean. To achieve that, we use linters and formatters which output errors when something isn't formatted the way we like it to be.
|
We love to keep our codebases clean. To achieve that, we use linters and formatters which output errors when something isn't formatted the way we like it to be.
|
||||||
|
@ -75,6 +75,19 @@ public class QRCodeFrameProcessorPluginPackage implements ReactPackage {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
6. Register the package in MainApplication.java
|
||||||
|
|
||||||
|
```java {6}
|
||||||
|
@Override
|
||||||
|
protected List<ReactPackage> getPackages() {
|
||||||
|
@SuppressWarnings("UnnecessaryLocalVariable")
|
||||||
|
List<ReactPackage> packages = new PackageList(this).getPackages();
|
||||||
|
...
|
||||||
|
packages.add(new QRCodeFrameProcessorPluginPackage()); // <- add
|
||||||
|
return packages;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
</TabItem>
|
</TabItem>
|
||||||
<TabItem value="kotlin">
|
<TabItem value="kotlin">
|
||||||
|
|
||||||
@ -121,6 +134,19 @@ class QRCodeFrameProcessorPluginPackage : ReactPackage {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
6. Register the package in MainApplication.java
|
||||||
|
|
||||||
|
```java {6}
|
||||||
|
@Override
|
||||||
|
protected List<ReactPackage> getPackages() {
|
||||||
|
@SuppressWarnings("UnnecessaryLocalVariable")
|
||||||
|
List<ReactPackage> packages = new PackageList(this).getPackages();
|
||||||
|
...
|
||||||
|
packages.add(new QRCodeFrameProcessorPluginPackage()); // <- add
|
||||||
|
return packages;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
</TabItem>
|
</TabItem>
|
||||||
</Tabs>
|
</Tabs>
|
||||||
|
|
||||||
|
@ -4,9 +4,9 @@ export interface TakePhotoOptions {
|
|||||||
/**
|
/**
|
||||||
* Indicates how photo quality should be prioritized against speed.
|
* Indicates how photo quality should be prioritized against speed.
|
||||||
*
|
*
|
||||||
* * `"quality"` Indicates that speed of photo delivery is most important, even at the expense of quality
|
* * `"quality"` Indicates that photo quality is paramount, even at the expense of shot-to-shot time
|
||||||
* * `"balanced"` Indicates that photo quality and speed of delivery are balanced in priority
|
* * `"balanced"` Indicates that photo quality and speed of delivery are balanced in priority
|
||||||
* * `"speed"` Indicates that photo quality is paramount, even at the expense of shot-to-shot time
|
* * `"speed"` Indicates that speed of photo delivery is most important, even at the expense of quality
|
||||||
*
|
*
|
||||||
* @platform iOS 13.0+
|
* @platform iOS 13.0+
|
||||||
* @default "balanced"
|
* @default "balanced"
|
||||||
|
Loading…
Reference in New Issue
Block a user