C API References
Defines
-
Status
Enums
Functions
-
ArducamDepthCamera createArducamDepthCamera()
Create a camera instance.
- Returns
Return a ArducamDepthCamera instance.
-
Status arducamCameraOpen(ArducamDepthCamera camera, Connection conn, int path)
Initialize the camera configuration and turn on the camera, set the initialization frame according to the type.
- Parameters
camera – Camera instance, obtained through createArducamDepthCamera().
path – Device node, the default value is video0.
- Returns
Return Status code.
-
Status arducamCameraClose(ArducamDepthCamera *camera)
Close camera.
- Parameters
camera – Camera instance.
- Returns
Return Status code.
-
Status arducamCameraStart(ArducamDepthCamera camera, FrameType type)
Start the camera stream and start processing.
- Parameters
camera – Camera instance.
- Returns
Return Status code.
-
Status arducamCameraStop(ArducamDepthCamera camera)
Stop camera stream and processing.
- Parameters
camera – Camera instance.
type – Type of camera output frame.
- Returns
Return Status code.
-
FrameFormat arducamCameraGetFormat(ArducamFrameBuffer fb, FrameType type)
Get the format of the specified frame.
- Parameters
camera – Frame instance.
format – Frame type. This parameter can be one of the following values:
RAW_FRAME
AMPLITUDE_FRAME
DEPTH_FRAME
- Returns
Return frame format.
-
ArducamFrameBuffer arducamCameraRequestFrame(ArducamDepthCamera camera, int timeout)
Read frame from the camera.
- Parameters
camera – Camera instance.
timeout – Timeout time, -1 means to wait all the time, 0 means immediate range, other values indicate the maximum waiting time, the unit is milliseconds.
- Returns
Return Status code.
-
Status arducamCameraReleaseFrame(ArducamDepthCamera camera, ArducamFrameBuffer fb)
Release the ArducamFrameBuffer.
- Parameters
camera – Camera instance.
fb – ArducamFrameBuffer.
- Returns
Return Status code.
-
void *arducamCameraGetDepthData(ArducamFrameBuffer fb)
Read depth data from the frame.
Note
The output mode is the depth type, and the function can be called to obtain data
- Parameters
fb – dataframe object.
- Returns
Return Status code.
-
void *arducamCameraGetAmplitudeData(ArducamFrameBuffer fb)
Read depth data from the frame.
Note
The output mode is the depth type, and the function can be called to obtain data.
- Parameters
fb – dataframe object.
- Returns
Return Status code.
-
void *arducamCameraGetRawData(ArducamFrameBuffer fb)
Read raw data from the frame.
Note
The output mode is the raw type, and the function can be called to obtain data.
- Parameters
fb – dataframe object.
- Returns
Return Status code.
-
struct FrameFormat
- #include <ArducamDepthCamera.h>
Description of frame data format.