camera_imgprop_t

This enumerated type specifies the image properties list.

Synopsis:

#include <camera/camera_api.h>
 
typedef enum {
      CAMERA_IMGPROP_FORMAT = 0   
      CAMERA_IMGPROP_WIDTH   
      CAMERA_IMGPROP_HEIGHT   
      CAMERA_IMGPROP_FRAMERATE   
      CAMERA_IMGPROP_BITRATE   
      CAMERA_IMGPROP_KEYFRAMEINTERVAL   
      CAMERA_IMGPROP_ROTATION   
      CAMERA_IMGPROP_STABILIZATION   
      CAMERA_IMGPROP_ZOOMFACTOR   
      CAMERA_IMGPROP_HWOVERLAY   
      CAMERA_IMGPROP_JPEGQFACTOR   
      CAMERA_IMGPROP_WIN_GROUPID   
      CAMERA_IMGPROP_WIN_ID   
      CAMERA_IMGPROP_BURSTMODE   
      CAMERA_IMGPROP_BURSTDIVISOR   
      CAMERA_IMGPROP_SLICESIZE   
      CAMERA_IMGPROP_VARIABLEFRAMERATE   
      CAMERA_IMGPROP_MINFRAMERATE   
      CAMERA_IMGPROP_ISEMBEDDED   
      CAMERA_IMGPROP_CREATEWINDOW   
      CAMERA_IMGPROP_METAORIENTATIONHINT   
      CAMERA_IMGPROP_MAXFOV   
      CAMERA_IMGPROP_VIDEOCODEC   
      CAMERA_IMGPROP_AUDIOCODEC   
      CAMERA_IMGPROP_RENDERTOWINDOW   
} camera_imgprop_t;

Since:

BlackBerry 10.0.0

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.

When CAMERA_IMGPROP_VARIABLEFRAMERATE is set to a value of 1, CAMERA_IMGPROP_FRAMERATE indicates the maximum frame rate to use for the image sequence.

CAMERA_IMGPROP_BITRATE

Deprecated:

As of BlackBerry 10.2.0.

Do not use this property. Instead, use the appropriate bitrate property that corresponds to the video codec. For example, if you configure an H.264/AVC video recording, use the camera_set_videoencoder_parameter() function to set the CAMERA_H264AVC_BITRATE parameter.

(Deprecated) The units are in bits per second as a uint32_t value

CAMERA_IMGPROP_KEYFRAMEINTERVAL

Deprecated:

As of BlackBerry 10.2.0.

Do not use this property. Instead, use the appropriate bitrate property that corresponds to the video codec. For example, if you configure an H.264/AVC video recording, use the camera_set_videoencoder_parameter() function to set the CAMERA_H264AVC_KEYFRAMEINTERVAL parameter.

(Deprecated) The interval (in frames) between the generation of each keyframe as a uint32_t 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_STABILIZATION
Enable built-in stabilization algorithms to help avoid a blurry image.

The value is specified as an int value. A value of 0 indicates that stabilization is off and a value of 1 indicates that stabilization is on. To enable stabilization for video, CAMERA_FEATURE_VIDEOSTABILIZATION must be available on the camera. Note that CAMERA_IMGPROP_MAXFOV must be set to 0 when starting the video viewfinder before video stabilization can be enabled. To enable stabilization for photos, CAMERA_FEATURE_PHOTOSTABILIZATION must be available on the camera.

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 viewfinder buffers to the video display. For more information, see SCREEN_USAGE_OVERLAY used in the screen_set_window_property_iv() function in Screen Graphics Subsystem library. When you use this value, the viewfinder window uses SCREEN_USAGE_OVERLAY window property where possible.

CAMERA_IMGPROP_JPEGQFACTOR
The JPEG quality setting of the camera as an int value.

The value represents a percentage. Some camera hardware may be limited to a maximum JPEG quality setting for performance reasons. Values that you program may be internally clipped to the maximum supported value.

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

For more information, see the Screen and Windowing library.

