ColorCamera (JavaCPP Presets for DepthAI 2.21.2-1.5.9 API)

java.lang.Object
- org.bytedeco.javacpp.Pointer
- - org.bytedeco.depthai.Node
  - - org.bytedeco.depthai.ColorCameraPropertiesNode
    - - org.bytedeco.depthai.ColorCamera

All Implemented Interfaces:: AutoCloseable

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

\brief ColorCamera node. For use with color 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
`ColorCamera(PipelineImpl par, long nodeId)` Constructs ColorCamera node.
`ColorCamera(PipelineImpl par, long nodeId, ColorCameraProperties props)`
`ColorCamera(Pointer p)` Pointer cast constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated 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
`BytePointer`	`getCamera()` Retrieves which camera to use by name
`long`	`getCamId()` Deprecated.
`ColorCameraProperties.ColorOrder`	`getColorOrder()` Get color order of preview output frames.
`boolean`	`getFp16()` Get fp16 (0..255) data of preview output frames
`float`	`getFps()` Get rate at which camera should produce frames
`IntPointer`	`getFrameEventFilter()`
`depthai.CameraImageOrientation`	`getImageOrientation()` Get camera image orientation
`boolean`	`getInterleaved()` Get planar or interleaved data of preview output frames
`int`	`getIspHeight()` Get 'isp' output height
`int`	`getIspNumFramesPool()` Get number of frames in isp pool
`Pointer`	`getIspSize()` Get 'isp' output resolution as size, after scaling
`int`	`getIspWidth()` Get 'isp' output width
`int`	`getPreviewHeight()` Get preview height
`boolean`	`getPreviewKeepAspectRatio()`
`int`	`getPreviewNumFramesPool()` Get number of frames in preview pool
`Pointer`	`getPreviewSize()` Get preview size as tuple
`int`	`getPreviewWidth()` Get preview width
`int`	`getRawNumFramesPool()` Get number of frames in raw pool
`ColorCameraProperties.SensorResolution`	`getResolution()` Get sensor resolution
`int`	`getResolutionHeight()` Get sensor resolution height
`Pointer`	`getResolutionSize()` Get sensor resolution as size
`int`	`getResolutionWidth()` Get sensor resolution width
`int`	`getScaledSize(int input, int num, int denom)` Computes the scaled size given numerator and denominator
`Pointer`	`getSensorCrop()`
`float`	`getSensorCropX()` Get sensor top left x crop coordinate
`float`	`getSensorCropY()` Get sensor top left y crop coordinate
`int`	`getStillHeight()` Get still height
`int`	`getStillNumFramesPool()` Get number of frames in still pool
`Pointer`	`getStillSize()` Get still size as tuple
`int`	`getStillWidth()` Get still width
`int`	`getVideoHeight()` Get video height
`int`	`getVideoNumFramesPool()` Get number of frames in video pool
`Pointer`	`getVideoSize()` Get video size as tuple
`int`	`getVideoWidth()` Get video width
`boolean`	`getWaitForConfigInput()` Deprecated.
`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.
`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`	`sensorCenterCrop()` Specify sensor center crop.
`void`	`setBoardSocket(depthai.CameraBoardSocket boardSocket)` Specify which board socket to use
`void`	`setBoardSocket(int boardSocket)`
`void`	`setCamera(ByteBuffer name)`
`void`	`setCamera(BytePointer name)` Specify which camera to use by name
`void`	`setCamera(String name)`
`void`	`setCamId(long id)` Deprecated.
`void`	`setColorOrder(ColorCameraProperties.ColorOrder colorOrder)` Set color order of preview output images.
`void`	`setColorOrder(int colorOrder)`
`void`	`setFp16(boolean fp16)` Set fp16 (0..255) data type of preview output frames
`void`	`setFps(float fps)` Set rate at which camera should produce frames
`void`	`setFrameEventFilter(int[] events)`
`void`	`setFrameEventFilter(IntBuffer events)`
`void`	`setFrameEventFilter(IntPointer events)`
`void`	`setImageOrientation(depthai.CameraImageOrientation imageOrientation)` Set camera image orientation
`void`	`setImageOrientation(int imageOrientation)`
`void`	`setInterleaved(boolean interleaved)` Set planar or interleaved data of preview output frames
`void`	`setIsp3aFps(int isp3aFps)` Isp 3A rate (auto focus, auto exposure, auto white balance, camera controls etc.).
`void`	`setIspNumFramesPool(int num)` Set number of frames in isp pool
`void`	`setIspScale(int numerator, int denominator)` Set 'isp' output scaling (numerator/denominator), preserving the aspect ratio.
`void`	`setIspScale(int horizNum, int horizDenom, int vertNum, int vertDenom)` Set 'isp' output scaling, per each direction.
`void`	`setIspScale(Pointer scale)` Set 'isp' output scaling, as a tuple
`void`	`setIspScale(Pointer horizScale, Pointer vertScale)` Set 'isp' output scaling, per each direction, as tuples
`void`	`setNumFramesPool(int raw, int isp, int preview, int video, int still)` Set number of frames in all pools
`void`	`setPreviewKeepAspectRatio(boolean keep)` Specifies whether preview output should preserve aspect ratio, after downscaling from video size or not.
`void`	`setPreviewNumFramesPool(int num)` Set number of frames in preview pool
`void`	`setPreviewSize(int width, int height)` Set preview output size
`void`	`setPreviewSize(Pointer size)` Set preview output size, as a tuple
`void`	`setRawNumFramesPool(int num)` Set number of frames in raw pool
`void`	`setResolution(ColorCameraProperties.SensorResolution resolution)` Set sensor resolution
`void`	`setSensorCrop(float x, float y)` Specifies sensor crop rectangle
`void`	`setStillNumFramesPool(int num)` Set number of frames in preview pool
`void`	`setStillSize(int width, int height)` Set still output size
`void`	`setStillSize(Pointer size)` Set still output size, as a tuple
`void`	`setVideoNumFramesPool(int num)` Set number of frames in preview pool
`void`	`setVideoSize(int width, int height)` Set video output size
`void`	`setVideoSize(Pointer size)` Set video output size, as a tuple
`void`	`setWaitForConfigInput(boolean _wait)` Deprecated.
`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.ColorCameraPropertiesNode
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

