camera_imgprop_t

This enumerated type specifies the image properties list

Synopsis:

#include <camera/camera_api.h>
typedef enum {
    CAMERA_IMGPROP_FORMAT,
    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_CREATEWINDOW,
    CAMERA_IMGPROP_VIDEOCODEC,
    CAMERA_IMGPROP_RENDERTOWINDOW,
    CAMERA_IMGPROP_NUMUSERBUFFERS,
    CAMERA_IMGPROP_ENCODERSELECT,
    CAMERA_IMGPROP_NUM_BUFFERS
} camera_imgprop_t;

Data:

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.

For a variable frame rate, this property indicates the maximum frame rate to use for the image sequence.

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 is used as a uint32_t value.

The zoom factor is a value supported by the camera hardware and represents digital zoom or optical zoom. Optical zoom is only supported if the camera supports it. Most digital cameras support digital zoom.

CAMERA_IMGPROP_HWOVERLAY
The viewfinder can use hardware acceleration for blitting.

To use this feature, the hardware acceleration for the blitting feature must be available (#CAMERA_FEATURE_VFHWOVERLAY). Use the camera_can_feature() function to determine whether the camera supports the feature. To use blitting, specify as an int value where 0 indicates not to use blitting and 1 indicates to use blitting.

Blitting is a hardware acceleration feature used for efficiently transferring image buffers to the video display. For more information, see SCREEN_USAGE_OVERLAY used in the screen_set_window_property_iv() function in the Screen Library Reference of the Screen Developer's Guide. When you use this value, the viewfinder window uses 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 viewfinder window that is created as a const char* value.
CAMERA_IMGPROP_CREATEWINDOW
Whether to create a visible viewfinder window or not.

This flag accepts int values. Setting the value to 1 causes a viewfinder window to be created (see the Screen Graphics Subsystem for information on managing windows). Setting the value to 0 suppresses the creation of a viewfinder window.

Note:

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

Note:

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_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 accomodate 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 only writable before starting the viewfinder and for cameras that support the feature CAMERA_FEATURE_NUMVFUSERBUFFERS. The parameter is a uint32_t value.

CAMERA_IMGPROP_ENCODERSELECT
Select which encoder to configure and use for encoding the raw video.

A value of CAMERA_ENCODER_LOCAL (the default) signifies to use a local encoder, meaning a hardware video encoder on the local system. A value of CAMERA_ENCODER_REMOTE signifies to use a remote encoder, meaning a connected camera that supports video encoding natively. For both settings, the configuration is done the same way, using camera_encoder.h and camera_h264avc.h.

This property must be configured alone when calling camera_set_video_property() but can be read with other properties.

CAMERA_IMGPROP_NUM_BUFFERS
The total number of buffers required.

The viewfinder window is created with this 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 is a read-only property because it depends on hardware requirements and the number of additional buffers requested by the user. The parameter is a uint32_t value.

Library:

libcamapi

Description:

The camera_imgprop_t data type specifies the possible image properties. These properties are used as keys for the following functions:

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

Page updated: