ScCamera.h File Reference

Go to the source code of this file.

Data Structures

struct  ScStepwiseResolution
 
struct  ScFramerate
 
struct  ScStepwiseFramerate
 

Typedefs

typedef struct ScOpaqueCamera ScCamera
 

Enumerations

enum  ScCameraMode { SC_CAMERA_MODE_UNKNOWN = 0, SC_CAMERA_MODE_DISCRETE = 1, SC_CAMERA_MODE_STEPWISE = 2 }
 

Functions

float sc_framerate_get_frame_interval (const ScFramerate *frame_rate)
 
float sc_framerate_get_fps (const ScFramerate *frame_rate)
 

Detailed Description

Camera creation and control interface.


Data Structure Documentation

struct ScStepwiseResolution

A unsigned step-wise description of a size.

Describes the resolution capabilities of a camera in step-wise mode. The camera supports all resolutions in the range of min_width to max_width and min_heigth to max_height in steps of step_width and step_height.

See also
ScCameraMode for further information about resolution modes.
Since
4.7.0
Examples:
ScanditNativeBarcodeScannerCameraDemo.c.
Data Fields
uint32_t min_width minimum x dimension
uint32_t max_width maximum x dimension
uint32_t step_width x dimension step size
uint32_t min_height minimum y dimension
uint32_t max_height maximum y dimension
uint32_t step_height y dimension step size
struct ScFramerate

Describes a framerate.

Note
The framerate are described as fractions with a numerator and a denominator
Since
4.7.0
Data Fields
uint32_t numerator numerator of the frameraet
uint32_t denominator denominator of the framerate
struct ScStepwiseFramerate

A step-wise description of a framerate.

Describes the framerate capabilities of a camera in step-wise mode (for a specific resolution). The camera supports all framerates in the range of min to max in steps of step.

See also
ScCameraMode for further information about framerate modes.
Since
4.7.0
Data Fields
ScFramerate min
ScFramerate max
ScFramerate step

Enumeration Type Documentation

Describes the resolution mode of the camera.

This enum defines the return values of sc_camera_get_resolution_mode() and sc_camera_get_framerate_mode(). It can therefore describe both properties of the camera in an analog way.

The resolution mode of the camera may be SC_CAMERA_MODE_DISCRETE or SC_CAMERA_MODE_STEPWISE. In discrete mode the camera supports a predefined set of resolutions. The possible resolutions can be queried with sc_camera_query_supported_resolutions(). In step-wise mode the camera supports resolution between a minimum and maximum value in stepwise increments. More precisely, all resolutions in the range of min_width to max_width and min_height to max_height in steps of step_width and step_height are supported. The minimum, maximum and step values can be queried by sc_camera_query_supported_resolutions_stepwise().

The framerate mode of the camera may be SC_CAMERA_MODE_DISCRETE or SC_CAMERA_MODE_STEPWISE. In discrete mode the camera supports a predefines set of framerates at which it can capture video. The possible framerate can be queried with sc_camera_query_supported_framerates(). In step-wise mode the camera supports framerates between a minimum an maximum value in stepwise increments. More precisely, all resolutions in the range of min to max in steps of step are supported. Note that framerates are represented using a fraction. The minimum, maximum and step values can be queried by sc_camera_query_supported_framerates_stepwise().

Since
4.7.0
Enumerator
SC_CAMERA_MODE_UNKNOWN 

the camera resolution mode is not known

SC_CAMERA_MODE_DISCRETE 

the camera captures at a finite set of discrete resolutions

SC_CAMERA_MODE_STEPWISE 

the camera captures at a wide range of step-wise generated resolutions

Function Documentation

float sc_framerate_get_frame_interval ( const ScFramerate frame_rate)

Returns the time between two frames in seconds.

Parameters
frame_ratea valid frame rate object. Must not be null
Returns
Returns the frame interval time of a framerate object (in seconds)
Since
4.7.0
float sc_framerate_get_fps ( const ScFramerate frame_rate)

Returns the number of frames per second.

Parameters
frame_ratea valid frame rate object. Must not be null
Returns
Returns the frame per second rate of a framerate object
Since
4.7.0