docs: Update Format.pixelFormat documentation

This commit is contained in:
Marc Rousavy
2021-12-10 09:52:40 +01:00
parent 9301430165
commit 934de142ee
3 changed files with 11 additions and 2 deletions

View File

@@ -173,7 +173,9 @@ export interface CameraDeviceFormat {
*/
videoStabilizationModes: VideoStabilizationMode[];
/**
* Specifies the pixel format on iOS. e.g. 420v, 420f
* Specifies this format's pixel format. The pixel format specifies how the individual pixels are interpreted as a visual image.
*
* The most common format is `420v`. Some formats (like `x420`) are not compatible with some frame processor plugins (e.g. MLKit)
*/
pixelFormat: PixelFormat;
}