CAMERA_IMGPROP_WIN_ID
The window ID to apply to the viewfinder window that is created as a const char* value.
CAMERA_IMGPROP_BURSTMODE

Deprecated:

As of CAMERA_API_VERSION 3 (BlackBerry 10.3.0).

Instead, use camera_set_vf_mode() to select a burst viewfinder mode. The list of viewfinder modes is defined by camera_vfmode_t.

(Deprecated) Burst mode should be used as an int value. A value of 0 indicates to disable burst capture mode while a value of 1 indicates to enable burst capture mode.

CAMERA_IMGPROP_BURSTDIVISOR

Deprecated:

As of BlackBerry 10.2.0.

Instead, set CAMERA_IMGPROP_FRAMERATE using the camera_set_photo_property() function.

(Deprecated) The frame rate divisor to apply when operating in burst capture mode as a double value. A value of 1 will yield a capture frame rate equal to the viewfinder frame rate. A value of 2 will yield a capture frame rate equal to the viewfinder frame rate divided by 2, where every second frame is captured. Fractional values are allowed.

CAMERA_IMGPROP_SLICESIZE

Deprecated:

As of BlackBerry 10.2.0.

Do not use this property. Instead, use the appropriate slice size property that corresponds to the video codec. For example, if you configure an H.264/AVC video recording, use the camera_set_videoencoder_parameter() function to set the CAMERA_H264AVC_SLICESIZE parameter. (Deprecated)
CAMERA_IMGPROP_VARIABLEFRAMERATE
Enable variable frame rate for the image sequence.
To use this feature, variable frame rate must be supported by the photo viewfinder (CAMERA_FEATURE_PHOTOVFVARIABLEFRAMERATE). The use of variable frame rate mode allows the camera to decrease the frame rate in order to increase exposure time to compensate for poor lighting conditions. You can use variable frame rate to vary the frame rate based on the lighting conditions in a range defined as follows:
 CAMERA_IMGPROP_FRAMERATE >= frame rate >= CAMERA_IMGPROP_MINFRAMERATE
The value of this property is specified as an int value. A value of 0 indicates that variable frame rate is disabled (frame rate is fixed as specified by CAMERA_IMGPROP_FRAMERATE) and a value of 1 indicates that variable frame rate is enabled.
CAMERA_IMGPROP_MINFRAMERATE
The minimum frame rate of the image sequence as a double value.

If variable frame rate mode is enabled, be sure to change CAMERA_IMGPROP_FRAMERATE and CAMERA_IMGPROP_MINFRAMERATE at the same time via a single call to the camera_set_vf_property() function. Doing so ensures that range checks can be properly performed.

CAMERA_IMGPROP_ISEMBEDDED
An embedded window will be created (see Screen Graphics Subsystem library on window-types).

If the viewfinder is being created as a child of an existing child window, then 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 or not.

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

CAMERA_IMGPROP_METAORIENTATIONHINT
Whether automatic embedding of metadata orientation hints is enabled.

This flag must be set using an int value. Use a value of 1 if the desired CAMERA_IMGPROP_ROTATION value cannot be selected due to limitations in available rotation values reported by camera_get_photo_rotations() and 0 otherwise. If you have enabled metadata orientation hints, use camera_set_device_orientation() to indicate which way the device is oriented.

CAMERA_IMGPROP_MAXFOV
Indicates that the FOV (field of view) of the viewfinder should not be cropped when the viewfinder is started.

This parameter must be set using an int value. A value of 0 indicates that the viewfinder may be started with cropping applied in order to support use of the CAMERA_IMGPROP_STABILIZATION property. A value of 1 indicates that the viewfinder will provide the widest possible field of view at startup and will disallow attempts to use the CAMERA_IMGPROP_STABILIZATION property.

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 will be 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.

Since: BlackBerry 10.3.0

Library:

libcamapi (For the qcc command, use the -l camapi option to link against this library)

Description:

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

Last modified: 2014-06-24



Got questions about leaving a comment? Get answers from our Disqus FAQ.

comments powered by Disqus