ColorCamera
```
public ColorCamera(Pointer p)
```
Pointer cast constructor. Invokes Pointer(Pointer).

ColorCamera

public ColorCamera(@SharedPtr
                   PipelineImpl par,
                   @Cast(value="int64_t")
                   long nodeId)

Constructs ColorCamera node.

ColorCamera

public ColorCamera(@SharedPtr
                   PipelineImpl par,
                   @Cast(value="int64_t")
                   long nodeId,
                   @UniquePtr
                   ColorCameraProperties props)

Method Detail
- NAME
```
@MemberGetter
 @Cast(value="const char*")
public static BytePointer NAME()
```
- getScaledSize
```
public int getScaledSize(int input,
                         int num,
                         int denom)
```
  Computes the scaled size given numerator and denominator
- 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
- setCamId
```
@Deprecated
public void setCamId(@Cast(value="int64_t")
                                 long id)
```
  Deprecated.
  
  Set which color camera to use
- getCamId
```
@Cast(value="int64_t")
 @Deprecated
public long getCamId()
```
  Deprecated.
  
  Get which color 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
- setColorOrder
```
public void setColorOrder(ColorCameraProperties.ColorOrder colorOrder)
```
  Set color order of preview output images. RGB or BGR
- setColorOrder
```
public void setColorOrder(@Cast(value="dai::ColorCameraProperties::ColorOrder")
                          int colorOrder)
```
- getColorOrder
```
public ColorCameraProperties.ColorOrder getColorOrder()
```
  Get color order of preview output frames. RGB or BGR
