Classes | |
| struct | RecordingStatus |
| Structure containing information about the status of the recording. More... | |
| struct | StreamingParameters |
| Structure containing the options used to stream with the ZED SDK. More... | |
| struct | RecordingParameters |
| Structure containing the options used to record. More... | |
| struct | DeviceProperties |
| Structure containing information about the properties of a camera. More... | |
| struct | StreamingProperties |
| Structure containing information about the properties of a streaming device. More... | |
| class | InitParameters |
| Class containing the options used to initialize the sl::Camera object. More... | |
| struct | EncodedStreamPacket |
| Single encoded video packet retrieved from a Camera source. More... | |
| struct | EncodedStreamInfo |
| Describes one encoded video source exposed by the Camera. More... | |
| struct | RawBufferFd |
| Validity-tracked handle to a native DMA buffer (dmabuf) file descriptor from the camera capture pool. More... | |
| struct | RawBuffer |
| Zero-copy wrapper for native camera capture buffers. More... | |
| class | Camera |
| This class serves as the primary interface between the camera and the various features provided by the SDK. More... | |
| class | InitParametersOne |
| Class containing the options used to initialize the sl::CameraOne object. More... | |
| class | InputType |
| Class defining the input type used in the ZED SDK. More... | |
Enumerations | |
| enum class | SVO_ENCODING_PRESET |
| Lists available encoding presets for SVO recording. More... | |
| enum class | SIDE |
| Lists possible sides on which to get data from. More... | |
| enum | FLIP_MODE : int |
| Lists possible flip modes of the camera. More... | |
| enum class | RESOLUTION |
| Lists available resolutions. More... | |
| enum class | VIDEO_SETTINGS |
| Lists available camera settings for the camera (contrast, hue, saturation, gain, ...). More... | |
| enum class | VIEW |
| Lists available views. More... | |
| enum class | SVO_COMPRESSION_MODE |
| Lists available compression modes for SVO recording. More... | |
| enum class | RAW_BUFFER_TYPE |
| Lists the types of native raw buffers supported by RawBuffer. More... | |
| enum class | SENSOR_STATE |
| Lists possible sensor states. More... | |
| enum class | MODEL |
| Lists ZED camera model. More... | |
| enum class | INPUT_TYPE |
| Lists available input types in the ZED SDK. More... | |
| enum class | CAMERA_STATE |
| Lists possible camera states. More... | |
| enum class | STREAMING_CODEC |
| Lists the different encoding types for image streaming. More... | |
| enum class | ENCODED_STREAM_SOURCE |
| Identifies which of the camera's encoded video paths to read from. More... | |
| enum class | BUS_TYPE |
| Lists available LIVE input type in the ZED SDK. More... | |
| enum class | TIMESTAMP_CLOCK |
| Lists available clock sources for SDK timestamps. More... | |
| enum class | TIME_REFERENCE |
| Lists possible time references for timestamps or data. More... | |
Functions | |
| sl::Resolution | getResolution (RESOLUTION resolution) |
| Gets the corresponding sl::Resolution from an sl::RESOLUTION. More... | |
| unsigned int SL_CORE_EXPORT | generateVirtualStereoSerialNumber (unsigned int serial_left, unsigned int serial_right) |
| Generate a unique identifier for virtual stereo based on the serial numbers of the two ZED Ones. More... | |
| void SL_CORE_EXPORT | setTimestampClock (TIMESTAMP_CLOCK clock) |
| Sets the clock source used for all SDK timestamps (images and sensors). More... | |
| TIMESTAMP_CLOCK SL_CORE_EXPORT | getTimestampClock () |
| Returns the clock source currently used for SDK timestamps. More... | |
| void SL_CORE_EXPORT | setMaxSystemClockStepMs (float limit_ms) |
| Sets the maximum system-clock step (in milliseconds) the SDK will follow per sample when the host clock is adjusted backward (NTP/PTP step, manual date change). More... | |
| float SL_CORE_EXPORT | getMaxSystemClockStepMs () |
| Returns the current system-clock step clamp in milliseconds (see setMaxSystemClockStepMs). More... | |
|
strong |
Lists available encoding presets for SVO recording.
The preset controls the speed/quality tradeoff of the hardware encoder.
|
strong |
| enum FLIP_MODE : int |
Lists possible flip modes of the camera.
|
strong |
Lists available resolutions.
|
strong |
Lists available camera settings for the camera (contrast, hue, saturation, gain, ...).
| Enumerator | |
|---|---|
| BRIGHTNESS | Brightness control
|
| CONTRAST | Contrast control
|
| HUE | Hue control
|
| SATURATION | Saturation control |
| SHARPNESS | Digital sharpening control |
| GAMMA | ISP gamma control |
| GAIN | Gain control
|
| EXPOSURE | Exposure control
|
| AEC_AGC | Defines if the GAIN and EXPOSURE are in automatic mode or not. |
| AEC_AGC_ROI | Defines the region of interest for automatic exposure/gain computation. |
| WHITEBALANCE_TEMPERATURE | Color temperature control
|
| WHITEBALANCE_AUTO | Defines if the white balance is in automatic mode or not. |
| LED_STATUS | Status of the front LED of the camera.
|
| EXPOSURE_TIME | Exposure time of the sensor in microseconds.
|
| ANALOG_GAIN | Analog gain (sensor) control in mDB.
|
| DIGITAL_GAIN | Digital gain (ISP) as a factor.
|
| AUTO_EXPOSURE_TIME_RANGE | Range of exposure auto control in microseconds.
|
| AUTO_ANALOG_GAIN_RANGE | Range of sensor gain in automatic control.
|
| AUTO_DIGITAL_GAIN_RANGE | Range of digital ISP gain in automatic control.
|
| EXPOSURE_COMPENSATION | Exposure-target compensation made after auto exposure.
|
| DENOISING | Level of denoising applied on both left and right images.
|
| SCENE_ILLUMINANCE | Level of illuminance of the scene calculated by the ISP.
|
| AE_ANTIBANDING | AE anti-banding mode.
|
| COLOR_CORRECTION_MATRIX | Color correction matrix, converting the sensor RGB values to linear sRGB.
|
|
strong |
Lists available views.
| Enumerator | |
|---|---|
| LEFT | Left (for stereo or default for monocular camera) BGRA image. Each pixel contains 4 unsigned char (B, G, R, A). |
| RIGHT | Right BGRA image. Each pixel contains 4 unsigned char (B, G, R, A). |
| LEFT_GRAY | Left gray image. Each pixel contains 1 unsigned char. |
| RIGHT_GRAY | Right gray image. Each pixel contains 1 unsigned char. |
| LEFT_NV12_UNRECTIFIED | Left NV12 unrectified image. |
| RIGHT_NV12_UNRECTIFIED | Right NV12 unrectified image. |
| LEFT_UNRECTIFIED | Left BGRA unrectified image. Each pixel contains 4 unsigned char (B, G, R, A). |
| RIGHT_UNRECTIFIED | Right BGRA unrectified image. Each pixel contains 4 unsigned char (B, G, R, A). |
| LEFT_UNRECTIFIED_GRAY | Left gray unrectified image. Each pixel contains 1 unsigned char. |
| RIGHT_UNRECTIFIED_GRAY | Right gray unrectified image. Each pixel contains 1 unsigned char. |
| SIDE_BY_SIDE | Left and right image (the image width is therefore doubled). Each pixel contains 4 unsigned char (B, G, R, A). |
| DEPTH | Color rendering of the depth. Each pixel contains 4 unsigned char (B, G, R, A).
|
| CONFIDENCE | Color rendering of the depth confidence. Each pixel contains 4 unsigned char (B, G, R, A).
|
| NORMALS | Color rendering of the normals. Each pixel contains 4 unsigned char (B, G, R, A).
|
| DEPTH_RIGHT | Color rendering of the right depth mapped on right sensor. Each pixel contains 4 unsigned char (B, G, R, A).
|
| NORMALS_RIGHT | Color rendering of the normals mapped on right sensor. Each pixel contains 4 unsigned char (B, G, R, A).
|
| LEFT_BGRA | Alias of sl::VIEW::LEFT. |
| LEFT_BGR | Left image in BGR pixel format: Type: sl::MAT_TYPE::U8_C3 |
| RIGHT_BGRA | Alias of sl::VIEW::RIGHT. |
| RIGHT_BGR | Right image in BGR pixel format: Type: sl::MAT_TYPE::U8_C3 |
| LEFT_UNRECTIFIED_BGRA | Alias of sl::VIEW::LEFT_UNRECTIFIED. |
| LEFT_UNRECTIFIED_BGR | Left unrectified image in BGR pixel format: Type: sl::MAT_TYPE::U8_C3 |
| RIGHT_UNRECTIFIED_BGRA | Alias of sl::VIEW::RIGHT_UNRECTIFIED. |
| RIGHT_UNRECTIFIED_BGR | Right unrectified image in BGR pixel format: Type: sl::MAT_TYPE::U8_C3 |
| SIDE_BY_SIDE_BGRA | Alias of sl::VIEW::SIDE_BY_SIDE. |
| SIDE_BY_SIDE_BGR | Side by side image in BGR pixel format: Type: sl::MAT_TYPE::U8_C3 |
| SIDE_BY_SIDE_GRAY | Side by side image in gray scale: Type: sl::MAT_TYPE::U8_C1 |
| SIDE_BY_SIDE_UNRECTIFIED_BGRA | Alias of sl::VIEW::SIDE_BY_SIDE_UNRECTIFIED. |
| SIDE_BY_SIDE_UNRECTIFIED_BGR | Side by side unrectified image in BGR pixel format: Type: sl::MAT_TYPE::U8_C3 |
| SIDE_BY_SIDE_UNRECTIFIED_GRAY | Side by side unrectified image in gray scale: Type: sl::MAT_TYPE::U8_C1 |
| DEPTH_BGRA | Alias of sl::VIEW::DEPTH. |
| DEPTH_BGR | Depth image in BGR pixel format: Type: sl::MAT_TYPE::U8_C3 |
| DEPTH_GRAY | Depth image in gray scale: Type: sl::MAT_TYPE::U8_C1 |
| CONFIDENCE_BGRA | Alias of sl::VIEW::CONFIDENCE. |
| CONFIDENCE_BGR | Confidence image in BGR pixel format: Type: sl::MAT_TYPE::U8_C3 |
| CONFIDENCE_GRAY | Confidence image in gray scale: Type: sl::MAT_TYPE::U8_C1 |
| NORMALS_BGRA | Alias of sl::VIEW::NORMALS. |
| NORMALS_BGR | Normal image in BGR pixel format: Type: sl::MAT_TYPE::U8_C3 |
| NORMALS_GRAY | Normal image in gray scale: Type: sl::MAT_TYPE::U8_C1 |
| DEPTH_RIGHT_BGRA | Alias of sl::VIEW::DEPTH_RIGHT. |
| DEPTH_RIGHT_BGR | Depth right image in BGR pixel format: Type: sl::MAT_TYPE::U8_C3 |
| DEPTH_RIGHT_GRAY | Depth right image in gray scale: Type: sl::MAT_TYPE::U8_C1 |
| NORMALS_RIGHT_BGRA | Alias of sl::VIEW::NORMALS_RIGHT. |
| NORMALS_RIGHT_BGR | Normal right image in BGR pixel format: Type: sl::MAT_TYPE::U8_C3 |
| NORMALS_RIGHT_GRAY | Normal right image in gray scale: Type: sl::MAT_TYPE::U8_C1 |
| LEFT_NV12 | Left NV12 rectified image (YUV 4:2:0 semi-planar). |
| RIGHT_NV12 | Right NV12 rectified image (YUV 4:2:0 semi-planar). |
|
strong |
Lists available compression modes for SVO recording.
|
strong |
Lists the types of native raw buffers supported by RawBuffer.
| Enumerator | |
|---|---|
| UNKNOWN | Unknown or uninitialized buffer type. |
| NVBUFSURFACE | NvBufSurface (Argus native buffer) |
|
strong |
|
strong |
Lists ZED camera model.
|
strong |
Lists available input types in the ZED SDK.
| Enumerator | |
|---|---|
| USB | USB input mode |
| SVO | SVO file input mode |
| STREAM | STREAM input mode (requires to use enableStreaming() / disableStreaming()" on the "sender" side) |
| GMSL | GMSL input mode (only on NVIDIA Jetson) |
| MIPI | MIPI input mode, for a camera connected directly to a MIPI capture card (only on NVIDIA Jetson) |
| HOLOSCAN | Holoscan Camera-over-Ethernet input mode, through a Holoscan sensor bridge (only on NVIDIA Jetson) |
|
strong |
|
strong |
|
strong |
Identifies which of the camera's encoded video paths to read from.
A single Camera can produce up to three concurrent encoded H264/H265 bitstreams: the incoming stream when the camera is opened from a network sender (ENCODED_STREAM_SOURCE::RECEIVING), the outgoing stream when Camera::enableStreaming() is active (ENCODED_STREAM_SOURCE::SENDING), and the SVO encoder output when Camera::enableRecording() is active with a video compression mode (ENCODED_STREAM_SOURCE::RECORDING). Each source has its own codec, bitrate and key-frame schedule.
| Enumerator | |
|---|---|
| RECEIVING | Incoming stream packets (Camera opened with INPUT_TYPE::STREAM). |
| SENDING | Outgoing stream packets (enableStreaming() is active). |
| RECORDING | SVO encoder output (enableRecording() with H264 / H265 compression mode). |
| LAST | Sentinel. |
|
strong |
Lists available LIVE input type in the ZED SDK.
|
strong |
Lists available clock sources for SDK timestamps.
Selects the clock used internally by the SDK to timestamp images and sensor data. Both image and IMU timestamps always use the same selected clock, ensuring coherent results.
| Enumerator | |
|---|---|
| SYSTEM_CLOCK | Timestamps use the system (wall-clock) time via
|
| MONOTONIC_CLOCK | Timestamps use a monotonic clock (
|
| MONOTONIC_RAW_CLOCK | Timestamps use the raw monotonic clock ( |
|
strong |
Lists possible time references for timestamps or data.
| Enumerator | |
|---|---|
| IMAGE | The requested timestamp or data will be at the time of the frame extraction. |
| CURRENT | The requested timestamp or data will be at the time of the function call. |
| IMAGE_CENTER_OF_EXPOSURE | The middle of the frame's integration window: the instant the "average photon" of the frame reached the sensor. IMAGE is anchored at the start of the sensor readout, which is the moment the frame's integration ends*; this reference therefore sits half an exposure earlier** than IMAGE. Use it to align frames with other sensors (LiDAR, IMU, robot joints) that are timestamped at the instant they measure.
|
| sl::Resolution sl::getResolution | ( | RESOLUTION | resolution | ) |
Gets the corresponding sl::Resolution from an sl::RESOLUTION.
| resolution | : The wanted sl::RESOLUTION. |
| unsigned int SL_CORE_EXPORT sl::generateVirtualStereoSerialNumber | ( | unsigned int | serial_left, |
| unsigned int | serial_right | ||
| ) |
Generate a unique identifier for virtual stereo based on the serial numbers of the two ZED Ones.
| serial_left | : Serial number of the left camera. |
| serial_right | : Serial number of the right camera. |
| void SL_CORE_EXPORT sl::setTimestampClock | ( | TIMESTAMP_CLOCK | clock | ) |
Sets the clock source used for all SDK timestamps (images and sensors).
| clock | : The desired TIMESTAMP_CLOCK. |
| TIMESTAMP_CLOCK SL_CORE_EXPORT sl::getTimestampClock | ( | ) |
Returns the clock source currently used for SDK timestamps.
| void SL_CORE_EXPORT sl::setMaxSystemClockStepMs | ( | float | limit_ms | ) |
Sets the maximum system-clock step (in milliseconds) the SDK will follow per sample when the host clock is adjusted backward (NTP/PTP step, manual date change).
Only meaningful in TIMESTAMP_CLOCK::SYSTEM_CLOCK mode; it has no effect in TIMESTAMP_CLOCK::MONOTONIC_CLOCK or TIMESTAMP_CLOCK::MONOTONIC_RAW_CLOCK mode where timestamps are monotonic by construction. Forward clock movement always passes through unchanged.
| limit_ms | : Clamp threshold in milliseconds.
|
Cheat sheet:**
| Setup | Recommended value |
|---|---|
| Desktop with systemd-timesyncd (slew-only) | default |
PTP with ptp4l --step_threshold=0 (slew-only) | default |
| PTP with step corrections expected | -1.0f |
| Deterministic timestamps, ignore the host clock entirely | use TIMESTAMP_CLOCK::MONOTONIC_CLOCK instead |
| Same as above, also immune to NTP/PTP frequency slewing | use TIMESTAMP_CLOCK::MONOTONIC_RAW_CLOCK instead |
ZED_SDK_MAX_SYSTEM_CLOCK_STEP_MS, when set, always wins over this setter, an ops-side override for incident debugging. The setter logs a warning the first time it is called while the env var is forcing a different value. Call before opening any camera for the setting to apply from the first sample. | float SL_CORE_EXPORT sl::getMaxSystemClockStepMs | ( | ) |
Returns the current system-clock step clamp in milliseconds (see setMaxSystemClockStepMs).