CaptureImage.fromYuvPlanes Method

Module: CaptureImage

Definition

Creates an Image from the specified YUV planes.

@staticmethod
from_yuv_planes(y_plane: bytearray, u_plane: bytearray, v_plane: bytearray, y_width: int, y_height: int, uv_pixel_stride: int, uv_row_stride: int, dst_pixel_format: PixelFormat) -> CaptureImage

Parameters

y_plane bytearray
in A buffer that contains the Y plane.

u_plane bytearray
in A buffer that contains the U plane.

v_plane bytearray
in A buffer that contains the V plane.

y_width int
in The width, in pixels, of the Y plane.

y_height int
in The height, in pixels, of the Y plane.

uv_pixel_stride int
in The pixel-level stride, in pixels, of the U and V planes.

uv_row_stride int
in The row-level stride, in pixels, of the U and V planes.

dst_pixel_format PixelFormat
in The pixel format into which to convert the input image.

Returns

CaptureImage
The newly created capture image.

Exceptions

DevicesException
An error has occurred during Devices Library execution.
static CaptureImage fromYuvPlanes(Uint8List? yPlane, Uint8List? uPlane, Uint8List? vPlane, int yWidth, int yHeight, int uvPixelStride, int uvRowStride, PixelFormat dstPixelFormat)

Parameters

yPlane Uint8List
in A buffer that contains the Y plane.

uPlane Uint8List
in A buffer that contains the U plane.

vPlane Uint8List
in A buffer that contains the V plane.

yWidth int
in The width, in pixels, of the Y plane.

yHeight int
in The height, in pixels, of the Y plane.

uvPixelStride int
in The pixel-level stride, in pixels, of the U and V planes.

uvRowStride int
in The row-level stride, in pixels, of the U and V planes.

dstPixelFormat PixelFormat
in The pixel format into which to convert the input image.

Returns

CaptureImage
The newly created capture image.

Exceptions

DevicesException
An error has occurred during Devices Library execution.
public static CaptureImage FromYuvPlanes(byte[] yPlane, byte[] uPlane, byte[] vPlane, int yWidth, int yHeight, int uvPixelStride, int uvRowStride, PixelFormat dstPixelFormat)

Parameters

yPlane byte[]
in A buffer that contains the Y plane.

uPlane byte[]
in A buffer that contains the U plane.

vPlane byte[]
in A buffer that contains the V plane.

yWidth int
in The width, in pixels, of the Y plane.

yHeight int
in The height, in pixels, of the Y plane.

uvPixelStride int
in The pixel-level stride, in pixels, of the U and V planes.

uvRowStride int
in The row-level stride, in pixels, of the U and V planes.

dstPixelFormat PixelFormat
in The pixel format into which to convert the input image.

Returns

CaptureImage
The newly created capture image.

Exceptions

DevicesException
An error has occurred during Devices Library execution.
public static CaptureImage fromYuvPlanes(byte[] yPlane, byte[] uPlane, byte[] vPlane, int yWidth, int yHeight, int uvPixelStride, int uvRowStride, PixelFormat dstPixelFormat) throws DevicesException

Parameters

yPlane byte[]
in A buffer that contains the Y plane.

uPlane byte[]
in A buffer that contains the U plane.

vPlane byte[]
in A buffer that contains the V plane.

yWidth int
in The width, in pixels, of the Y plane.

yHeight int
in The height, in pixels, of the Y plane.

uvPixelStride int
in The pixel-level stride, in pixels, of the U and V planes.

uvRowStride int
in The row-level stride, in pixels, of the U and V planes.

dstPixelFormat PixelFormat
in The pixel format into which to convert the input image.

Returns

CaptureImage
The newly created capture image.

Exceptions

DevicesException
An error has occurred during Devices Library execution.
int id3DevicesCaptureImage_FromYuvPlanes (
    ID3_DEVICES_CAPTURE_IMAGE hCaptureImage,
    unsigned char * yPlane,
    int yPlaneSize,
    unsigned char * uPlane,
    int uPlaneSize,
    unsigned char * vPlane,
    int vPlaneSize,
    int yWidth,
    int yHeight,
    int uvPixelStride,
    int uvRowStride,
    id3DevicesPixelFormat eDstPixelFormat)

Parameters

hCaptureImage ID3_DEVICES_CAPTURE_IMAGE
in Handle to the CaptureImage object.

yPlane unsigned char *
in A buffer that contains the Y plane.

yPlaneSize int
in Size of the ‘yPlane’ buffer.

uPlane unsigned char *
in A buffer that contains the U plane.

uPlaneSize int
in Size of the ‘uPlane’ buffer.

vPlane unsigned char *
in A buffer that contains the V plane.

vPlaneSize int
in Size of the ‘vPlane’ buffer.

yWidth int
in The width, in pixels, of the Y plane.

yHeight int
in The height, in pixels, of the Y plane.

uvPixelStride int
in The pixel-level stride, in pixels, of the U and V planes.

uvRowStride int
in The row-level stride, in pixels, of the U and V planes.

eDstPixelFormat id3DevicesPixelFormat
in The pixel format into which to convert the input image.

Returns

int
An error code.
See id3DevicesError file for the list of possible error codes.