- setInterleaved
```
public void setInterleaved(@Cast(value="bool")
                           boolean interleaved)
```
  Set planar or interleaved data of preview output frames
- getInterleaved
```
@Cast(value="bool")
public boolean getInterleaved()
```
  Get planar or interleaved data of preview output frames
- setFp16
```
public void setFp16(@Cast(value="bool")
                    boolean fp16)
```
  Set fp16 (0..255) data type of preview output frames
- getFp16
```
@Cast(value="bool")
public boolean getFp16()
```
  Get fp16 (0..255) data of preview output frames
- 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
- setPreviewNumFramesPool
```
public void setPreviewNumFramesPool(int num)
```
  Set number of frames in preview pool
- 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
- setVideoNumFramesPool
```
public void setVideoNumFramesPool(int num)
```
  Set number of frames in preview pool
- 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
- setStillNumFramesPool
```
public void setStillNumFramesPool(int num)
```
  Set number of frames in preview pool
- setResolution
```
public void setResolution(@ByVal
                          ColorCameraProperties.SensorResolution resolution)
```
  Set sensor resolution
- getResolution
```
@ByVal
public ColorCameraProperties.SensorResolution getResolution()
```
  Get sensor resolution
- setRawNumFramesPool
```
public void setRawNumFramesPool(int num)
```
  Set number of frames in raw pool
- setIspNumFramesPool
```
public void setIspNumFramesPool(int num)
```
  Set number of frames in isp pool
- setNumFramesPool
```
public void setNumFramesPool(int raw,
                             int isp,
                             int preview,
                             int video,
                             int still)
```
  Set number of frames in all pools
- setIspScale
```
public void setIspScale(int numerator,
                        int denominator)
```
  Set 'isp' output scaling (numerator/denominator), preserving the aspect ratio. The fraction numerator/denominator is simplified first to a irreducible form, then a set of hardware scaler constraints applies: max numerator = 16, max denominator = 63
- setIspScale
```
public void setIspScale(@ByVal @Cast(value="std::tuple<int,int>*")
                        Pointer scale)
```
  Set 'isp' output scaling, as a tuple
- setIspScale
```
public void setIspScale(int horizNum,
                        int horizDenom,
                        int vertNum,
                        int vertDenom)
```
  Set 'isp' output scaling, per each direction. If the horizontal scaling factor (horizNum/horizDen) is different than the vertical scaling factor (vertNum/vertDen), a distorted (stretched or squished) image is generated
- setIspScale
```
public void setIspScale(@ByVal @Cast(value="std::tuple<int,int>*")
                        Pointer horizScale,
                        @ByVal @Cast(value="std::tuple<int,int>*")
                        Pointer vertScale)
```
  Set 'isp' output scaling, per each direction, as tuples
- 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.
- setFrameEventFilter
```
public void setFrameEventFilter(@StdVector @Cast(value="dai::FrameEvent*")
                                IntPointer events)
```
- setFrameEventFilter
```
public void setFrameEventFilter(@StdVector @Cast(value="dai::FrameEvent*")
                                IntBuffer events)
```
- setFrameEventFilter
```
public void setFrameEventFilter(@StdVector @Cast(value="dai::FrameEvent*")
                                int[] events)
```
- getFrameEventFilter
```
@StdVector
 @Cast(value="dai::FrameEvent*")
public IntPointer getFrameEventFilter()
```
- 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
- getResolutionSize
```
@ByVal
 @Cast(value="std::tuple<int,int>*")
public Pointer getResolutionSize()
```
  Get sensor resolution as size
- getResolutionWidth
```
public int getResolutionWidth()
```
  Get sensor resolution width
- getResolutionHeight
```
public int getResolutionHeight()
```
  Get sensor resolution height
- getIspSize
```
@ByVal
 @Cast(value="std::tuple<int,int>*")
public Pointer getIspSize()
```
  Get 'isp' output resolution as size, after scaling
