camera_imgprop_t

Updated: April 19, 2023

Image properties

Synopsis:

#include <camera/camera_api.h>
typedef enum {
    CAMERA_IMGPROP_END = -1,
    CAMERA_IMGPROP_FORMAT = 0,
    CAMERA_IMGPROP_WIDTH,
    CAMERA_IMGPROP_HEIGHT,
    CAMERA_IMGPROP_FRAMERATE,
    CAMERA_IMGPROP_ROTATION,
    CAMERA_IMGPROP_ZOOMFACTOR,
    CAMERA_IMGPROP_HWOVERLAY,
    CAMERA_IMGPROP_WIN_GROUPID,
    CAMERA_IMGPROP_WIN_ID,
    CAMERA_IMGPROP_ISEMBEDDED,
    CAMERA_IMGPROP_CREATEWINDOW,
    CAMERA_IMGPROP_VIDEOCODEC,
    CAMERA_IMGPROP_AUDIOCODEC,
    CAMERA_IMGPROP_RENDERTOWINDOW,
    CAMERA_IMGPROP_NUMUSERBUFFERS
} camera_imgprop_t;

Data:

CAMERA_IMGPROP_END
End-of-list identifier.
CAMERA_IMGPROP_FORMAT
The image format as a camera_frametype_t value.
CAMERA_IMGPROP_WIDTH
The width of the image as a uint32_t value.
CAMERA_IMGPROP_HEIGHT
The height of the image as a uint32_t value.
CAMERA_IMGPROP_FRAMERATE
The frame rate of the image sequence as a double value.
CAMERA_IMGPROP_ROTATION
The image rotation angle (in degrees) as a uint32_t value.

Rotation angles are measured in the clockwise direction.

CAMERA_IMGPROP_ZOOMFACTOR
Zoom factor used, as a uint32_t value.

The zoom factor is supported by the camera hardware and represents optical zoom or digital zoom. Optical zoom is supported by only some cameras. Most cameras support digital zoom.

CAMERA_IMGPROP_HWOVERLAY
The viewfinder can use hardware acceleration for blitting.

Hardware acceleration for the blitting feature must be available (see CAMERA_FEATURE_VFHWOVERLAY). Use the camera_can_feature() function to determine whether the camera supports this feature. Specify this property as an int value where 0 indicates to not use blitting and 1 indicates to use it.

Blitting is a hardware acceleration feature for efficiently transferring image buffers to the video display. For more information, see SCREEN_USAGE_OVERLAY in the screen_set_window_property_iv() function reference in the Screen Developer's Guide. When you use this value, the viewfinder window uses the SCREEN_USAGE_OVERLAY window property where possible.

CAMERA_IMGPROP_WIN_GROUPID
The window group ID the viewfinder should be created in, as a const char* value.

For more information, see the QNX Screen Graphics Subsystem.

CAMERA_IMGPROP_WIN_ID
The window ID to apply to the created viewfinder window, as a const char* value.
CAMERA_IMGPROP_ISEMBEDDED
Whether an embedded window will be created (see “Screen window types” in the Screen Developer's Guide).

If the viewfinder is being created as a child of an existing child window, this flag must be set using an int. Use a value of 1 to create an embedded window and 0 otherwise.

CAMERA_IMGPROP_CREATEWINDOW
Whether to create a visible viewfinder window.

This flag accepts int values. Setting the value to 1 causes a viewfinder window to be created; setting it to 0 suppresses the creation of a viewfinder window (see the Screen Developer's Guide for information on managing windows).

Note:

To create a viewfinder window, the feature CAMERA_FEATURE_VFWINDOW must be available on the camera.

On some platforms, not all frame types are supported. Call camera_is_create_window_supported() to check if the frame type you are using allows CAMERA_IMGPROP_CREATEWINDOW to be true.

CAMERA_IMGPROP_VIDEOCODEC
The video codec used when generating video files or streams using camera_start_video() or camera_start_encode().

The video codec value is of type camera_videocodec_t.

CAMERA_IMGPROP_AUDIOCODEC
The audio codec used when generating video files or streams using camera_start_video() or camera_start_encode().

The audio codec value is of type camera_audiocodec_t.

CAMERA_IMGPROP_RENDERTOWINDOW
The viewfinder window is updated with frames from the camera when this property is set to 1.

Rendering is suspended if the value is set to 0. The parameter must be an int value, and can be used to mask undesirable visual artifacts when exposure bracketing is active.

CAMERA_IMGPROP_NUMUSERBUFFERS
The viewfinder window is created with a certain number of buffers to accommodate both the buffer requirements of the camera and to have additional buffers that can be held by the user for callback or event handling.

This property indicates how many additional buffers are allocated for the user. While it's always possible to read this property, it is writable only before starting the viewfinder and for cameras that support the feature CAMERA_FEATURE_NUMVFUSERBUFFERS. The parameter is a uint32_t value.

Library:

libcamapi

Description:

Each key is associated with a value of the indicated type.