Document changes

pull/482/head
Mattia Iavarone 6 years ago
parent 2e6c4fbbb5
commit 0e04185832
  1. 7
      docs/_posts/2018-12-20-changelog.md
  2. 26
      docs/_posts/2018-12-20-v1-migration-guide.md

@ -8,6 +8,11 @@ order: 3
New versions are released through GitHub, so the reference page is the [GitHub Releases](https://github.com/natario1/CameraView/releases) page. New versions are released through GitHub, so the reference page is the [GitHub Releases](https://github.com/natario1/CameraView/releases) page.
### v2.0.0-beta06 (to be released)
- Improvement: we now choose a video recording profile that is compatible with the chosen size. Should fix some video recording issues. ([#477][477])
- **Breaking change**: some public classes have been moved to different packages. See [table here](../extra/v1-migration-guide.html#repackaging). ([#482][482])
### v2.0.0-beta05 ### v2.0.0-beta05
- Fixed `FrameProcessor` freeze and release behavior, was broken ([#431][431]) - Fixed `FrameProcessor` freeze and release behavior, was broken ([#431][431])
@ -46,3 +51,5 @@ This is the first beta release. For changes with respect to v1, please take a lo
[431]: https://github.com/natario1/CameraView/pull/431 [431]: https://github.com/natario1/CameraView/pull/431
[403]: https://github.com/natario1/CameraView/pull/403 [403]: https://github.com/natario1/CameraView/pull/403
[435]: https://github.com/natario1/CameraView/pull/435 [435]: https://github.com/natario1/CameraView/pull/435
[477]: https://github.com/natario1/CameraView/pull/477
[482]: https://github.com/natario1/CameraView/pull/482

@ -165,6 +165,32 @@ The listener interface brings two breaking signature changes:
The v2 version introduces a `cameraExperimental` XML flag that you can use to enable experimental features. The v2 version introduces a `cameraExperimental` XML flag that you can use to enable experimental features.
Might be used in the future to speed up development. Might be used in the future to speed up development.
### Repackaging
Some public classes have been moved to different subpackages, to rearrange code in a more meaningful
way for the future. These changes are listed below:
|Class name|Old package|New package|
|----------|-----------|-----------|
|`Audio`|`com.otaliastudios.cameraview`|`com.otaliastudios.cameraview.controls`|
|`Control`|`com.otaliastudios.cameraview`|`com.otaliastudios.cameraview.controls`|
|`Facing`|`com.otaliastudios.cameraview`|`com.otaliastudios.cameraview.controls`|
|`Flash`|`com.otaliastudios.cameraview`|`com.otaliastudios.cameraview.controls`|
|`Grid`|`com.otaliastudios.cameraview`|`com.otaliastudios.cameraview.controls`|
|`Hdr`|`com.otaliastudios.cameraview`|`com.otaliastudios.cameraview.controls`|
|`Mode`|`com.otaliastudios.cameraview`|`com.otaliastudios.cameraview.controls`|
|`Preview`|`com.otaliastudios.cameraview`|`com.otaliastudios.cameraview.controls`|
|`VideoCodec`|`com.otaliastudios.cameraview`|`com.otaliastudios.cameraview.controls`|
|`WhiteBalance`|`com.otaliastudios.cameraview`|`com.otaliastudios.cameraview.controls`|
|`Frame`|`com.otaliastudios.cameraview`|`com.otaliastudios.cameraview.frame`|
|`FrameProcessor`|`com.otaliastudios.cameraview`|`com.otaliastudios.cameraview.frame`|
|`Gesture`|`com.otaliastudios.cameraview`|`com.otaliastudios.cameraview.gesture`|
|`GestureAction`|`com.otaliastudios.cameraview`|`com.otaliastudios.cameraview.gesture`|
|`Size`|`com.otaliastudios.cameraview`|`com.otaliastudios.cameraview.size`|
|`SizeSelector`|`com.otaliastudios.cameraview`|`com.otaliastudios.cameraview.size`|
|`SizeSelectors`|`com.otaliastudios.cameraview`|`com.otaliastudios.cameraview.size`|
|`AspectRatio`|`com.otaliastudios.cameraview`|`com.otaliastudios.cameraview.size`|
### Other improvements & changes ### Other improvements & changes
- Added `@Nullable` and `@NonNull` annotations pretty much everywhere. This might **break** your Kotlin build. - Added `@Nullable` and `@NonNull` annotations pretty much everywhere. This might **break** your Kotlin build.

Loading…
Cancel
Save