Home
QNX Software Development Platform
QNX SDP is a cross-compiling and debugging environment, including an IDE and command-line tools, for building binary images and programs for target boards running QNX Neutrino 7.1.
Sensor Framework
Sensor Framework Libraries
Camera Developer's Guide
The Camera library abstracts the complexity of interfacing with a camera connected to the target board.
Camera Library Reference
camera_api.h
The main definitions and functions for the Camera Library.
camera_frame_compressedvideo_t
A frame descriptor for compressed video frame types

QNX Momentics IDE User's Guide
This User's Guide describes version 7.1 of the Integrated Development Environment (IDE) that's part of the QNX Momentics tool suite.
QNX Software Development Platform
QNX SDP is a cross-compiling and debugging environment, including an IDE and command-line tools, for building binary images and programs for target boards running QNX Neutrino 7.1.
- Quickstart Guide
- OS Components & Operations
- Audio & Graphics API
- Multimedia
- Networking Middleware
- Programming
- Sensor Framework
  - Architecture
  - Getting Started
    This guide gets you started with the Sensor Framework for QNX SDP.
  - Sensor Framework Libraries
    - ADAS Library Developer's Guide
      The ADAS library facilitates the development of embedded systems that rely on sensor data.
    - Camera Developer's Guide
      The Camera library abstracts the complexity of interfacing with a camera connected to the target board.
      - Camera Library Overview
        The Camera library provides applications with an interface to interact with cameras connected to your system. The library supports up to 64 cameras but the actual limit depends on your hardware platform's limitations and resources.
      - Viewfinder Window
        By default, the Camera library creates a viewfinder window.
      - Settings on the Camera
        You can configure various settings on the camera to modify the ISO, aperture, shutter speed, framerate, resolution, format, etc.
      - Image Buffer Access
        The Camera library supports read-only and read-write access to the image from different stages in the imaging datapath. Applications access image buffers by binding callback functions or events to a particular stage of the imaging datapath. Alternatively, applications can use streams from the Screen API to access buffers. In this guide, access to the imaging datapath is referred to as image buffers.
      - External Camera Drivers
        Cameras that aren't already supported by the Sensor Framework for QNX SDP can be supported by an external camera driver library.
      - Show a Video Stream from a Camera
        You can use the Camera library to show a video stream (image buffers) from a live camera or file camera. This section shows you the basic workflow for doing so.
      - Camera Library Reference
        camera_api.h
        The main definitions and functions for the Camera Library.
        Definitions in camera_api.h
        Preprocessor macro definitions for the camera_api.h header file in the libcamapi library
        Camera access mode flags
        The camera access mode flags that are passed to camera_open() to indicate the type of access required
        camera_analog_video_standard_t
        The possible analog video standards
        camera_add_video_group_entry()
        Associate a camera with a given video group
        camera_bayerformat_t
        The Bayer array macro-pixel format
        camera_bayerjustify_t
        Bayer bit justification
        camera_buffer_t
        The image data and metadata from the camera buffer
        camera_can_feature()
        Determine whether a feature is usable on the camera in its current state
        camera_close()
        Discontinue use of a logical camera on the device
        camera_create_video_group()
        Create a video group for synchronized video recording/encoding
        camera_destroy_video_group()
        Destroy a video group for synchronized video recording/encoding
        camera_devstatus_t
        Status of the camera device
        camera_disable_event()
        Disable the specified event
        camera_enable_status_event()
        Enable the status event
        camera_enable_viewfinder_event()
        Enable the viewfinder event
        camera_error_t
        Error codes for the Camera library
        camera_eventkey_t
        A camera event key that is used to identify an event that is enabled
        camera_eventmode_t
        Event-buffering modes
        camera_exposuremode_t
        The exposure mode of the camera
        camera_feature_t
        The camera capabilities or available features
        camera_find_capable()
        Find the cameras that have the specified features
        camera_focusmode_t
        The focus mode of the camera
        camera_force_video_keyframe()
        Instruct the video encoder to generate a keyframe on demand when encoding video
        camera_framedesc_t
        A union that contains all available frame descriptors for the Camera library
        camera_frametype_t
        The frame types identifiers for an image buffer
        camera_frame_bayer_t
        A frame descriptor for a Bayer frame type
        camera_frame_crycby_t
        A frame descriptor for a YCbCr 4:2:2 packed frame type
        camera_frame_cbycry_t
        A frame descriptor for a YCbCr 4:2:2 packed frame type
        camera_frame_cbycry_10bit_t
        A frame descriptor for a YCbCr 4:2:2 packed frame type
        camera_frame_compressedvideo_t
        A frame descriptor for compressed video frame types
        camera_frame_gray8_t
        A frame descriptor for 8-bits per pixel grayscale frame types
        camera_frame_gray10p_t
        A frame descriptor used for Gray10p frame types
        camera_frame_gray12p_t
        A frame descriptor used for Gray12p frame types
        camera_frame_nv12_t
        A frame descriptor used for NV12 frame types
        camera_frame_nv21_t
        A frame descriptor used for NV21 and NV61 semi-planar frame types
        camera_frame_rgb_ir_8bit_t
        A frame descriptor for 8-bits per pixel RGB-IR frame types
        camera_frame_rgb_ir_10bit_t
        A frame descriptor for 10-bits per pixel RGB-IR frame types
        camera_frame_rgb565_t
        A frame descriptor used for RGB565 frame types
        camera_frame_rgb888_t
        A frame descriptor used for RGB888 frame types
        camera_frame_rgb8888_t
        A frame descriptor used for RGB8888 frame types
        camera_frame_roi_t
        A frame descriptor for a region-of-interest (ROI) image frame type
        camera_frame_ycrycb_t
        A frame descriptor for a YCbCr 4:2:2 packed frame type
        camera_frame_ycbcr420p_t
        A frame descriptor used for a YCbCr 4:2:0 planar frame type
        camera_frame_ycbycr_t
        A frame descriptor for a YCbCr 4:2:2 packed frame type
        camera_frame_ycrcb420p_t
        A frame descriptor used for a YCrCb 4:2:0 planar frame type
        camera_frame_unspecified_t
        A frame descriptor that holds only data
        camera_get_analog_video_standard()
        Get the configured analog video standard
        camera_get_api_version()
        Retrieve the current build version of the Camera library
        camera_get_brightness()
        Retrieve the brightness value configured on the camera
        camera_get_capture_property()
        Get a property of an analog camera
        camera_get_contrast()
        Retrieve the contrast value configured on the camera
        camera_get_filename()
        Retrieve the filename associated with a camera
        camera_get_hue()
        Retrieve the hue value configured for the camera
        camera_get_location_property()
        Retrieve one or more location properties for a given camera
        camera_get_physical_property()
        Retrieve one or more physical properties of the camera
        camera_get_saturation()
        Retrieve the saturation value configured for the camera
        camera_get_screen_buffer()
        Retrieve the Screen buffer associated with a camera buffer
        camera_get_sharpness()
        Retrieve the sharpness value configured on the camera
        camera_get_specified_vf_resolutions()
        Get the list of supported viewfinder resolutions for a given frame type
        camera_get_specified_vf_framerates()
        Retrieve the supported viewfinder frame rates for the specified frame type and resolution
        camera_get_status_details()
        Retrieve the device status details from a status event
        camera_get_supported_brightness()
        Retrieve the supported brightness values
        camera_get_supported_cameras()
        Retrieve a list of the cameras available on the device
        camera_get_supported_contrast()
        Retrieve the supported contrast values
        camera_get_supported_hue()
        Retrieve the supported hue values
        camera_get_supported_saturation()
        Retrieve the supported saturation values
        camera_get_supported_sharpness()
        Retrieve the supported sharpness values
        camera_get_supported_vf_frame_types()
        Retrieve the viewfinder frame types available on the camera
        camera_get_supported_vf_framerates()
        Retrieve the supported viewfinder frame rates for the specified frame type
        camera_get_supported_vf_resolutions()
        Get the list of supported viewfinder resolutions for the current frame type
        camera_get_supported_vf_rotations()
        Retrieve the list of supported viewfinder rotation angles
        camera_get_vf_property()
        Retrieve one or more properties of the viewfinder
        camera_get_video_frame_types()
        Retrieve the video output frame types available on the camera
        camera_get_video_output_resolutions()
        Retrieve the supported output resolutions for video
        camera_get_video_property()
        Retrieve the current output properties for video
        camera_get_viewfinder_buffers()
        Retrieve image buffers from the camera
        camera_get_zoom_limits()
        Retrieve the supported range of zoom levels and determine whether the camera supports smooth zooming
        camera_get_zoom_ratio_from_zoom_level()
        Retrieves the zoom ratio corresponding to a given zoom level
        camera_has_feature()
        Determine whether a feature is available on the camera
        camera_imgprop_t
        This enumerated type specifies the image properties list
        camera_init_video_encoder()
        Performs optional initialization for video recording and encoding
        camera_handle_t
        A 32-bit value used as a handle to an open instance of a logical camera unit
        camera_is_create_window_supported()
        Determine if the specified frame type allows for window creation
        camera_is_roll_format_supported()
        Verify whether the specified camera roll video format is supported
        camera_is_videocodec_supported()
        Verify whether a given video codec is supported
        camera_location_prop_t
        The camera location properties list
        camera_open()
        Request a handle to access a logical camera unit
        camera_physprop_t
        Camera physical properties
        camera_region_t
        This structure is used to identify a subset of pixels in an image
        camera_remove_video_group_entry()
        Disassociate a camera from a video group
        camera_res_t
        The resolution (height and width of an image) in pixels
        camera_return_buffer()
        Return a buffer to the camera
        camera_roll_available_video()
        Report the space available for new video files on the camera roll
        camera_roll_close_video()
        Close the file descriptor for a video file on the camera roll
        camera_roll_get_path()
        Retrieve the camera roll path
        camera_roll_open_video()
        Create and open the next available video file on the camera roll for writing
        camera_roll_set_path()
        Set the camera roll path
        camera_roll_set_filename_suffix()
        Set the suffix to add to filenames generated from the camera roll
        camera_roll_video_fmt_t
        The supported video file format extensions on the camera roll
        camera_set_analog_video_standard()
        Set the analog video standard
        camera_set_brightness()
        Set the brightness value on the camera
        camera_set_capture_property()
        Set a property of an analog camera
        camera_set_contrast()
        Set the contrast value on the camera
        camera_set_filename()
        Set the filename associated with a camera
        camera_set_hue()
        Set the hue value for the camera
        camera_set_saturation()
        Set the saturation value for the camera
        camera_set_sharpness()
        Set the sharpness value on the camera
        camera_set_vf_property()
        Configure one or more settings of the viewfinder
        camera_set_video_filesize_warning()
        Configure the threshold of recording time left on the device before a warning is issued
        camera_set_video_filesize_limit()
        Impose a limit to the size of the recording file
        camera_set_video_property()
        Configure the output properties for video recording and encoding
        camera_start_encode()
        Start encoding video
        camera_start_video()
        Start recording video to a file
        camera_start_video_group()
        Start synchronized video recording or encording of the cameras associated with a given video group
        camera_start_viewfinder()
        Start the viewfinder on the camera
        camera_stop_encode()
        Stop encoding video
        camera_stop_video()
        Stop recording video
        camera_stop_video_group()
        Stop synchronized video recoding or encording with a given video group
        camera_stop_viewfinder()
        Stop the viewfinder
        camera_unit_t
        Represents the camera units on the device
        camera_videocodec_t
        The video compression formats used by the video encoder
        camera_video_group_id_t
        A 32-bit value that represents a unique identifier for a video group
        camera_encoder.h
        Functions to configure parameters for video encoding.
        camera_h264avc.h
        Supported H.264/AVC video encoder parameters.
        camera_3a.h
        Enumerations and functions for configuring 3A algorithms (Auto Focus, Auto Exposure, Auto White Balance) for cameras.
        external_camera_api.h
        Definitions and functions to use the External Camera library.
    - Sensor Developer's Guide
      The Sensor library abstracts the complexity of interfacing with sensors and cameras connected to the target board.
  - Sensor Framework Services
