Camera (JavaCPP Presets for DepthAI 2.24.0-1.5.10 API)

java.lang.Object
- org.bytedeco.javacpp.Pointer
- - org.bytedeco.depthai.Node
  - - org.bytedeco.depthai.CameraPropertiesNode
    - - org.bytedeco.depthai.Camera

All Implemented Interfaces:: AutoCloseable

@Namespace(value="dai::node")
 @NoOffset
 @Properties(inherit=depthai.class)
public class Camera
extends CameraPropertiesNode

\brief Camera node. Experimental node, for both mono and color types of sensors

Nested Class Summary
- Nested classes/interfaces inherited from class org.bytedeco.depthai.Node
  Node.Connection, Node.DatatypeHierarchy, Node.Input, Node.InputMap, Node.Output, Node.OutputMap
- Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer
  Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary
- Fields inherited from class org.bytedeco.javacpp.Pointer
  address, capacity, limit, position

Constructor Summary

Constructors
Constructor and Description
`Camera(PipelineImpl par, long nodeId)` Constructs Camera node.
`Camera(PipelineImpl par, long nodeId, CameraProperties props)`
`Camera(Pointer p)` Pointer cast constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Node.Output`	`frameEvent()` Outputs metadata-only ImgFrame message as an early indicator of an incoming frame.
`depthai.CameraBoardSocket`	`getBoardSocket()` Retrieves which board socket to use
`FloatOptional`	`getCalibrationAlpha()` Get calibration alpha parameter that determines FOV of undistorted frames
`BytePointer`	`getCamera()` Retrieves which camera to use by name
`float`	`getFps()` Get rate at which camera should produce frames
`int`	`getHeight()` Get sensor resolution height
`depthai.CameraImageOrientation`	`getImageOrientation()` Get camera image orientation
`CameraProperties.WarpMeshSource`	`getMeshSource()` Gets the source of the warp mesh
`Pointer`	`getMeshStep()` Gets the distance between mesh points
`int`	`getPreviewHeight()` Get preview height
`Pointer`	`getPreviewSize()` Get preview size as tuple
`int`	`getPreviewWidth()` Get preview width
`Pointer`	`getSize()` Get sensor resolution as size
`int`	`getStillHeight()` Get still height
`Pointer`	`getStillSize()` Get still size as tuple
`int`	`getStillWidth()` Get still width
`int`	`getVideoHeight()` Get video height
`Pointer`	`getVideoSize()` Get video size as tuple
`int`	`getVideoWidth()` Get video width
`int`	`getWidth()` Get sensor resolution width
`CameraControl`	`initialControl()` Initial control options to apply to sensor
`Node.Input`	`inputConfig()` Input for ImageManipConfig message, which can modify crop parameters in runtime Default queue is non-blocking with size 8
`Node.Input`	`inputControl()` Input for CameraControl message, which can modify camera parameters in runtime Default queue is blocking with size 8
`Node.Output`	`isp()` Outputs ImgFrame message that carries YUV420 planar (I420/IYUV) frame data.
`void`	`loadMeshFile(Path warpMesh)` Specify local filesystem paths to the undistort mesh calibration files.
`static BytePointer`	`NAME()`
`Node.Output`	`preview()` Outputs ImgFrame message that carries BGR/RGB planar/interleaved encoded frame data.
`Node.Output`	`raw()` Outputs ImgFrame message that carries RAW10-packed (MIPI CSI-2 format) frame data.
`void`	`setBoardSocket(depthai.CameraBoardSocket boardSocket)` Specify which board socket to use
`void`	`setBoardSocket(int boardSocket)`
`void`	`setCalibrationAlpha(float alpha)` Set calibration alpha parameter that determines FOV of undistorted frames
`void`	`setCamera(ByteBuffer name)`
`void`	`setCamera(BytePointer name)` Specify which camera to use by name
`void`	`setCamera(String name)`
`void`	`setFps(float fps)` Set rate at which camera should produce frames
`void`	`setImageOrientation(depthai.CameraImageOrientation imageOrientation)` Set camera image orientation
`void`	`setImageOrientation(int imageOrientation)`
`void`	`setIsp3aFps(int isp3aFps)` Isp 3A rate (auto focus, auto exposure, auto white balance, camera controls etc.).
`void`	`setMeshSource(CameraProperties.WarpMeshSource source)` Set the source of the warp mesh or disable
`void`	`setMeshStep(int width, int height)` Set the distance between mesh points.
`void`	`setPreviewSize(int width, int height)` Set preview output size
`void`	`setPreviewSize(Pointer size)` Set preview output size, as a tuple
`void`	`setRawOutputPacked(boolean packed)` Configures whether the camera `raw` frames are saved as MIPI-packed to memory.
`void`	`setSize(int width, int height)` Set desired resolution.
`void`	`setSize(Pointer size)` Set desired resolution.
`void`	`setStillSize(int width, int height)` Set still output size
`void`	`setStillSize(Pointer size)` Set still output size, as a tuple
`void`	`setVideoSize(int width, int height)` Set video output size
`void`	`setVideoSize(Pointer size)` Set video output size, as a tuple
`Node.Output`	`still()` Outputs ImgFrame message that carries NV12 encoded (YUV420, UV plane interleaved) frame data.
`Node.Output`	`video()` Outputs ImgFrame message that carries NV12 encoded (YUV420, UV plane interleaved) frame data.

Methods inherited from class org.bytedeco.depthai.CameraPropertiesNode
clone, getName, properties, properties

Methods inherited from class org.bytedeco.depthai.Node
assetManager, getAssetManager, getInputRefs, getInputs, getOutputRefs, getOutputs, getParentPipeline, getProperties, getRequiredOpenVINOVersion, id, inputMapRefs, inputRefs, outputMapRefs, outputRefs, propertiesHolder, setInputMapRefs, setInputRefs, setOutputMapRefs, setOutputRefs

Methods inherited from class org.bytedeco.javacpp.Pointer
address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getDirectBufferAddress, getPointer, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Camera
```
public Camera(Pointer p)
```
    Pointer cast constructor. Invokes Pointer(Pointer).
  - Camera
```
public Camera(@SharedPtr
              PipelineImpl par,
              @Cast(value="int64_t")
              long nodeId)