- getIspWidth
```
public int getIspWidth()
```
  Get 'isp' output width
- getIspHeight
```
public int getIspHeight()
```
  Get 'isp' output height
- sensorCenterCrop
```
public void sensorCenterCrop()
```
  Specify sensor center crop. Resolution size / video size
- setSensorCrop
```
public void setSensorCrop(float x,
                          float y)
```
  Specifies sensor crop rectangle
  
  Parameters:
  
  x - Top left X coordinate
  
  y - Top left Y coordinate
- getSensorCrop
```
@ByVal
 @Cast(value="std::tuple<float,float>*")
public Pointer getSensorCrop()
```
  Returns:
  
  Sensor top left crop coordinates
- getSensorCropX
```
public float getSensorCropX()
```
  Get sensor top left x crop coordinate
- getSensorCropY
```
public float getSensorCropY()
```
  Get sensor top left y crop coordinate
- setWaitForConfigInput
```
@Deprecated
public void setWaitForConfigInput(@Cast(value="bool")
                                              boolean _wait)
```
  Deprecated.
  
  Specify to wait until inputConfig receives a configuration message, before sending out a frame.
  
  Parameters:
  
  wait - True to wait for inputConfig message, false otherwise
- getWaitForConfigInput
```
@Cast(value="bool")
 @Deprecated
public boolean getWaitForConfigInput()
```
  Deprecated.
  
  Returns:
  
  True if wait for inputConfig message, false otherwise
  
  See Also:
  
  setWaitForConfigInput
- setPreviewKeepAspectRatio
```
public void setPreviewKeepAspectRatio(@Cast(value="bool")
                                      boolean keep)
```
  Specifies whether preview output should preserve aspect ratio, after downscaling from video size or not.
  
  Parameters:
  
  keep - If true, a larger crop region will be considered to still be able to create the final image in the specified aspect ratio. Otherwise video size is resized to fit preview size
- getPreviewKeepAspectRatio
```
@Cast(value="bool")
public boolean getPreviewKeepAspectRatio()
```
  Returns:
  
  Preview keep aspect ratio option
  
  See Also:
  
  setPreviewKeepAspectRatio
- getPreviewNumFramesPool
```
public int getPreviewNumFramesPool()
```
  Get number of frames in preview pool
- getVideoNumFramesPool
```
public int getVideoNumFramesPool()
```
  Get number of frames in video pool
- getStillNumFramesPool
```
public int getStillNumFramesPool()
```
  Get number of frames in still pool
- getRawNumFramesPool
```
public int getRawNumFramesPool()
```
  Get number of frames in raw pool
- getIspNumFramesPool
```
public int getIspNumFramesPool()
```
  Get number of frames in isp pool

Class ColorCamera

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.ColorCameraPropertiesNode

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

ColorCamera

ColorCamera

ColorCamera

Method Detail

NAME

getScaledSize

initialControl

inputConfig

inputControl

video

preview

still

isp

raw

frameEvent

setBoardSocket

setBoardSocket

getBoardSocket

setCamera

setCamera

setCamera

getCamera

setCamId

getCamId

setImageOrientation

setImageOrientation

getImageOrientation

setColorOrder

setColorOrder

getColorOrder

setInterleaved

getInterleaved

setFp16

getFp16

setPreviewSize

setPreviewSize

setPreviewNumFramesPool

setVideoSize

setVideoSize

setVideoNumFramesPool

setStillSize

setStillSize

setStillNumFramesPool

setResolution

getResolution

setRawNumFramesPool

setIspNumFramesPool

setNumFramesPool

setIspScale

setIspScale

setIspScale

setIspScale

setFps

setIsp3aFps

setFrameEventFilter

setFrameEventFilter

setFrameEventFilter

getFrameEventFilter

getFps

getPreviewSize

getPreviewWidth

getPreviewHeight

getVideoSize

getVideoWidth

getVideoHeight

getStillSize

getStillWidth