Property documentation of Basic camera

Properties

• "name"
• "sensor-width"
• "sensor-height"
• "sensor-bitdepth"
• "sensor-horizontal-binning"
• "sensor-horizontal-binnings"
• "sensor-vertical-binning"
• "sensor-vertical-binnings"
• "sensor-max-frame-rate"
• "trigger-mode"
• "exposure-time"
• "frames-per-second"
• "roi-x0"
• "roi-y0"
• "roi-width"
• "roi-height"
• "roi-width-multiplier"
• "roi-height-multiplier"
• "has-streaming"
• "has-camram-recording"
• "recorded-frames"
• "transfer-asynchronously"
• "is-recording"
• "is-readout"

Details

name

"name" : gchararray : Read-only

Name of the camera

sensor-width

"sensor-width" : guint : Read-only

Width of the sensor in pixels

Possible values: 1 ≤ sensor-width ≤ -1

Default value: 1

sensor-height

"sensor-height" : guint : Read-only

Height of the sensor in pixels

Possible values: 1 ≤ sensor-height ≤ -1

Default value: 1

sensor-bitdepth

"sensor-bitdepth" : guint : Read-only

Number of bits per pixel

Possible values: 1 ≤ sensor-bitdepth ≤ 32

Default value: 1

sensor-horizontal-binning

"sensor-horizontal-binning" : guint : Read / Write

Number of sensor ADCs that are combined to one pixel in horizontal direction

Possible values: 1 ≤ sensor-horizontal-binning ≤ -1

Default value: 1

sensor-horizontal-binnings

"sensor-horizontal-binnings" : GValueArray : Read-only

Array of possible binnings in horizontal direction

sensor-vertical-binning

"sensor-vertical-binning" : guint : Read / Write

Number of sensor ADCs that are combined to one pixel in vertical direction

Possible values: 1 ≤ sensor-vertical-binning ≤ -1

Default value: 1

sensor-vertical-binnings

"sensor-vertical-binnings" : GValueArray : Read-only

Array of possible binnings in vertical direction

sensor-max-frame-rate

"sensor-max-frame-rate" : gfloat : Read-only

Maximum frame rate at full frame resolution

Possible values: 0.0e+00 ≤ sensor-max-frame-rate ≤ 3.4e+38

Default value: 1.0e+00

trigger-mode

"trigger-mode" : UcaCameraTrigger : Read / Write

Trigger mode

Possible values:

Enum name	Value
UCA_CAMERA_TRIGGER_AUTO	0
UCA_CAMERA_TRIGGER_SOFTWARE	1
UCA_CAMERA_TRIGGER_EXTERNAL	2

exposure-time

"exposure-time" : gdouble : Read / Write

Exposure time in seconds

Possible values: 0.0e+00 ≤ exposure-time ≤ 1.8e+308

Default value: 1.0e+00

frames-per-second

"frames-per-second" : gdouble : Read / Write

Frames per second

Possible values: 0.0e+00 ≤ frames-per-second ≤ 1.8e+308

Default value: 1.0e+00

roi-x0

"roi-x0" : guint : Read / Write

Horizontal coordinate

Possible values: 0 ≤ roi-x0 ≤ -1

Default value: 0

roi-y0

"roi-y0" : guint : Read / Write

Vertical coordinate

Possible values: 0 ≤ roi-y0 ≤ -1

Default value: 0

roi-width

"roi-width" : guint : Read / Write

Width of the region of interest

Possible values: 1 ≤ roi-width ≤ -1

Default value: 1

roi-height

"roi-height" : guint : Read / Write

Height of the region of interest

Possible values: 1 ≤ roi-height ≤ -1

Default value: 1

roi-width-multiplier

"roi-width-multiplier" : guint : Read-only

Minimum possible step size of horizontal ROI

Possible values: 1 ≤ roi-width-multiplier ≤ -1

Default value: 1

roi-height-multiplier

"roi-height-multiplier" : guint : Read-only

Minimum possible step size of vertical ROI

Possible values: 1 ≤ roi-height-multiplier ≤ -1

Default value: 1

has-streaming

"has-streaming" : gboolean : Read-only

Is the camera able to stream the data

Default value: TRUE

has-camram-recording

"has-camram-recording" : gboolean : Read-only

Is the camera able to record the data in-camera

Default value: FALSE

recorded-frames

"recorded-frames" : guint : Read-only

Number of frames recorded into internal camera memory

Possible values: 0 ≤ recorded-frames ≤ -1

Default value: 0

transfer-asynchronously

"transfer-asynchronously" : gboolean : Read / Write

Specify whether data should be transfered asynchronously using a specified callback

Default value: FALSE

is-recording

"is-recording" : gboolean : Read-only

Is the camera currently recording

Default value: FALSE

is-readout

"is-readout" : gboolean : Read-only

Is camera in readout mode

Default value: FALSE