```
    Constructs Camera node.
  - Camera
```
public Camera(@SharedPtr
              PipelineImpl par,
              @Cast(value="int64_t")
              long nodeId,
              @UniquePtr
              CameraProperties props)
```
- Method Detail
  - NAME
```
@MemberGetter
 @Cast(value="const char*")
public static BytePointer NAME()
```
  - initialControl
```
@MemberGetter
 @ByRef
public CameraControl initialControl()
```
    Initial control options to apply to sensor
  - inputConfig
```
@MemberGetter
 @ByRef
public Node.Input inputConfig()
```
    Input for ImageManipConfig message, which can modify crop parameters in runtime Default queue is non-blocking with size 8
  - inputControl
```
@MemberGetter
 @ByRef
public Node.Input inputControl()
```
    Input for CameraControl message, which can modify camera parameters in runtime Default queue is blocking with size 8
  - video
```
@MemberGetter
 @ByRef
public Node.Output video()
```
    Outputs ImgFrame message that carries NV12 encoded (YUV420, UV plane interleaved) frame data. Suitable for use with VideoEncoder node
  - preview
```
@MemberGetter
 @ByRef
public Node.Output preview()
```
    Outputs ImgFrame message that carries BGR/RGB planar/interleaved encoded frame data. Suitable for use with NeuralNetwork node
  - still
```
@MemberGetter
 @ByRef
public Node.Output still()
```
    Outputs ImgFrame message that carries NV12 encoded (YUV420, UV plane interleaved) frame data. The message is sent only when a CameraControl message arrives to inputControl with captureStill command set.
  - isp
```
@MemberGetter
 @ByRef
public Node.Output isp()
```
    Outputs ImgFrame message that carries YUV420 planar (I420/IYUV) frame data. Generated by the ISP engine, and the source for the 'video', 'preview' and 'still' outputs
  - raw
```
@MemberGetter
 @ByRef
public Node.Output raw()
```
    Outputs ImgFrame message that carries RAW10-packed (MIPI CSI-2 format) frame data. Captured directly from the camera sensor, and the source for the 'isp' output.
  - frameEvent
```
@MemberGetter
 @ByRef