- System Security Guide
  The QNX System Security Guide is intended for both system integrators who are responsible for the security of a QNX Neutrino RTOS system and developers who want to create a QNX Neutrino resource manager free from vulnerabilities.
- Utilities & Libraries
QNX Hypervisor
The QNX Hypervisor allows you to run multiple OSs on a target system so you can separate critical and non-critical functions, support a wide variety of applications, and reduce hardware costs.
QNX Software in the Cloud
QNX Software in the Cloud enables developers to use the QNX software in Amazon Web Services (AWS) and Microsoft Azure (Azure).
QNX Advanced Virtualization Frameworks User's Guide
This User's Guide is aimed at all systems integrators and developers who want to design and build embedded systems using the QNX Advanced Virtualization Frameworks.
Typographical Conventions, Support, and Licensing
This section describes the typographical conventions used throughout the documentation and explains how to obtain technical support.

camera_frame_compressedvideo_t

A frame descriptor for compressed video frame types

Synopsis:

#include <camera/camera_api.h>

typedef struct {
    uint64_t bufsize;
    camera_videocodec_t codec;
    bool keyframe;
    uint64_t bitrate;
} camera_frame_compressedvideo_t;

Data:

uint64_t bufsize: The size of the buffer as a 64-bit integer.
camera_videocodec_t codec: The format of the compressed video (see camera_videocodec_t).
bool keyframe: A flag indicating whether this frame is a keyframe.
uint64_t bitrate: The bitrate expressed in bits per second.

Library:

libcamapi

Description:

Use this frame descriptor when CAMERA_FRAMETYPE_COMPRESSEDVIDEO is reported as the camera_frametype_t.

Page updated: March 12, 2026