public Node.Output frameEvent()
```
    Outputs metadata-only ImgFrame message as an early indicator of an incoming frame. It's sent on the MIPI SoF (start-of-frame) event, just after the exposure of the current frame has finished and before the exposure for next frame starts. Could be used to synchronize various processes with camera capture. Fields populated: camera id, sequence number, timestamp
  - setBoardSocket
```
public void setBoardSocket(depthai.CameraBoardSocket boardSocket)
```
    Specify which board socket to use
    
    Parameters:
    
    boardSocket - Board socket to use
  - setBoardSocket
```
public void setBoardSocket(@Cast(value="dai::CameraBoardSocket")
                           int boardSocket)
```
  - getBoardSocket
```
public depthai.CameraBoardSocket getBoardSocket()
```
    Retrieves which board socket to use
    
    Returns:
    
    Board socket to use
  - setCamera
```
public void setCamera(@StdString
                      BytePointer name)
```
    Specify which camera to use by name
    
    Parameters:
    
    name - Name of the camera to use
  - setCamera
```
public void setCamera(@StdString
                      ByteBuffer name)
```
  - setCamera
```
public void setCamera(@StdString
                      String name)
```
  - getCamera
```
@StdString
public BytePointer getCamera()
```
    Retrieves which camera to use by name
    
    Returns:
    
    Name of the camera to use
  - setImageOrientation
```
public void setImageOrientation(depthai.CameraImageOrientation imageOrientation)
```
    Set camera image orientation
  - setImageOrientation
```
public void setImageOrientation(@Cast(value="dai::CameraImageOrientation")
                                int imageOrientation)
```
  - getImageOrientation
```
public depthai.CameraImageOrientation getImageOrientation()
```
    Get camera image orientation
  - setSize
```
public void setSize(@ByVal @Cast(value="std::tuple<int,int>*")
                    Pointer size)
```
    Set desired resolution. Sets sensor size to best fit
  - setSize
```
public void setSize(int width,
                    int height)
```
    Set desired resolution. Sets sensor size to best fit
  - setPreviewSize
```
public void setPreviewSize(int width,
                           int height)
```
    Set preview output size
  - setPreviewSize
```
public void setPreviewSize(@ByVal @Cast(value="std::tuple<int,int>*")
                           Pointer size)
```
    Set preview output size, as a tuple
  - setVideoSize
```
public void setVideoSize(int width,
                         int height)
```
    Set video output size
  - setVideoSize
```
public void setVideoSize(@ByVal @Cast(value="std::tuple<int,int>*")
                         Pointer size)
```
    Set video output size, as a tuple
  - setStillSize
```
public void setStillSize(int width,
                         int height)
```
    Set still output size
  - setStillSize
```
public void setStillSize(@ByVal @Cast(value="std::tuple<int,int>*")
                         Pointer size)
```
    Set still output size, as a tuple
  - setFps
```
public void setFps(float fps)
```
    Set rate at which camera should produce frames
    
    Parameters:
    
    fps - Rate in frames per second
  - setIsp3aFps
```
public void setIsp3aFps(int isp3aFps)
```
    Isp 3A rate (auto focus, auto exposure, auto white balance, camera controls etc.). Default (0) matches the camera FPS, meaning that 3A is running on each frame. Reducing the rate of 3A reduces the CPU usage on CSS, but also increases the convergence rate of 3A. Note that camera controls will be processed at this rate. E.g. if camera is running at 30 fps, and camera control is sent at every frame, but 3A fps is set to 15, the camera control messages will be processed at 15 fps rate, which will lead to queueing.
  - getFps
```
public float getFps()
```
    Get rate at which camera should produce frames
    
    Returns:
    
    Rate in frames per second
  - getPreviewSize
```
@ByVal
 @Cast(value="std::tuple<int,int>*")
public Pointer getPreviewSize()
```
    Get preview size as tuple
  - getPreviewWidth
```
public int getPreviewWidth()
```
    Get preview width
  - getPreviewHeight
```
public int getPreviewHeight()
```
    Get preview height
  - getVideoSize
```
@ByVal
 @Cast(value="std::tuple<int,int>*")
public Pointer getVideoSize()
```
    Get video size as tuple
  - getVideoWidth
```
public int getVideoWidth()
```
    Get video width
  - getVideoHeight
```
public int getVideoHeight()
```
    Get video height
  - getStillSize
```
@ByVal
 @Cast(value="std::tuple<int,int>*")
public Pointer getStillSize()
```
    Get still size as tuple
  - getStillWidth
```
public int getStillWidth()
```
    Get still width
  - getStillHeight
```
public int getStillHeight()
```
    Get still height
  - getSize
```
@ByVal
 @Cast(value="std::tuple<int,int>*")
public Pointer getSize()
```
    Get sensor resolution as size
  - getWidth
```
public int getWidth()
```
    Get sensor resolution width
  - getHeight
```
public int getHeight()
```
    Get sensor resolution height
  - setMeshSource
```
public void setMeshSource(@ByVal
                          CameraProperties.WarpMeshSource source)
```
    Set the source of the warp mesh or disable
  - getMeshSource
```
@ByVal
public CameraProperties.WarpMeshSource getMeshSource()
```
    Gets the source of the warp mesh
  - loadMeshFile
```
public void loadMeshFile(@Const @ByRef
                         Path warpMesh)
```
    Specify local filesystem paths to the undistort mesh calibration files. When a mesh calibration is set, it overrides the camera intrinsics/extrinsics matrices. Overrides useHomographyRectification behavior. Mesh format: a sequence of (y,x) points as 'float' with coordinates from the input image to be mapped in the output. The mesh can be subsampled, configured by setMeshStep. With a 1280x800 resolution and the default (16,16) step, the required mesh size is: width: 1280 / 16 + 1 = 81 height: 800 / 16 + 1 = 51
  - setMeshStep
```
public void setMeshStep(int width,
                        int height)
```
    Set the distance between mesh points. Default: (32, 32)
  - getMeshStep
```
@ByVal
 @Cast(value="std::tuple<int,int>*")
public Pointer getMeshStep()
```
    Gets the distance between mesh points
  - setCalibrationAlpha
```
public void setCalibrationAlpha(float alpha)
```
    Set calibration alpha parameter that determines FOV of undistorted frames
  - getCalibrationAlpha
```
@ByVal
public FloatOptional getCalibrationAlpha()
```
    Get calibration alpha parameter that determines FOV of undistorted frames
  - setRawOutputPacked
```
public void setRawOutputPacked(@Cast(value="bool")
                               boolean packed)
```
    Configures whether the camera raw frames are saved as MIPI-packed to memory. The packed format is more efficient, consuming less memory on device, and less data to send to host: RAW10: 4 pixels saved on 5 bytes, RAW12: 2 pixels saved on 3 bytes. When packing is disabled (false), data is saved lsb-aligned, e.g. a RAW10 pixel will be stored as uint16, on bits 9..0: 0b0000'00pp'pppp'pppp. Default is auto: enabled for standard color/monochrome cameras where ISP can work with both packed/unpacked, but disabled for other cameras like ToF.

Class Camera

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.depthai.Node

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.bytedeco.depthai.CameraPropertiesNode

Methods inherited from class org.bytedeco.depthai.Node

Methods inherited from class org.bytedeco.javacpp.Pointer

Methods inherited from class java.lang.Object

Constructor Detail

Camera

Camera

Camera

Method Detail

NAME

initialControl

inputConfig

inputControl

video

preview

still

isp

raw

frameEvent

setBoardSocket

setBoardSocket

getBoardSocket

setCamera

setCamera

setCamera

getCamera

setImageOrientation

setImageOrientation

getImageOrientation

setSize

setSize

setPreviewSize

setPreviewSize

setVideoSize

setVideoSize

setStillSize

setStillSize

setFps

setIsp3aFps

getFps

getPreviewSize

getPreviewWidth

getPreviewHeight

getVideoSize

getVideoWidth

getVideoHeight

getStillSize

getStillWidth

getStillHeight

getSize

getWidth

getHeight

setMeshSource

getMeshSource

loadMeshFile

setMeshStep

getMeshStep

setCalibrationAlpha

getCalibrationAlpha

setRawOutputPacked