#include <dji_camera_module.hpp>

Inheritance diagram for DJI::OSDK::CameraModule:

Classes
struct	ApertureAck
	Response data struct of aperture, used in internal link layer. More...

struct	ApertureReq
	Requesting to set aperture parameter, used in internal link layer. More...

struct	CaptureParamAck
	Response data of take photo mode. More...

struct	CaptureParamData
	Take photo mode parameters. More...

struct	CaptureParamReq
	Request data to take photo mode. More...

struct	CommonAck
	It is the common ack of Open Protocol CMD DJI::OSDK::CameraModule::FunctionID. All the ack data from this CMD will include the ack struct. More...

struct	ExposureCompensationAck
	Response data struct of exposure compensation, used in internal link layer. More...

struct	ExposureCompensationReq
	Requesting to set Exposure compensation, used in internal link layer. More...

struct	ExposureModeAck
	Response data struct of exposure mode, used in internal link layer. More...

struct	ExposureModeReq
	Requesting exposure mode, used in internal link layer. More...

struct	FloatPoint
	2D float point data struct More...

struct	FloatPointReq
	Requesting to set the target point of some functions , used in internal link layer. More...

struct	FocusModeAck
	Response data struct of focus mode, used in internal link layer. More...

struct	FocusModeReq
	Requesting focus mode, used in internal link layer. More...

struct	ISOParamAck
	Response data struct of ISO parameter, used in internal link layer. More...

struct	ISOParamReq
	Requesting to set ISO parameter, used in internal link layer. More...

struct	PhotoIntervalData
	Interval take photo mode setting. More...

struct	RecordVideoReq
	Request data to record video mode. More...

struct	ShootPhotoReq
	Requesting take photo mode, used in internal link layer. More...

struct	ShutterAck
	Response data struct of shutter, used in internal link layer. More...

struct	ShutterParamType
	Shutter data struct. More...

struct	ShutterReq
	Requesting to set shutter parameter, used in internal link layer. More...

struct	TapFocusPosAck
	Response data struct of tap focus target parameter, used in internal link layer. More...

struct	TapZoomEnableAck
	Response data struct of tap zoom enable parameter, used in internal link layer. More...

struct	TapZoomEnableReq
	Requesting to set tap zoom enable, used in internal link layer. More...

struct	UCBRetCodeHandler
	type of callback only deal the retCode for user More...

struct	UCBRetParamStruct
	struct of callback deal the param and retCode for user More...

struct	WorkModeAck
	Responsing CameraModule working mode data, used in internal link layer. More...

struct	WorkModeReq
	Requesting CameraModule working mode data, used in internal link layer. More...

struct	zoomOptiParamReq
	Requesting optical zoom, used in internal link layer. More...

struct	zoomOptiParamType
	Data struct of optical zoom parameters. More...

Public Types
enum	WorkMode { SHOOT_PHOTO = 0, RECORD_VIDEO = 1, PLAYBACK = 2, MEDIA_DOWNLOAD = 3, BROADCAST = 4, WORK_MODE_UNKNOWN = 0xFF }
	CameraModule work modes. More...

enum	ShootPhotoMode { SINGLE = DJI_CAMERA_TAKE_PHOTO_TYPE_NORMAL, HDR = DJI_CAMERA_TAKE_PHOTO_TYPE_HDR, BURST = DJI_CAMERA_TAKE_PHOTO_TYPE_BURST, AEB = DJI_CAMERA_TAKE_PHOTO_TYPE_AEB, INTERVAL = DJI_CAMERA_TAKE_PHOTO_TYPE_TIME_LAPSE, RAW_BURST = DJI_CAMERA_TAKE_PHOTO_TYPE_RAW_BURST, EHDR = DJI_CAMERA_TAKE_PHOTO_TYPE_EHDR, REGIONAL_SR = 0x16, SHOOT_PHOTO_MODE_UNKNOWN = 0xFF }
	The ShootPhoto mode itself can have several modes. The default value is SINGLE. More...

enum	ContiCapMode { CONTI_CAP_SINGLE = 0, CONTI_CAP_MULTIPLE, CONTI_CAP_TIMELAPSE = 2 }
	the photo action of INTERVAL shooting photo mode More...

enum	ExposureMode { PROGRAM_AUTO = 1, SHUTTER_PRIORITY = 2, APERTURE_PRIORITY = 3, EXPOSURE_MANUAL = 4, EXPOSURE_UNKNOWN = 0xFF }
	the photo action of INTERVAL shooting photo mode More...

enum	PhotoAEBCount { AEB_COUNT_3 = 3, AEB_COUNT_5 = 5, AEB_COUNT_7 = 7, AEB_COUNT_KNOWN = 0xFF }
	the photo action of INTERVAL shooting photo mode More...

enum	PhotoBurstCount { BURST_COUNT_2 = 2, BURST_COUNT_3 = 3, BURST_COUNT_5 = 5, BURST_COUNT_7 = 7, BURST_COUNT_10 = 10, BURST_COUNT_14 = 14, BURST_COUNT_KNOWN = 0xFF }

enum	FocusMode { MANUAL = 0, AUTO = 1, AFC = 2, FOCUS_MODE_UNKNOWN = 0xFFFF }

enum	ShutterMode { SHUTTER_AUTO_MODE = 0x00, SHUTTER_MANUAL_MODE = 0x01 }

enum	ShutterSpeed { SHUTTER_SPEED_1_8000 = 0, SHUTTER_SPEED_1_6400 = 1, SHUTTER_SPEED_1_6000 = 2, SHUTTER_SPEED_1_5000 = 3, SHUTTER_SPEED_1_4000 = 4, SHUTTER_SPEED_1_3200 = 5, SHUTTER_SPEED_1_3000 = 6, SHUTTER_SPEED_1_2500 = 7, SHUTTER_SPEED_1_2000 = 8, SHUTTER_SPEED_1_1600 = 9, SHUTTER_SPEED_1_1500 = 10, SHUTTER_SPEED_1_1250 = 11, SHUTTER_SPEED_1_1000 = 12, SHUTTER_SPEED_1_800 = 13, SHUTTER_SPEED_1_725 = 14, SHUTTER_SPEED_1_640 = 15, SHUTTER_SPEED_1_500 = 16, SHUTTER_SPEED_1_400 = 17, SHUTTER_SPEED_1_350 = 18, SHUTTER_SPEED_1_320 = 19, SHUTTER_SPEED_1_250 = 20, SHUTTER_SPEED_1_240 = 21, SHUTTER_SPEED_1_200 = 22, SHUTTER_SPEED_1_180 = 23, SHUTTER_SPEED_1_160 = 24, SHUTTER_SPEED_1_125 = 25, SHUTTER_SPEED_1_120 = 26, SHUTTER_SPEED_1_100 = 27, SHUTTER_SPEED_1_90 = 28, SHUTTER_SPEED_1_80 = 29, SHUTTER_SPEED_1_60 = 30, SHUTTER_SPEED_1_50 = 31, SHUTTER_SPEED_1_40 = 32, SHUTTER_SPEED_1_30 = 33, SHUTTER_SPEED_1_25 = 34, SHUTTER_SPEED_1_20 = 35, SHUTTER_SPEED_1_15 = 36, SHUTTER_SPEED_1_12DOT5 = 37, SHUTTER_SPEED_1_10 = 38, SHUTTER_SPEED_1_8 = 39, SHUTTER_SPEED_1_6DOT25 = 40, SHUTTER_SPEED_1_5 = 41, SHUTTER_SPEED_1_4 = 42, SHUTTER_SPEED_1_3 = 43, SHUTTER_SPEED_1_2DOT5 = 44, SHUTTER_SPEED_1_2 = 45, SHUTTER_SPEED_1_1DOT67 = 46, SHUTTER_SPEED_1_1DOT25 = 47, SHUTTER_SPEED_1 = 48, SHUTTER_SPEED_1DOT3 = 49, SHUTTER_SPEED_1DOT6 = 50, SHUTTER_SPEED_2 = 51, SHUTTER_SPEED_2DOT5 = 52, SHUTTER_SPEED_3 = 53, SHUTTER_SPEED_3DOT2 = 54, SHUTTER_SPEED_4 = 55, SHUTTER_SPEED_5 = 56, SHUTTER_SPEED_6 = 57, SHUTTER_SPEED_7 = 58, SHUTTER_SPEED_8 = 59, SHUTTER_SPEED_9 = 60, SHUTTER_SPEED_10 = 61, SHUTTER_SPEED_13 = 62, SHUTTER_SPEED_15 = 63, SHUTTER_SPEED_20 = 64, SHUTTER_SPEED_25 = 65, SHUTTER_SPEED_30 = 66, SHUTTER_SPEED_UNKNOWN = 0xFF }
	CameraModule shutter speed values. More...

enum	ISO { ISO_AUTO = DJI_CAMERA_ISO_PARAMETER_AUTO, ISO_100 = DJI_CAMERA_ISO_PARAMETER_100, ISO_200 = DJI_CAMERA_ISO_PARAMETER_200, ISO_400 = DJI_CAMERA_ISO_PARAMETER_400, ISO_800 = DJI_CAMERA_ISO_PARAMETER_800, ISO_1600 = DJI_CAMERA_ISO_PARAMETER_1600, ISO_3200 = DJI_CAMERA_ISO_PARAMETER_3200, ISO_6400 = DJI_CAMERA_ISO_PARAMETER_6400, ISO_12800 = DJI_CAMERA_ISO_PARAMETER_12800, ISO_25600 = DJI_CAMERA_ISO_PARAMETER_25600, ISO_FIXED = DJI_CAMERA_ISO_PARAMETER_FIXED, ISO_UNKNOWN = 0xFFFF }
	CameraModule ISO values. More...

enum	ExposureCompensation { N_5_0 = 1, N_4_7 = 2, N_4_3 = 3, N_4_0 = 4, N_3_7 = 5, N_3_3 = 6, N_3_0 = 7, N_2_7 = 8, N_2_3 = 9, N_2_0 = 10, N_1_7 = 11, N_1_3 = 12, N_1_0 = 13, N_0_7 = 14, N_0_3 = 15, N_0_0 = 16, P_0_3 = 17, P_0_7 = 18, P_1_0 = 19, P_1_3 = 20, P_1_7 = 21, P_2_0 = 22, P_2_3 = 23, P_2_7 = 24, P_3_0 = 25, P_3_3 = 26, P_3_7 = 27, P_4_0 = 28, P_4_3 = 29, P_4_7 = 30, P_5_0 = 31, FIXED = 0xFF, UNKNOWN = 0xFFFF }
	CameraModule exposure compensation. More...

enum	FunctionID { FUNCTION_SIMPLE_SHOT = 0, FUNCTION_RECORD_VIDEO = 1, FUNCTION_SET_WORKING_MODE = 3, FUNCTION_GET_WORKING_MODE = 4, FUNCTION_SET_FOCUS_PARAMETER = 7, FUNCTION_SET_EXPOSURE_MODE = 8, FUNCTION_GET_EXPOSURE_MODE = 9, FUNCTION_SET_FOCUS_MODE = 10, FUNCTION_GET_FOCUS_MODE = 11, FUNCTION_SET_EV_PARAMETER = 12, FUNCTION_GET_EV_PARAMETER = 13, FUNCTION_GET_FOCUS_PARAMETER = 14, FUNCTION_SET_POINT_ZOOM_MODE = 15, FUNCTION_GET_POINT_ZOOM_MODE = 16, FUNCTION_POINT_ZOOM_CTRL = 17, FUNCTION_SET_ZOOM_PARAMETER = 19, FUNCTION_GET_ZOOM_PARAMETER = 20, FUNCTION_SET_ISO_PARAMETER = 22, FUNCTION_GET_ISO_PARAMETER = 23, FUNCTION_SET_SHUTTER_SPEED = 24, FUNCTION_GET_SHUTTER_SPEED = 25, FUNCTION_SET_APERTURE_SIZE = 26, FUNCTION_GET_APERTURE_SIZE = 27, FUNCTION_SET_METERING_MODE = 28, FUNCTION_GET_METERING_MODE = 29, FUNCTION_SET_SPOT_FOCUS_AERA = 30, FUNCTION_GET_SPOT_FOCUS_AERA = 31, FUNCTION_SET_SHOT_MODE = 32, FUNCTION_GET_SHOT_MODE = 33, FUNCTION_CONTROL_OPTIZOOM = 34 }
	the function ID of camera used in the CMD OpenProtocolCMD::CMDSet::Control::cameraExtraFunction

enum	Aperture { F_1_DOT_6 = 160, F_1_DOT_7 = 170, F_1_DOT_8 = 180, F_2 = 200, F_2_DOT_2 = 220, F_2_DOT_4 = 240, F_2_DOT_5 = 250, F_2_DOT_6 = 260, F_2_DOT_8 = 280, F_3_DOT_2 = 320, F_3_DOT_4 = 340, F_3_DOT_5 = 350, F_4 = 400, F_4_DOT_5 = 450, F_4_DOT_8 = 480, F_5 = 500, F_5_DOT_6 = 560, F_6_DOT_3 = 630, F_6_DOT_8 = 680, F_7_DOT_1 = 710, F_8 = 800, F_9 = 900, F_9_DOT_6 = 960, F_10 = 1000, F_11 = 1100, F_13 = 1300, F_14 = 1400, F_16 = 1600, F_18 = 1800, F_19 = 1900, F_20 = 2000, F_22 = 2200, F_UNKNOWN = 0xFFFF }
	CameraModule aperture values. More...

enum	ZoomDirection { ZOOM_OUT = 0, ZOOM_IN = 1 }

enum	ZoomSpeed { SLOWEST = 72, SLOW = 73, MODERATELY_SLOW = 74, NORMAL = 75, MODERATELY_FAST = 76, FAST = 77, FASTEST = 78 }

enum	DJI_CAMERA_FOCUS_MODE { DJI_CAMERA_FOCUS_MODE_MANUAL = 0, DJI_CAMERA_FOCUS_MODE_SHOT_AF = 1, DJI_CAMERA_FOCUS_MODE_CONTIN_AF = 2, DJI_CAMERA_FOCUS_MODE_MANUAL_FINE = 3 }

enum	DJI_CAMERA_DJPH1_CALIBRATE_RESULT { DJI_CAMERA_DJPH1_CALIBRATE_RESULT_IDLE = 0, DJI_CAMERA_DJPH1_CALIBRATE_RESULT_SUCCESS = 1, DJI_CAMERA_DJPH1_CALIBRATE_RESULT_TOOCLOSE = 2 }

enum	DJI_X5_CAMERA_PROTOCOL_TYPE { DJI_X5_CAMERA_PROTOCOL_TYPE_DEFAULT = 0, DJI_X5_CAMERA_PROTOCOL_TYPE_ASSISTANT_FOCUS = 1, DJI_X5_CAMERA_PROTOCOL_TYPE_CMODE = 2 }

enum	DJI_CAMERA_CONTI_CAP_TYPE : uint8_t { DJI_CAMERA_CONTI_CAP_TYPE_SINGLE = 0, DJI_CAMERA_CONTI_CAP_TYPE_MULTIPLE = 1, DJI_CAMERA_CONTI_CAP_TYPE_TIMELAPSE = 2 }

typedef struct DJI::OSDK::CameraModule::dji_camera_focus_area_struct	dji_camera_focus_area_struct

typedef struct DJI::OSDK::CameraModule::dji_camera_aperture_range	dji_camera_aperture_range

typedef struct DJI::OSDK::CameraModule::dji_camera_assist_digital_zoom_para	dji_camera_assist_digital_zoom_para

typedef struct DJI::OSDK::CameraModule::dji_camera_real_focus_area_struct	dji_camera_real_focus_area_struct

typedef struct DJI::OSDK::CameraModule::dji_camera_focusing_state	dji_camera_focusing_state

typedef struct DJI::OSDK::CameraModule::dji_camera_lens_state	dji_camera_lens_state

typedef struct DJI::OSDK::CameraModule::dji_camera_len_para_push	dji_camera_len_para_push

typedef struct DJI::OSDK::CameraModule::CommonAck	CommonAck
	It is the common ack of Open Protocol CMD DJI::OSDK::CameraModule::FunctionID. All the ack data from this CMD will include the ack struct.

typedef uint8_t	ShootPhotoModeData
	Take photo mode data used by user. More...

typedef uint8_t	PhotoAEBCountData
	Take photo mode data used by user.ref to DJI::OSDK::CameraModule::PhotoAEBCount.

typedef uint8_t	PhotoNumBurstData
	Take photo mode data used by user.ref to DJI::OSDK::CameraModule::PhotoBurstCount.

typedef struct DJI::OSDK::CameraModule::PhotoIntervalData	PhotoIntervalData
	Interval take photo mode setting.

typedef struct DJI::OSDK::CameraModule::CaptureParamData	CaptureParamData
	Take photo mode parameters.

typedef struct DJI::OSDK::CameraModule::dji_camera_timelapse_capture_with_ms	dji_camera_timelapse_capture_with_ms

typedef struct DJI::OSDK::CameraModule::CaptureParamReq	CaptureParamReq
	Request data to take photo mode.

typedef struct DJI::OSDK::CameraModule::CaptureParamAck	CaptureParamAck
	Response data of take photo mode.

typedef struct DJI::OSDK::CameraModule::RecordVideoReq	RecordVideoReq
	Request data to record video mode.

typedef uint8_t	WorkModeData
	CameraModule working mode data used by user. More...

typedef struct DJI::OSDK::CameraModule::WorkModeReq	WorkModeReq
	Requesting CameraModule working mode data, used in internal link layer.

typedef struct DJI::OSDK::CameraModule::WorkModeAck	WorkModeAck
	Responsing CameraModule working mode data, used in internal link layer.

typedef struct DJI::OSDK::CameraModule::ShootPhotoReq	ShootPhotoReq
	Requesting take photo mode, used in internal link layer.

typedef uint8_t	FocusModeData
	Focus mode data used by user. More...

typedef struct DJI::OSDK::CameraModule::FocusModeReq	FocusModeReq
	Requesting focus mode, used in internal link layer.

typedef struct DJI::OSDK::CameraModule::FocusModeAck	FocusModeAck
	Response data struct of focus mode, used in internal link layer.

typedef uint8_t	ExposureModeData
	Exposure mode data used by user. More...

typedef struct DJI::OSDK::CameraModule::ExposureModeReq	ExposureModeReq
	Requesting exposure mode, used in internal link layer.

typedef struct DJI::OSDK::CameraModule::ExposureModeAck	ExposureModeAck
	Response data struct of exposure mode, used in internal link layer.

typedef uint8_t	zoomDirectionData
	Zoom direction data used by user, ref to DJI::OSDK::CameraModule::ZoomDirection.

typedef uint8_t	zoomSpeedData
	Zoom speed data used by user, ref to DJI::OSDK::CameraModule::ZoomSpeed.

typedef struct DJI::OSDK::CameraModule::zoomOptiParamType	zoomOptiParamType
	Data struct of optical zoom parameters.

typedef struct DJI::OSDK::CameraModule::zoom_config_t	zoom_config_t

typedef union DJI::OSDK::CameraModule::zoom_param_t	zoom_param_t

typedef struct DJI::OSDK::CameraModule::camera_zoom_data_type	camera_zoom_data_type

typedef struct DJI::OSDK::CameraModule::zoomOptiParamReq	zoomOptiParamReq
	Requesting optical zoom, used in internal link layer.

typedef uint8_t	TapZoomEnableData
	Data struct of tap zoom enabled used by user.

typedef uint8_t	TapZoomMultiplierData
	Data struct of tap zoom multiplier used by user. Limit: 1~5.

typedef struct DJI::OSDK::CameraModule::TapZoomEnableReq	TapZoomEnableReq
	Requesting to set tap zoom enable, used in internal link layer.

typedef struct DJI::OSDK::CameraModule::TapZoomEnableAck	TapZoomEnableAck
	Response data struct of tap zoom enable parameter, used in internal link layer.

typedef struct DJI::OSDK::CameraModule::FloatPoint	FloatPoint
	2D float point data struct

typedef FloatPoint	TapZoomPosData
	Tap zoom target point data struct, used by user.

typedef FloatPoint	TapFocusPosData
	Tap focus target point data struct, used by user.

typedef struct DJI::OSDK::CameraModule::FloatPointReq	FloatPointReq
	Requesting to set the target point of some functions , used in internal link layer.

typedef FloatPointReq	TapZoomPosReq
	Requesting to set the target of tapzoom , used in internal link layer.

typedef FloatPointReq	TapFocusPosReq
	Requesting to set the target of tapfocus , used in internal link layer.

typedef struct DJI::OSDK::CameraModule::TapFocusPosAck	TapFocusPosAck
	Response data struct of tap focus target parameter, used in internal link layer.

typedef uint8_t	ISOParamData
	ISO data used by user. More...

typedef struct DJI::OSDK::CameraModule::ISOParamReq	ISOParamReq
	Requesting to set ISO parameter, used in internal link layer.

typedef struct DJI::OSDK::CameraModule::ISOParamAck	ISOParamAck
	Response data struct of ISO parameter, used in internal link layer.

typedef uint16_t	ApertureData
	Aperture size data used by user. ref to DJI::OSDK::CameraModule::Aperture.

typedef struct DJI::OSDK::CameraModule::ApertureReq	ApertureReq
	Requesting to set aperture parameter, used in internal link layer.

typedef struct DJI::OSDK::CameraModule::ApertureAck	ApertureAck
	Response data struct of aperture, used in internal link layer.

typedef struct DJI::OSDK::CameraModule::ShutterParamType	ShutterSpeedType
	Shutter data struct.

typedef uint8_t	ShutterSpeedData
	Shutter data type used by user. ref to DJI::OSDK::CameraModule::ShutterSpeed.

typedef struct DJI::OSDK::CameraModule::ShutterReq	ShutterReq
	Requesting to set shutter parameter, used in internal link layer.

typedef struct DJI::OSDK::CameraModule::ShutterAck	ShutterAck
	Response data struct of shutter, used in internal link layer.

typedef uint8_t	ExposureCompensationData
	Exposure compensation data type used by user. More...

typedef struct DJI::OSDK::CameraModule::ExposureCompensationReq	ExposureCompensationReq
	Requesting to set Exposure compensation, used in internal link layer.

typedef struct DJI::OSDK::CameraModule::ExposureCompensationAck	ExposureCompensationAck
	Response data struct of exposure compensation, used in internal link layer.

typedef struct DJI::OSDK::CameraModule::UCBRetCodeHandler	UCBRetCodeHandler
	type of callback only deal the retCode for user

template<typename T >
using	UCBRetParamHandler = UCBRetParamStruct< T >
	type of callback deal the param and retCode for user

typedef struct DJI::OSDK::CameraModule::LensInfoPacketType	LensInfoPacketType

Public Member Functions
	CameraModule (Linker *linker, PayloadIndexType payloadIndex, std::string name, bool enable)

void	startShootPhotoAsync (ShootPhotoMode mode, void(*UserCallBack)(ErrorCode::ErrorCodeType retCode, UserData userData), UserData userData)
	start to shoot photo, non-blocking calls More...

ErrorCode::ErrorCodeType	startShootPhotoSync (ShootPhotoMode mode, int timeout)
	start to shoot photo, blocking calls More...

void	stopShootPhotoAsync (void(*UserCallBack)(ErrorCode::ErrorCodeType retCode, UserData userData), UserData userData)
	stop to shoot photo, non-blocking calls More...

ErrorCode::ErrorCodeType	stopShootPhotoSync (int timeout)
	stop to shoot photo, blocking calls More...

void	setShootPhotoModeAsync (ShootPhotoMode takePhotoMode, void(*UserCallBack)(ErrorCode::ErrorCodeType retCode, UserData userData), UserData userData)
	set the shoot photo mode, non-blocking calls More...

ErrorCode::ErrorCodeType	setShootPhotoModeSync (ShootPhotoMode takePhotoMode, int timeout)
	set the shoot photo mode, blocking calls More...

void	getShootPhotoModeAsync (void(*UserCallBack)(ErrorCode::ErrorCodeType retCode, ShootPhotoMode takePhotoMode, UserData userData), UserData userData)
	get the shoot photo mode, non-blocking calls More...

ErrorCode::ErrorCodeType	getShootPhotoModeSync (ShootPhotoMode &takePhotoMode, int timeout)
	get the shoot photo mode, blocking calls More...

void	setPhotoBurstCountAsync (PhotoBurstCount count, void(*UserCallBack)(ErrorCode::ErrorCodeType retCode, UserData userData), UserData userData)
	set the burst count in the Burst take-photo mode, non-blocking calls More...

ErrorCode::ErrorCodeType	setPhotoBurstCountSync (PhotoBurstCount count, int timeout)
	set the burst count in the Burst take-photo mode, blocking calls More...

void	getPhotoBurstCountAsync (void(*UserCallBack)(ErrorCode::ErrorCodeType retCode, PhotoBurstCount count, UserData userData), UserData userData)

ErrorCode::ErrorCodeType	getPhotoBurstCountSync (PhotoBurstCount &count, int timeout)
	get the burst count in the Burst take-photo mode, blocking calls More...

void	setPhotoAEBCountAsync (PhotoAEBCount count, void(*UserCallBack)(ErrorCode::ErrorCodeType retCode, UserData userData), UserData userData)
	set the burst count in the AEB take-photo mode, non-blocking calls More...

ErrorCode::ErrorCodeType	setPhotoAEBCountSync (PhotoAEBCount count, int timeout)
	set the burst count in the AEB take-photo mode, blocking calls More...

void	getPhotoAEBCountAsync (void(*UserCallBack)(ErrorCode::ErrorCodeType retCode, PhotoAEBCount count, UserData userData), UserData userData)

ErrorCode::ErrorCodeType	getPhotoAEBCountSync (PhotoAEBCount &count, int timeout)
	get the burst count in the AEB take-photo mode, blocking calls More...

void	setPhotoTimeIntervalSettingsAsync (PhotoIntervalData intervalSetting, void(*UserCallBack)(ErrorCode::ErrorCodeType retCode, UserData userData), UserData userData)
	set the parameters in the INTERVAL take-photo mode, non-blocking calls More...

ErrorCode::ErrorCodeType	setPhotoTimeIntervalSettingsSync (PhotoIntervalData intervalSetting, int timeout)
	set the parameters in the INTERVAL take-photo mode, blocking calls More...

void	getPhotoIntervalDatasAsync (void(*UserCallBack)(ErrorCode::ErrorCodeType retCode, PhotoIntervalData intervalSetting, UserData userData), UserData userData)
	get the parameters in the INTERVAL take-photo mode, non-blocking calls More...

ErrorCode::ErrorCodeType	getPhotoIntervalDatasSync (PhotoIntervalData &intervalSetting, int timeout)
	get the parameters in the INTERVAL take-photo mode, blocking calls More...

void	startRecordVideoAsync (void(*UserCallBack)(ErrorCode::ErrorCodeType retCode, UserData userData), UserData userData)
	start to take video, non-blocking calls More...

ErrorCode::ErrorCodeType	startRecordVideoSync (int timeout)
	start to take video, blocking calls More...

void	stopRecordVideoAsync (void(*UserCallBack)(ErrorCode::ErrorCodeType retCode, UserData userData), UserData userData)
	stop to take video, non-blocking calls More...

ErrorCode::ErrorCodeType	stopRecordVideoSync (int timeout)
	stop to take video, blocking calls More...

void	setModeAsync (WorkMode mode, void(*UserCallBack)(ErrorCode::ErrorCodeType retCode, UserData userData), UserData userData)
	set camera working mode, non-blocking calls More...

ErrorCode::ErrorCodeType	setModeSync (WorkMode mode, int timeout)
	set camera working mode, blocking calls More...

void	getModeAsync (void(*UserCallBack)(ErrorCode::ErrorCodeType retCode, WorkMode workingMode, UserData userData), UserData userData)
	get camera working mode, non-blocking calls More...

ErrorCode::ErrorCodeType	getModeSync (WorkMode &workingMode, int timeout)
	get camera working mode, blocking calls More...

void	setFocusModeAsync (FocusMode mode, void(*UserCallBack)(ErrorCode::ErrorCodeType retCode, UserData userData), UserData userData)
	set camera focus mode, non-blocking calls More...

ErrorCode::ErrorCodeType	setFocusModeSync (FocusMode mode, int timeout)
	get camera focus mode, blocking calls More...

void	getFocusModeAsync (void(*UserCallBack)(ErrorCode::ErrorCodeType retCode, FocusMode mode, UserData userData), UserData userData)
	get camera focus mode, non-blocking calls More...

ErrorCode::ErrorCodeType	getFocusModeSync (FocusMode &focusMode, int timeout)
	get camera focus mode, blocking calls More...

void	setFocusTargetAsync (TapFocusPosData tapFocusPos, void(*UserCallBack)(ErrorCode::ErrorCodeType retCode, UserData userData), UserData userData)
	set camera tap focus target point, non-blocking calls More...

ErrorCode::ErrorCodeType	setFocusTargetSync (TapFocusPosData tapFocusPos, int timeout)
	set camera focus point, blocking calls More...

void	getFocusTargetAsync (void(*UserCallBack)(ErrorCode::ErrorCodeType, TapFocusPosData tapFocusPos, UserData userData), UserData userData)
	get camera tap focus target point, non-blocking calls More...

ErrorCode::ErrorCodeType	getFocusTargetSync (TapFocusPosData &tapFocusPos, int timeout)
	get camera focus point, blocking calls More...

void	startContinuousOpticalZoomAsync (zoomDirectionData zoomDirection, zoomSpeedData zoomSpeed, void(*UserCallBack)(ErrorCode::ErrorCodeType retCode, UserData userData), UserData userData)
	start camera optical zooming, non-blocking calls More...

ErrorCode::ErrorCodeType	startContinuousOpticalZoomSync (zoomDirectionData zoomDirection, zoomSpeedData zoomSpeed, int timeout)
	start camera optical zooming, blocking calls More...

ErrorCode::ErrorCodeType	setOpticalZoomFactorSync (float factor, int timeout)
	set parameters for camera optical zooming, blocking calls More...

ErrorCode::ErrorCodeType	getOpticalZoomFactorSync (float &factor, int timeout)
	get parameters of camera optical zooming, blocking calls More...

void	stopContinuousOpticalZoomAsync (void(*UserCallBack)(ErrorCode::ErrorCodeType retCode, UserData userData), UserData userData)
	stop camera optical zooming, non-blocking calls More...

ErrorCode::ErrorCodeType	stopContinuousOpticalZoomSync (int timeout)
	stop camera optical zooming, blocking calls More...

void	setTapZoomEnabledAsync (bool param, void(*UserCallBack)(ErrorCode::ErrorCodeType retCode, UserData userData), UserData userData)
	set camera tap zoom function parameters, non-blocking calls More...

ErrorCode::ErrorCodeType	setTapZoomEnabledSync (bool param, int timeout)
	set camera tap zoom parameters, blocking calls More...

void	getTapZoomEnabledAsync (void(*UserCallBack)(ErrorCode::ErrorCodeType retCode, bool param, UserData userData), UserData userData)
	get camera tap zoom function parameters, non-blocking calls More...

ErrorCode::ErrorCodeType	getTapZoomEnabledSync (bool &param, int timeout)
	get camera tap zoom parameters, blocking calls More...

void	setTapZoomMultiplierAsync (TapZoomMultiplierData param, void(*UserCallBack)(ErrorCode::ErrorCodeType retCode, UserData userData), UserData userData)
	set camera tap zoom function parameters, non-blocking calls More...

ErrorCode::ErrorCodeType	setTapZoomMultiplierSync (TapZoomMultiplierData param, int timeout)
	set camera tap zoom parameters, blocking calls More...

void	getTapZoomMultiplierAsync (void(*UserCallBack)(ErrorCode::ErrorCodeType retCode, TapZoomMultiplierData param, UserData userData), UserData userData)
	get camera tap zoom function parameters, non-blocking calls More...

ErrorCode::ErrorCodeType	getTapZoomMultiplierSync (TapZoomMultiplierData &param, int timeout)
	get camera tap zoom parameters, blocking calls More...

void	tapZoomAtTargetAsync (TapZoomPosData tapZoomPos, void(*UserCallBack)(ErrorCode::ErrorCodeType retCode, UserData userData), UserData userData)
	set camera tap zoom point, non-blocking calls More...

ErrorCode::ErrorCodeType	tapZoomAtTargetSync (TapZoomPosData tapZoomPos, int timeout)
	set camera tap zoom point, blocking calls More...

void	setExposureModeAsync (ExposureMode mode, void(*UserCallBack)(ErrorCode::ErrorCodeType retCode, UserData userData), UserData userData)
	set camera exposure mode, non-blocking calls More...

ErrorCode::ErrorCodeType	setExposureModeSync (ExposureMode mode, int timeout)
	set camera exposure mode, blocking calls More...

void	getExposureModeAsync (void(*UserCallBack)(ErrorCode::ErrorCodeType retCode, ExposureMode mode, UserData userData), UserData userData)
	get camera exposure mode, non-blocking calls More...

ErrorCode::ErrorCodeType	getExposureModeSync (ExposureMode &mode, int timeout)
	get camera exposure mode, blocking calls More...

void	setISOAsync (ISO iso, void(*UserCallBack)(ErrorCode::ErrorCodeType retCode, UserData userData), UserData userData)
	set camera iso value, non-blocking calls More...

ErrorCode::ErrorCodeType	setISOSync (ISO iso, int timeout)
	set camera iso value, blocking calls More...

void	getISOAsync (void(*UserCallBack)(ErrorCode::ErrorCodeType, ISO iso, UserData userData), UserData userData)
	get camera iso value, non-blocking calls More...

ErrorCode::ErrorCodeType	getISOSync (ISO &iso, int timeout)
	get camera iso value, blocking calls More...

void	setApertureAsync (Aperture size, void(*UserCallBack)(ErrorCode::ErrorCodeType retCode, UserData userData), UserData userData)
	set camera aperture size value, non-blocking calls More...

ErrorCode::ErrorCodeType	setApertureSync (Aperture size, int timeout)
	set camera aperture size value, blocking calls More...

void	getApertureAsync (void(*UserCallBack)(ErrorCode::ErrorCodeType, Aperture size, UserData userData), UserData userData)
	get camera aperture size value, non-blocking calls More...

ErrorCode::ErrorCodeType	getApertureSync (Aperture &size, int timeout)
	get camera aperture size value, blocking calls More...

void	setShutterSpeedAsync (ShutterSpeed shutterSpeed, void(*UserCallBack)(ErrorCode::ErrorCodeType retCode, UserData userData), UserData userData)
	set camera shutter value, non-blocking calls More...

ErrorCode::ErrorCodeType	setShutterSpeedSync (ShutterSpeed shutterSpeed, int timeout)
	set camera shutter value, blocking calls More...

void	getShutterSpeedAsync (void(*UserCallBack)(ErrorCode::ErrorCodeType retCode, ShutterSpeed shutterSpeed, UserData userData), UserData userData)
	get camera shutter value, non-blocking calls More...

ErrorCode::ErrorCodeType	getShutterSpeedSync (ShutterSpeed &shutterSpeed, int timeout)
	get camera shutter value, blocking calls More...

void	setExposureCompensationAsync (ExposureCompensation ev, void(*UserCallBack)(ErrorCode::ErrorCodeType retCode, UserData userData), UserData userData)
	set camera EV value, non-blocking calls More...

ErrorCode::ErrorCodeType	setExposureCompensationSync (ExposureCompensation ev, int timeout)
	set camera EV value, blocking calls More...

void	getExposureCompensationAsync (void(*UserCallBack)(ErrorCode::ErrorCodeType retCode, ExposureCompensation ev, UserData userData), UserData userData)
	get camera EV value, non-blocking calls More...

ErrorCode::ErrorCodeType	getExposureCompensationSync (ExposureCompensation &ev, int timeout)
	get camera EV value, blocking calls More...

ErrorCode::ErrorCodeType	obtainDownloadRightSync (bool enable, int timeout)
	obtaion the download right from camera, blocking calls More...

std::string	getCameraVersion ()

std::string	getFirmwareVersion ()

void	updateLensInfo (dji_camera_len_para_push data)

LensInfoPacketType	getLensInfo ()

Public Member Functions inherited from DJI::OSDK::PayloadBase
	PayloadBase (Linker *linker, PayloadIndexType index, std::string name, bool enable)

void	setEnable (bool en)
	set the enable status of this payload module More...

bool	getEnable ()
	get the enable status of this payload module More...

PayloadIndexType	getIndex ()

std::string	getName ()

void	setName (std::string name)

Linker *	getLinker ()

Detailed Description

CameraModule of PayloadNode.

Member Typedef Documentation

◆ ExposureCompensationData

typedef uint8_t DJI::OSDK::CameraModule::ExposureCompensationData

Exposure compensation data type used by user.

ref to DJI::OSDK::CameraModule::ExposureCompensation

◆ ExposureModeData

typedef uint8_t DJI::OSDK::CameraModule::ExposureModeData

Exposure mode data used by user.

ref to DJI::OSDK::CameraModule::ExposureMode

◆ FocusModeData

typedef uint8_t DJI::OSDK::CameraModule::FocusModeData

Focus mode data used by user.

ref to DJI::OSDK::CameraModule::FocusMode

◆ ISOParamData

typedef uint8_t DJI::OSDK::CameraModule::ISOParamData

ISO data used by user.

ref to DJI::OSDK::CameraModule::ISO

◆ ShootPhotoModeData

typedef uint8_t DJI::OSDK::CameraModule::ShootPhotoModeData

Take photo mode data used by user.

ref to DJI::OSDK::CameraModule::ShootPhotoMode

◆ WorkModeData

typedef uint8_t DJI::OSDK::CameraModule::WorkModeData

CameraModule working mode data used by user.

ref to DJI::OSDK::CameraModule::WorkMode

Member Enumeration Documentation

◆ Aperture

enum DJI::OSDK::CameraModule::Aperture

CameraModule aperture values.

Note: X5, X5R, Z30, Phantom 4 Pro camera, X4S and X5S support this setting.

Enumerator
F_1_DOT_6	The Aperture value is f/1.6. It is only supported by Z30 camera.
F_1_DOT_7	The Aperture value is f/1.7.
F_1_DOT_8	The Aperture value is f/1.8.
F_2	The Aperture value is f/2.
F_2_DOT_2	The Aperture value is f/2.2.
F_2_DOT_4	The Aperture value is f/2.4. It is only supported by Z30 camera.
F_2_DOT_5	The Aperture value is f/2.5.
F_2_DOT_6	The Aperture value is f/2.6.
F_2_DOT_8	The Aperture value is f/2.8.
F_3_DOT_2	The Aperture value is f/3.2.
F_3_DOT_4	The Aperture value is f/3.4.
F_3_DOT_5	The Aperture value is f/3.5.
F_4	The Aperture value is f/4.
F_4_DOT_5	The Aperture value is f/4.5.
F_4_DOT_8	The Aperture value is f/4.8.
F_5	The Aperture value is f/5.
F_5_DOT_6	The Aperture value is f/5.6.
F_6_DOT_3	The Aperture value is f/6.3.
F_6_DOT_8	The Aperture value is f/6.8.
F_7_DOT_1	The Aperture value is f/7.1.
F_8	The Aperture value is f/8.
F_9	The Aperture value is f/9.
F_9_DOT_6	The Aperture value is f/9.6.
F_10	The Aperture value is f/10.
F_11	The Aperture value is f/11.
F_13	The Aperture value is f/13.
F_14	The Aperture value is f/14.
F_16	The Aperture value is f/16.
F_18	The Aperture value is f/18.
F_19	The Aperture value is f/19.
F_20	The Aperture value is f/20.
F_22	The Aperture value is f/22.
F_UNKNOWN	The Aperture value is Unknown.

◆ ContiCapMode

enum DJI::OSDK::CameraModule::ContiCapMode

the photo action of INTERVAL shooting photo mode

Enumerator
CONTI_CAP_SINGLE	take a single photo in each Interval shooting
CONTI_CAP_MULTIPLE	take multiple photos in each Interval shooting
CONTI_CAP_TIMELAPSE	used as timelapse shooting

◆ ExposureCompensation

enum DJI::OSDK::CameraModule::ExposureCompensation

CameraModule exposure compensation.

Enumerator
N_5_0	The camera's exposure compensation is -5.0ev.
N_4_7	The camera's exposure compensation is -4.7ev.
N_4_3	The camera's exposure compensation is -4.3ev.
N_4_0	The camera's exposure compensation is -4.0ev.
N_3_7	The camera's exposure compensation is -3.7ev.
N_3_3	The camera's exposure compensation is -3.3ev.
N_3_0	The camera's exposure compensation is -3.0ev.
N_2_7	The camera's exposure compensation is -2.7ev.
N_2_3	The camera's exposure compensation is -2.3ev.
N_2_0	The camera's exposure compensation is -2.0ev.
N_1_7	The camera's exposure compensation is -1.7ev.
N_1_3	The camera's exposure compensation is -1.3ev.
N_1_0	The camera's exposure compensation is -1.0ev.
N_0_7	The camera's exposure compensation is -0.7ev.
N_0_3	The camera's exposure compensation is -0.3ev.
N_0_0	The camera's exposure compensation is 0.0ev.
P_0_3	The camera's exposure compensation is +0.3ev.
P_0_7	The camera's exposure compensation is +0.7ev.
P_1_0	The camera's exposure compensation is +1.0ev.
P_1_3	The camera's exposure compensation is +1.3ev.
P_1_7	The camera's exposure compensation is +1.7ev.
P_2_0	The camera's exposure compensation is +2.0ev.
P_2_3	The camera's exposure compensation is +2.3ev.
P_2_7	The camera's exposure compensation is +2.7ev.
P_3_0	The camera's exposure compensation is +3.0ev.
P_3_3	The camera's exposure compensation is +3.3ev.
P_3_7	The camera's exposure compensation is +3.7ev.
P_4_0	The camera's exposure compensation is +4.0ev.
P_4_3	The camera's exposure compensation is +4.3ev.
P_4_7	The camera's exposure compensation is +4.7ev.
P_5_0	The camera's exposure compensation is +5.0ev.
FIXED	The camera's exposure compensation is fixed by the camera.
UNKNOWN	The camera's exposure compensation is unknown.

◆ ExposureMode

enum DJI::OSDK::CameraModule::ExposureMode

the photo action of INTERVAL shooting photo mode

Enumerator
PROGRAM_AUTO	Program mode
SHUTTER_PRIORITY	Shutter priority mode
APERTURE_PRIORITY	Aperture priority mode
EXPOSURE_MANUAL	Manual mode
EXPOSURE_UNKNOWN	The camera exposure mode is unknown.

◆ FocusMode

enum DJI::OSDK::CameraModule::FocusMode

@breif CameraModule focus mode. If the physical AF switch on the camera is set to auto.

Enumerator
MANUAL	The camera's focus mode is set to manual. In this mode, user sets the focus ring value to adjust the focal distance.
AUTO	The camera's focus mode is set to auto. For the Z30 camera, the focus is calculated completely automatically. For all other cameras, a focus target can be set by the user, which is used to calculate focus automatically.
AFC	The camera's focus mode is set to Continuous AF. It is only supported by Mavic Pro with firmware version V01.03.0000 or above, X4S camera, Mavic 2 Zoom camera and Mavic 2 Pro camera.
FOCUS_MODE_UNKNOWN	The camera's focus mode is unknown.

◆ ISO

enum DJI::OSDK::CameraModule::ISO

CameraModule ISO values.

Enumerator
ISO_AUTO	The ISO value is automatically set. This cannot be used for all cameras when in Manual mode.
ISO_100	The ISO value is set to 100.
ISO_200	The ISO value is set to 100.
ISO_400	The ISO value is set to 100.
ISO_800	The ISO value is set to 100.
ISO_1600	The ISO value is set to 100.
ISO_3200	The ISO value is set to 100.
ISO_6400	The ISO value is set to 100.
ISO_12800	The ISO value is set to 100.
ISO_25600	The ISO value is set to 100.
ISO_FIXED	ISO value is fixed by the camera firmware. When the camera color is set to D_LOG, camera will fix the ISO to a specific value in order to optimize the performance.
ISO_UNKNOWN	The ISO value is set to Unknown value.

◆ PhotoAEBCount

enum DJI::OSDK::CameraModule::PhotoAEBCount

the photo action of INTERVAL shooting photo mode

Enumerator
AEB_COUNT_3	The number of pictures to continuously take at one time in AEB mode is 3
AEB_COUNT_5	The number of pictures to continuously take at one time in AEB mode is 5
AEB_COUNT_7	The number of pictures to continuously take at one time in AEB mode is 7
AEB_COUNT_KNOWN	The number of pictures to continuously take at one time in AEB mode is unknown.

◆ PhotoBurstCount

enum DJI::OSDK::CameraModule::PhotoBurstCount

Enumerator
BURST_COUNT_2	The number of pictures to continuously take each time in BURST mode is 2
BURST_COUNT_3	The number of pictures to continuously take each time in BURST mode is 3
BURST_COUNT_5	The number of pictures to continuously take each time in BURST mode is 5
BURST_COUNT_7	The number of pictures to continuously take each time in BURST mode is 7
BURST_COUNT_10	The number of pictures to continuously take at one time in BURST mode is 10, Only supported by X4S camera, X5S camera and Phantom 4 Pro camera.
BURST_COUNT_14	The number of pictures to continuously take at one time in BURST mode is 14, Only supported by X4S camera, X5S camera and Phantom 4 Pro camera.
BURST_COUNT_KNOWN	The camera burst shoot count value is unknown.

◆ ShootPhotoMode

enum DJI::OSDK::CameraModule::ShootPhotoMode

The ShootPhoto mode itself can have several modes. The default value is SINGLE.

Enumerator
SINGLE	Sets the camera to take a single photo.
HDR	Sets the camera to take an HDR photo. X5 camera, X5R camera, XT camera, Z30 camera, Phantom 4 Pro camera, X4S camera and X5S camera do not support HDR mode.
BURST	Set the camera to take multiple photos at once. XT camera does not support Burst mode.
AEB	Automatic Exposure Bracketing (AEB) capture. In this mode you can quickly take multiple shots (the default is 3) at different exposures without having to manually change any settings between frames. XT camera and Z30 camera does not support AEB mode.
INTERVAL	Sets the camera to take a picture (or multiple pictures) continuously at a set time interval. The minimum interval for JPEG format of any quality is 2s. For all cameras except X4S, X5S and Phantom 4 Pro camera: The minimum interval for RAW or RAW+JPEG format is 10s. For the X4S, X5S and Phantom 4 Pro cameras the minimum interval for RAW or RAW+JPEG dformat is 5s.
RAW_BURST	Sets the camera to take a burst of RAW photos. Use getRAWPhotoBurstCount to check how many photos have been shot. Only supported by X5S.
EHDR	Sets the camera to take an enhanced-HDR photo. It blends a sequence of photos for ghost-free high dynamic range photos. It is supported by Mavic 2 Zoom and Mavic 2 Pro.
REGIONAL_SR	Sets the camera to take an regional photos. It is supported by H20/H20T.
SHOOT_PHOTO_MODE_UNKNOWN	The shoot photo mode is unknown.

◆ ShutterMode

enum DJI::OSDK::CameraModule::ShutterMode

@breif CameraModule shutter mode.

Enumerator
SHUTTER_AUTO_MODE	The shutter mode of camera is automatical
SHUTTER_MANUAL_MODE	The shutter mode of camera is manual, the shutter speed setting is valid.

◆ ShutterSpeed

enum DJI::OSDK::CameraModule::ShutterSpeed

CameraModule shutter speed values.

Enumerator
SHUTTER_SPEED_1_8000	1/8000 s
SHUTTER_SPEED_1_6400	1/6400 s
SHUTTER_SPEED_1_6000	1/6000 s
SHUTTER_SPEED_1_5000	1/5000 s
SHUTTER_SPEED_1_4000	1/4000 s
SHUTTER_SPEED_1_3200	1/3200 s
SHUTTER_SPEED_1_3000	1/3000 s
SHUTTER_SPEED_1_2500	1/2500 s
SHUTTER_SPEED_1_2000	1/2000 s
SHUTTER_SPEED_1_1600	1/1600 s
SHUTTER_SPEED_1_1500	1/1500 s
SHUTTER_SPEED_1_1250	1/1250 s
SHUTTER_SPEED_1_1000	1/1000 s
SHUTTER_SPEED_1_800	1/800 s
SHUTTER_SPEED_1_725	1/725 s
SHUTTER_SPEED_1_640	1/640 s
SHUTTER_SPEED_1_500	1/500 s
SHUTTER_SPEED_1_400	1/400 s
SHUTTER_SPEED_1_350	1/350 s
SHUTTER_SPEED_1_320	1/320 s
SHUTTER_SPEED_1_250	1/250 s
SHUTTER_SPEED_1_240	1/240 s
SHUTTER_SPEED_1_200	1/200 s
SHUTTER_SPEED_1_180	1/180 s
SHUTTER_SPEED_1_160	1/160 s
SHUTTER_SPEED_1_125	1/125 s
SHUTTER_SPEED_1_120	1/120 s
SHUTTER_SPEED_1_100	1/100 s
SHUTTER_SPEED_1_90	1/90 s
SHUTTER_SPEED_1_80	1/80 s
SHUTTER_SPEED_1_60	1/60 s
SHUTTER_SPEED_1_50	1/50 s
SHUTTER_SPEED_1_40	1/40 s
SHUTTER_SPEED_1_30	1/30 s
SHUTTER_SPEED_1_25	1/25 s
SHUTTER_SPEED_1_20	1/20 s
SHUTTER_SPEED_1_15	1/15 s
SHUTTER_SPEED_1_12DOT5	1/12.5 s
SHUTTER_SPEED_1_10	1/10 s
SHUTTER_SPEED_1_8	1/8 s
SHUTTER_SPEED_1_6DOT25	1/6.25 s
SHUTTER_SPEED_1_5	1/5 s
SHUTTER_SPEED_1_4	1/4 s
SHUTTER_SPEED_1_3	1/3 s
SHUTTER_SPEED_1_2DOT5	1/2.5 s
SHUTTER_SPEED_1_2	1/2 s
SHUTTER_SPEED_1_1DOT67	1/1.67 s
SHUTTER_SPEED_1_1DOT25	1/1.25 s
SHUTTER_SPEED_1	1.0 s
SHUTTER_SPEED_1DOT3	1.3 s
SHUTTER_SPEED_1DOT6	1.6 s
SHUTTER_SPEED_2	2.0 s
SHUTTER_SPEED_2DOT5	2.5 s
SHUTTER_SPEED_3	3.0 s
SHUTTER_SPEED_3DOT2	3.2 s
SHUTTER_SPEED_4	4.0 s
SHUTTER_SPEED_5	5.0 s
SHUTTER_SPEED_6	6.0 s
SHUTTER_SPEED_7	7.0 s
SHUTTER_SPEED_8	8.0 s
SHUTTER_SPEED_9	9.0 s
SHUTTER_SPEED_10	10.0 s
SHUTTER_SPEED_13	13.0 s
SHUTTER_SPEED_15	15.0 s
SHUTTER_SPEED_20	20.0 s
SHUTTER_SPEED_25	25.0 s
SHUTTER_SPEED_30	30.0 s
SHUTTER_SPEED_UNKNOWN	Unknown

◆ WorkMode

enum DJI::OSDK::CameraModule::WorkMode

CameraModule work modes.

Enumerator
SHOOT_PHOTO	Capture mode. In this mode, the user can capture pictures.
RECORD_VIDEO	Record mode. In this mode, the user can record videos.
PLAYBACK	Playback mode. In this mode, the user can preview photos and videos, and can delete files. It is supported by Phantom 3 Professional camera, X3, X5 and X5R cameras on aircraft and Phantom 4 camera. Playback mode is not supported by Z30, X5S, X4S, Phantom 4 Pro, Mavic Pro, Phantom 3 Standard, Phantom 3 Advanced, Phantom 3 4K and Osmo series.
MEDIA_DOWNLOAD	In this mode, the user can download media to the Mobile Device. Not supported by X5 camera nor X5R camera while mounted on aircraft.
BROADCAST	In this mode, live stream resolution and frame rate will be 1080i50 (PAL) or 720p60 (NTSC). In this mode videos can be recorded. Still photos can also be taken only when video is recording. The only way to exit broadcast mode is to change modes to RECORD_VIDEO. Only supported by Inspire 2.
WORK_MODE_UNKNOWN	The camera work mode is unknown.

◆ ZoomDirection

enum DJI::OSDK::CameraModule::ZoomDirection

Enumerator
ZOOM_OUT	Lens will zoom out.The focal length decreases, field of view becomes wider and magnification is lower.
ZOOM_IN	Lens will zoom in.The focal length increases, field of view becomes narrower and magnification is higher

◆ ZoomSpeed

enum DJI::OSDK::CameraModule::ZoomSpeed

Enumerator
SLOWEST	slowest speed
SLOW	slow speed
MODERATELY_SLOW	slightly slower than normal speed
NORMAL	normal speed
MODERATELY_FAST	speed slightly faster than normal speed
FAST	fast speed
FASTEST	fastest speed

Member Function Documentation

◆ getApertureAsync()

void DJI::OSDK::CameraModule::getApertureAsync	(	void(*)(ErrorCode::ErrorCodeType, Aperture size, UserData userData)	UserCallBack,
		UserData	userData
	)

get camera aperture size value, non-blocking calls

Parameters

UserCallBack	callback function defined by user retCode is the ErrorCode::ErrorCodeType error code size used as an input param, camera aperture size, input limit see enum DJI::OSDK::CameraModule::ApertureSize userData the interface to pass userData in when the callback is called
userData	when UserCallBack is called, used in UserCallBack

◆ getApertureSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::getApertureSync	(	Aperture &	size,
		int	timeout
	)

get camera aperture size value, blocking calls

Parameters

size	used as an output param, camera aperture size, input limit see enum DJI::OSDK::CameraModule::ApertureSize
timeout	blocking timeout in seconds

Returns: ErrorCode::ErrorCodeType error code

◆ getExposureCompensationAsync()

void DJI::OSDK::CameraModule::getExposureCompensationAsync	(	void(*)(ErrorCode::ErrorCodeType retCode, ExposureCompensation ev, UserData userData)	UserCallBack,
		UserData	userData
	)

get camera EV value, non-blocking calls

Parameters

UserCallBack	callback function defined by user retCode is the ErrorCode::ErrorCodeType error code ev used as an input param, ev parameter value of camera, input limit see enum DJI::OSDK::CameraModule::EVParameter userData the interface to pass userData in when the callback is called
userData	when UserCallBack is called, used in UserCallBack

◆ getExposureCompensationSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::getExposureCompensationSync	(	ExposureCompensation &	ev,
		int	timeout
	)

get camera EV value, blocking calls

Parameters

ev	used as an output param, ev parameter value of camera, input limit see enum DJI::OSDK::CameraModule::EVParameter
timeout	blocking timeout in seconds

Returns: ErrorCode::ErrorCodeType error code

◆ getExposureModeAsync()

void DJI::OSDK::CameraModule::getExposureModeAsync	(	void(*)(ErrorCode::ErrorCodeType retCode, ExposureMode mode, UserData userData)	UserCallBack,
		UserData	userData
	)

get camera exposure mode, non-blocking calls

Note: The different exposure modes define whether Aperture, Shutter Speed, ISO can be set automatically or manually. Exposure compensation can be changed in all modes except Manual mode where it is not settable. X5, X5R, Phantom 4 Pro camera, X4S and X5S: Program Mode: Shutter: Auto Aperture: Auto ISO: Manual or Auto Shutter Priority: Shutter: Manual Aperture: Auto ISO: Manual or Auto Aperture Priority: Shutter: Auto Aperture: Manual ISO: Manual or Auto Manual Mode: Shutter: Manual Aperture: Manual ISO: Manual All other cameras: Program Mode: Shutter: Auto Aperture: Fixed ISO: Auto Shutter Priority: Shutter: Manual Aperture: Fixed ISO: Auto Aperture Priority: NA Manual Mode: Shutter: Manual Aperture: Manual ISO: Manual

Parameters

UserCallBack	callback function defined by user retCode is the ErrorCode::ErrorCodeType error code mode exposure mode, input limit see enum DJI::OSDK::CameraModule::ExposureMode userData in when the callback is called
userData	when UserCallBack is called, used in UserCallBack

◆ getExposureModeSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::getExposureModeSync	(	ExposureMode &	mode,
		int	timeout
	)

get camera exposure mode, blocking calls

Parameters

mode	used as an output param,exposure mode, input limit see enum DJI::OSDK::CameraModule::ExposureMode
timeout	blocking timeout in seconds

Returns: ErrorCode::ErrorCodeType error code

◆ getFocusModeAsync()

void DJI::OSDK::CameraModule::getFocusModeAsync	(	void(*)(ErrorCode::ErrorCodeType retCode, FocusMode mode, UserData userData)	UserCallBack,
		UserData	userData
	)

get camera focus mode, non-blocking calls

Parameters

UserCallBack	callback function defined by user retCode is the ErrorCode::ErrorCodeType error code mode used as an input param, please see enum DJI::OSDK::CameraModule::FocusMode userData the interface to pass userData in when the callback is called
userData	when UserCallBack is called, used in UserCallBack

◆ getFocusModeSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::getFocusModeSync	(	FocusMode &	focusMode,
		int	timeout
	)

get camera focus mode, blocking calls

Parameters

focusMode	used as an output param, camera focus mode, input limit see enum DJI::OSDK::CameraModule::FocusMode
timeout	blocking timeout in seconds

Returns: ErrorCode::ErrorCodeType error code

◆ getFocusTargetAsync()

void DJI::OSDK::CameraModule::getFocusTargetAsync	(	void(*)(ErrorCode::ErrorCodeType, TapFocusPosData tapFocusPos, UserData userData)	UserCallBack,
		UserData	userData
	)

get camera tap focus target point, non-blocking calls

Parameters

UserCallBack	callback function defined by user retCode is the ErrorCode::ErrorCodeType error code tapFocusPos used as an input param, the param of tap focus, including x,y value userData the interface to pass userData in when the callback is called
userData	when UserCallBack is called, used in UserCallBack

◆ getFocusTargetSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::getFocusTargetSync	(	TapFocusPosData &	tapFocusPos,
		int	timeout
	)

get camera focus point, blocking calls

Parameters

tapFocusPos	used as an output param, the param of tap focus, including x,y value
timeout	blocking timeout in seconds

Returns: ErrorCode::ErrorCodeType error code

◆ getISOAsync()

void DJI::OSDK::CameraModule::getISOAsync	(	void(*)(ErrorCode::ErrorCodeType, ISO iso, UserData userData)	UserCallBack,
		UserData	userData
	)

get camera iso value, non-blocking calls

Parameters

UserCallBack	callback function defined by user retCode is the ErrorCode::ErrorCodeType error code iso used as an input param, camera iso, input limit see enum DJI::OSDK::CameraModule::ISOParameter userData in when the callback is called
userData	when UserCallBack is called, used in UserCallBack

◆ getISOSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::getISOSync	(	ISO &	iso,
		int	timeout
	)

get camera iso value, blocking calls

Parameters

iso	used as an output param, camera iso, input limit see enum DJI::OSDK::CameraModule::ISOParameter
timeout	blocking timeout in seconds

Returns: ErrorCode::ErrorCodeType error code

◆ getModeAsync()

void DJI::OSDK::CameraModule::getModeAsync	(	void(*)(ErrorCode::ErrorCodeType retCode, WorkMode workingMode, UserData userData)	UserCallBack,
		UserData	userData
	)

get camera working mode, non-blocking calls

Parameters

UserCallBack	callback function defined by user retCode is the ErrorCode::ErrorCodeType error code mode used as an input param, please see enum DJI::OSDK::CameraModule::WorkMode userData in when the callback is called
userData	when UserCallBack is called, used in UserCallBack

◆ getModeSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::getModeSync	(	WorkMode &	workingMode,
		int	timeout
	)

get camera working mode, blocking calls

Parameters

workingMode	used as an output param, camera working mode, input limit see enum DJI::OSDK::CameraModule::WorkMode
timeout	blocking timeout in seconds

Returns: ErrorCode::ErrorCodeType error code

◆ getOpticalZoomFactorSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::getOpticalZoomFactorSync	(	float &	factor,
		int	timeout
	)

get parameters of camera optical zooming, blocking calls

Note: It is only supported by X5, X5R and X5S camera on Osmo with lens Olympus M.Zuiko ED 14-42mm f/3.5-5.6 EZ, Z3 camera, Z30 camera.; In this interface, the zoom will set the zoom factor as the your target value.

Parameters

factor zoom factor

Returns: ErrorCode::ErrorCodeType error code

◆ getPhotoAEBCountAsync()

void DJI::OSDK::CameraModule::getPhotoAEBCountAsync	(	void(*)(ErrorCode::ErrorCodeType retCode, PhotoAEBCount count, UserData userData)	UserCallBack,
		UserData	userData
	)

get the burst count in the AEB take-photo mode, non-blocking calls

Parameters

UserCallBack	callback function defined by user retCode is the ErrorCode::ErrorCodeType error code count burst photos count in the each AEB photo taking DJI::OSDK::CameraModule::PhotoAEBCount userData the interface to pass userData in when the callback is called
userData	when UserCallBack is called, used in UserCallBack

◆ getPhotoAEBCountSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::getPhotoAEBCountSync	(	PhotoAEBCount &	count,
		int	timeout
	)

get the burst count in the AEB take-photo mode, blocking calls

Parameters

count	burst photos count in the each AEB photo taking DJI::OSDK::CameraModule::PhotoAEBCount
timeout	blocking timeout in seconds

Returns: ErrorCode::ErrorCodeType error code

◆ getPhotoBurstCountAsync()

void DJI::OSDK::CameraModule::getPhotoBurstCountAsync	(	void(*)(ErrorCode::ErrorCodeType retCode, PhotoBurstCount count, UserData userData)	UserCallBack,
		UserData	userData
	)

get the burst count in the Burst take-photo mode, non-blocking calls

Parameters

UserCallBack	callback function defined by user retCode is the ErrorCode::ErrorCodeType error code count burst photos count in the each burst photo taking DJI::OSDK::CameraModule::PhotoBurstCount userData the interface to pass userData in when the callback is called
userData	when UserCallBack is called, used in UserCallBack

◆ getPhotoBurstCountSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::getPhotoBurstCountSync	(	PhotoBurstCount &	count,
		int	timeout
	)

get the burst count in the Burst take-photo mode, blocking calls

Parameters

count	burst photos count in the each burst photo taking DJI::OSDK::CameraModule::PhotoBurstCount
timeout	blocking timeout in seconds

Returns: ErrorCode::ErrorCodeType error code

◆ getPhotoIntervalDatasAsync()

void DJI::OSDK::CameraModule::getPhotoIntervalDatasAsync	(	void(*)(ErrorCode::ErrorCodeType retCode, PhotoIntervalData intervalSetting, UserData userData)	UserCallBack,
		UserData	userData
	)

get the parameters in the INTERVAL take-photo mode, non-blocking calls

Parameters

UserCallBack	callback function defined by user retCode is the ErrorCode::ErrorCodeType error code intervalSetting parameters in the INTERVAL take-photo mode, including photo number and time interval userData the interface to pass userData in when the callback is called
userData	when UserCallBack is called, used in UserCallBack

◆ getPhotoIntervalDatasSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::getPhotoIntervalDatasSync	(	PhotoIntervalData &	intervalSetting,
		int	timeout
	)

get the parameters in the INTERVAL take-photo mode, blocking calls

Parameters

intervalSetting	parameters in the INTERVAL take-photo mode, including photo number and time interval
timeout	blocking timeout in seconds

Returns: ErrorCode::ErrorCodeType error code

◆ getShootPhotoModeAsync()

void DJI::OSDK::CameraModule::getShootPhotoModeAsync	(	void(*)(ErrorCode::ErrorCodeType retCode, ShootPhotoMode takePhotoMode, UserData userData)	UserCallBack,
		UserData	userData
	)

get the shoot photo mode, non-blocking calls

Parameters

UserCallBack	callback function defined by user retCode is the ErrorCode::ErrorCodeType error code takePhotoMode take photo mode, input limit see enum DJI::OSDK::CameraModule::ShootPhotoMode userData the interface to pass userData in when the callback is called
userData	when UserCallBack is called, used in UserCallBack

◆ getShootPhotoModeSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::getShootPhotoModeSync	(	ShootPhotoMode &	takePhotoMode,
		int	timeout
	)

get the shoot photo mode, blocking calls

Parameters

takePhotoMode	take photo mode, input limit see enum DJI::OSDK::CameraModule::ShootPhotoMode
timeout	blocking timeout in seconds

Returns: ErrorCode::ErrorCodeType error code

◆ getShutterSpeedAsync()

void DJI::OSDK::CameraModule::getShutterSpeedAsync	(	void(*)(ErrorCode::ErrorCodeType retCode, ShutterSpeed shutterSpeed, UserData userData)	UserCallBack,
		UserData	userData
	)

get camera shutter value, non-blocking calls

Parameters

UserCallBack	callback function defined by user retCode is the ErrorCode::ErrorCodeType error code shutter used as an input param, the shutter mode and param of camera, input limit see enum DJI::OSDK::CameraModule::ShutterMode userData the interface to pass userData in when the callback is called
userData	when UserCallBack is called, used in UserCallBack

◆ getShutterSpeedSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::getShutterSpeedSync	(	ShutterSpeed &	shutterSpeed,
		int	timeout
	)

get camera shutter value, blocking calls

Parameters

shutter	used as an output param, the shutter mode and param of camera, input limit see enum DJI::OSDK::CameraModule::ShutterMode
timeout	blocking timeout in seconds

Returns: ErrorCode::ErrorCodeType error code

◆ getTapZoomEnabledAsync()

void DJI::OSDK::CameraModule::getTapZoomEnabledAsync	(	void(*)(ErrorCode::ErrorCodeType retCode, bool param, UserData userData)	UserCallBack,
		UserData	userData
	)

get camera tap zoom function parameters, non-blocking calls

Parameters

UserCallBack	callback function defined by user retCode is the ErrorCode::ErrorCodeType error code param used as an input param, tap zoom enable data userData the interface to pass userData in when the callback is called
userData	when UserCallBack is called, used in UserCallBack

◆ getTapZoomEnabledSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::getTapZoomEnabledSync	(	bool &	param,
		int	timeout
	)

get camera tap zoom parameters, blocking calls

Parameters

param	used as an output param, tap zoom enable data
timeout	blocking timeout in seconds

Returns: ErrorCode::ErrorCodeType error code

◆ getTapZoomMultiplierAsync()

void DJI::OSDK::CameraModule::getTapZoomMultiplierAsync	(	void(*)(ErrorCode::ErrorCodeType retCode, TapZoomMultiplierData param, UserData userData)	UserCallBack,
		UserData	userData
	)

get camera tap zoom function parameters, non-blocking calls

Parameters

UserCallBack	callback function defined by user retCode is the ErrorCode::ErrorCodeType error code param used as an input param, tap zoom multiplier data userData the interface to pass userData in when the callback is called
userData	when UserCallBack is called, used in UserCallBack

◆ getTapZoomMultiplierSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::getTapZoomMultiplierSync	(	TapZoomMultiplierData &	param,
		int	timeout
	)

get camera tap zoom parameters, blocking calls

Parameters

param	used as an output param, tap zoom multiplier data
timeout	blocking timeout in seconds

Returns: ErrorCode::ErrorCodeType error code

◆ obtainDownloadRightSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::obtainDownloadRightSync	(	bool	enable,
		int	timeout
	)

obtaion the download right from camera, blocking calls

Parameters

enable	obtain the download right from the camera or not
timeout	blocking timeout in seconds

Returns: ErrorCode::ErrorCodeType error code

◆ setApertureAsync()

void DJI::OSDK::CameraModule::setApertureAsync	(	Aperture	size,
		void(*)(ErrorCode::ErrorCodeType retCode, UserData userData)	UserCallBack,
		UserData	userData
	)

set camera aperture size value, non-blocking calls

Parameters

size	camera aperture size, input limit see enum DJI::OSDK::CameraModule::ApertureSize
UserCallBack	callback function defined by user retCode is the ErrorCode::ErrorCodeType error code userData the interface to pass userData in when the callback is called
userData	when UserCallBack is called, used in UserCallBack

◆ setApertureSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::setApertureSync	(	Aperture	size,
		int	timeout
	)

set camera aperture size value, blocking calls

Parameters

size	camera aperture size, input limit see enum DJI::OSDK::CameraModule::ApertureSize
timeout	blocking timeout in seconds

Returns: ErrorCode::ErrorCodeType error code

◆ setExposureCompensationAsync()

void DJI::OSDK::CameraModule::setExposureCompensationAsync	(	ExposureCompensation	ev,
		void(*)(ErrorCode::ErrorCodeType retCode, UserData userData)	UserCallBack,
		UserData	userData
	)

set camera EV value, non-blocking calls

Parameters

ev	ev parameter value of camera, input limit see enum DJI::OSDK::CameraModule::EVParameter
UserCallBack	callback function defined by user retCode is the ErrorCode::ErrorCodeType error code userData the interface to pass userData in when the callback is called
userData	when UserCallBack is called, used in UserCallBack

◆ setExposureCompensationSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::setExposureCompensationSync	(	ExposureCompensation	ev,
		int	timeout
	)

set camera EV value, blocking calls

Parameters

ev	ev parameter value of camera, input limit see enum DJI::OSDK::CameraModule::EVParameter
timeout	blocking timeout in seconds

Returns: ErrorCode::ErrorCodeType error code

◆ setExposureModeAsync()

void DJI::OSDK::CameraModule::setExposureModeAsync	(	ExposureMode	mode,
		void(*)(ErrorCode::ErrorCodeType retCode, UserData userData)	UserCallBack,
		UserData	userData
	)

set camera exposure mode, non-blocking calls

Note: The different exposure modes define whether Aperture, Shutter Speed, ISO can be set automatically or manually. Exposure compensation can be changed in all modes except Manual mode where it is not settable. X5, X5R, Phantom 4 Pro camera, X4S and X5S: Program Mode: Shutter: Auto Aperture: Auto ISO: Manual or Auto Shutter Priority: Shutter: Manual Aperture: Auto ISO: Manual or Auto Aperture Priority: Shutter: Auto Aperture: Manual ISO: Manual or Auto Manual Mode: Shutter: Manual Aperture: Manual ISO: Manual All other cameras: Program Mode: Shutter: Auto Aperture: Fixed ISO: Auto Shutter Priority: Shutter: Manual Aperture: Fixed ISO: Auto Aperture Priority: NA Manual Mode: Shutter: Manual Aperture: Manual ISO: Manual

Parameters

mode	exposure mode, input limit see enum DJI::OSDK::CameraModule::ExposureMode
UserCallBack	callback function defined by user retCode is the ErrorCode::ErrorCodeType error code userData the interface to pass userData in when the callback is called
userData	when UserCallBack is called, used in UserCallBack

◆ setExposureModeSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::setExposureModeSync	(	ExposureMode	mode,
		int	timeout
	)

set camera exposure mode, blocking calls

Parameters

mode	exposure mode, input limit see enum DJI::OSDK::CameraModule::ExposureMode
timeout	blocking timeout in seconds

Returns: ErrorCode::ErrorCodeType error code

◆ setFocusModeAsync()

void DJI::OSDK::CameraModule::setFocusModeAsync	(	FocusMode	mode,
		void(*)(ErrorCode::ErrorCodeType retCode, UserData userData)	UserCallBack,
		UserData	userData
	)

set camera focus mode, non-blocking calls

Parameters

mode	camera focus mode, input limit see enum DJI::OSDK::CameraModule::FocusMode
UserCallBack	callback function defined by user retCode is the ErrorCode::ErrorCodeType error code userData the interface to pass userData in when the callback is called
userData	when UserCallBack is called, used in UserCallBack

◆ setFocusModeSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::setFocusModeSync	(	FocusMode	mode,
		int	timeout
	)

get camera focus mode, blocking calls

Parameters

mode	camera focus mode, input limit see enum DJI::OSDK::CameraModule::FocusMode
timeout	blocking timeout in seconds

Returns: ErrorCode::ErrorCodeType error code

◆ setFocusTargetAsync()

void DJI::OSDK::CameraModule::setFocusTargetAsync	(	TapFocusPosData	tapFocusPos,
		void(*)(ErrorCode::ErrorCodeType retCode, UserData userData)	UserCallBack,
		UserData	userData
	)

set camera tap focus target point, non-blocking calls

Note: Sets the lens focus mode. When the focus mode is auto, the target point is the focal point. When the focus mode is manual, the target point is the zoom out area if the focus assistant is enabled for the manual mode. Supported only by the X5, X5R, Z3 cameras, Mavic Pro camera, Phantom 4 Pro camera, Mavic 2 Pro, Mavic 2 Zoom Camera, Mavic 2 Enterprise Camera, X5S. It's should be attention that X4S will keep focus point as (0.5,0.5) all the time, the setting of focus point to X4S will quickly replaced by (0.5, 0.5).

Parameters

tapFocusPos	the param of tap focus, including x,y value
UserCallBack	callback function defined by user retCode is the ErrorCode::ErrorCodeType error code userData the interface to pass userData in when the callback is called
userData	when UserCallBack is called, used in UserCallBack

◆ setFocusTargetSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::setFocusTargetSync	(	TapFocusPosData	tapFocusPos,
		int	timeout
	)

set camera focus point, blocking calls

Note: Sets the lens focus mode. When the focus mode is auto, the target point is the focal point. When the focus mode is manual, the target point is the zoom out area if the focus assistant is enabled for the manual mode. Supported only by the X5, X5R, Z3 cameras, Mavic Pro camera, Phantom 4 Pro camera, Mavic 2 Pro, Mavic 2 Zoom Camera, Mavic 2 Enterprise Camera, X5S. It's should be attention that X4S will keep focus point as (0.5,0.5) all the time, the setting of focus point to X4S will quickly replaced by (0.5, 0.5).

Parameters

tapFocusPos	the param of tap focus, including x,y value
timeout	blocking timeout in seconds

Returns: ErrorCode::ErrorCodeType error code

◆ setISOAsync()

void DJI::OSDK::CameraModule::setISOAsync	(	ISO	iso,
		void(*)(ErrorCode::ErrorCodeType retCode, UserData userData)	UserCallBack,
		UserData	userData
	)

set camera iso value, non-blocking calls

Parameters

iso	camera iso, input limit see enum DJI::OSDK::CameraModule::ISOParameter
UserCallBack	callback function defined by user retCode is the ErrorCode::ErrorCodeType error code userData the interface to pass userData in when the callback is called
userData	when UserCallBack is called, used in UserCallBack

◆ setISOSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::setISOSync	(	ISO	iso,
		int	timeout
	)

set camera iso value, blocking calls

Parameters

iso	camera iso, input limit see enum DJI::OSDK::CameraModule::ISOParameter
timeout	blocking timeout in seconds

Returns: ErrorCode::ErrorCodeType error code

◆ setModeAsync()

void DJI::OSDK::CameraModule::setModeAsync	(	WorkMode	mode,
		void(*)(ErrorCode::ErrorCodeType retCode, UserData userData)	UserCallBack,
		UserData	userData
	)

set camera working mode, non-blocking calls

Parameters

mode	camera working mode, input limit see enum DJI::OSDK::CameraModule::WorkMode
UserCallBack	callback function defined by user retCode is the ErrorCode::ErrorCodeType error code userData the interface to pass userData in when the callback is called
userData	when UserCallBack is called, used in UserCallBack

◆ setModeSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::setModeSync	(	WorkMode	mode,
		int	timeout
	)

set camera working mode, blocking calls

Parameters

mode	camera working mode, input limit see enum DJI::OSDK::CameraModule::WorkMode
timeout	blocking timeout in seconds

Returns: ErrorCode::ErrorCodeType error code

◆ setOpticalZoomFactorSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::setOpticalZoomFactorSync	(	float	factor,
		int	timeout
	)

set parameters for camera optical zooming, blocking calls

Note: It is only supported by X5, X5R and X5S camera on Osmo with lens Olympus M.Zuiko ED 14-42mm f/3.5-5.6 EZ, Z3 camera, Z30 camera.; In this interface, the zoom will set the zoom factor as the your target value.

Parameters

factor target zoom factor

Returns: ErrorCode::ErrorCodeType error code

◆ setPhotoAEBCountAsync()

void DJI::OSDK::CameraModule::setPhotoAEBCountAsync	(	PhotoAEBCount	count,
		void(*)(ErrorCode::ErrorCodeType retCode, UserData userData)	UserCallBack,
		UserData	userData
	)

set the burst count in the AEB take-photo mode, non-blocking calls

Parameters

count	burst photos count in the each AEB photo taking DJI::OSDK::CameraModule::PhotoAEBCount
UserCallBack	callback function defined by user retCode is the ErrorCode::ErrorCodeType error code userData the interface to pass userData in when the callback is called
userData	when UserCallBack is called, used in UserCallBack

◆ setPhotoAEBCountSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::setPhotoAEBCountSync	(	PhotoAEBCount	count,
		int	timeout
	)

set the burst count in the AEB take-photo mode, blocking calls

Parameters

count	burst photos count in the each AEB photo taking DJI::OSDK::CameraModule::PhotoAEBCount
timeout	blocking timeout in seconds

Returns: ErrorCode::ErrorCodeType error code

◆ setPhotoBurstCountAsync()

void DJI::OSDK::CameraModule::setPhotoBurstCountAsync	(	PhotoBurstCount	count,
		void(*)(ErrorCode::ErrorCodeType retCode, UserData userData)	UserCallBack,
		UserData	userData
	)

set the burst count in the Burst take-photo mode, non-blocking calls

Parameters

count	burst photos count in the each burst photo taking DJI::OSDK::CameraModule::PhotoBurstCount
UserCallBack	callback function defined by user retCode is the ErrorCode::ErrorCodeType error code userData the interface to pass userData in when the callback is called
userData	when UserCallBack is called, used in UserCallBack

◆ setPhotoBurstCountSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::setPhotoBurstCountSync	(	PhotoBurstCount	count,
		int	timeout
	)

set the burst count in the Burst take-photo mode, blocking calls

Parameters

count	burst photos count in the each burst photo taking DJI::OSDK::CameraModule::PhotoBurstCount
timeout	blocking timeout in seconds

Returns: ErrorCode::ErrorCodeType error code

◆ setPhotoTimeIntervalSettingsAsync()

void DJI::OSDK::CameraModule::setPhotoTimeIntervalSettingsAsync	(	PhotoIntervalData	intervalSetting,
		void(*)(ErrorCode::ErrorCodeType retCode, UserData userData)	UserCallBack,
		UserData	userData
	)

set the parameters in the INTERVAL take-photo mode, non-blocking calls

Parameters

intervalSetting	parameters in the INTERVAL take-photo mode, including photo number and time interval
UserCallBack	callback function defined by user retCode is the ErrorCode::ErrorCodeType error code userData the interface to pass userData in when the callback is called
userData	when UserCallBack is called, used in UserCallBack

◆ setPhotoTimeIntervalSettingsSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::setPhotoTimeIntervalSettingsSync	(	PhotoIntervalData	intervalSetting,
		int	timeout
	)

set the parameters in the INTERVAL take-photo mode, blocking calls

Parameters

intervalSetting	parameters in the INTERVAL take-photo mode, including photo number and time interval
timeout	blocking timeout in seconds

Returns: ErrorCode::ErrorCodeType error code

◆ setShootPhotoModeAsync()

void DJI::OSDK::CameraModule::setShootPhotoModeAsync	(	ShootPhotoMode	takePhotoMode,
		void(*)(ErrorCode::ErrorCodeType retCode, UserData userData)	UserCallBack,
		UserData	userData
	)

set the shoot photo mode, non-blocking calls

Parameters

takePhotoMode	take photo mode, input limit see enum DJI::OSDK::CameraModule::ShootPhotoMode
UserCallBack	callback function defined by user retCode is the ErrorCode::ErrorCodeType error code userData the interface to pass userData in when the callback is called
userData	when UserCallBack is called, used in UserCallBack

◆ setShootPhotoModeSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::setShootPhotoModeSync	(	ShootPhotoMode	takePhotoMode,
		int	timeout
	)

set the shoot photo mode, blocking calls

Parameters

takePhotoMode	take photo mode, input limit see enum DJI::OSDK::CameraModule::ShootPhotoMode
timeout	blocking timeout in seconds

Returns: ErrorCode::ErrorCodeType error code

◆ setShutterSpeedAsync()

void DJI::OSDK::CameraModule::setShutterSpeedAsync	(	ShutterSpeed	shutterSpeed,
		void(*)(ErrorCode::ErrorCodeType retCode, UserData userData)	UserCallBack,
		UserData	userData
	)

set camera shutter value, non-blocking calls

Parameters

shutter	the shutter mode and param of camera, input limit see enum DJI::OSDK::CameraModule::ShutterMode
UserCallBack	callback function defined by user retCode is the ErrorCode::ErrorCodeType error code userData the interface to pass userData in when the callback is called
userData	when UserCallBack is called, used in UserCallBack

◆ setShutterSpeedSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::setShutterSpeedSync	(	ShutterSpeed	shutterSpeed,
		int	timeout
	)

set camera shutter value, blocking calls

Parameters

shutter	the shutter mode and param of camera, input limit see enum DJI::OSDK::CameraModule::ShutterMode
timeout	blocking timeout in seconds

Returns: ErrorCode::ErrorCodeType error code

◆ setTapZoomEnabledAsync()

void DJI::OSDK::CameraModule::setTapZoomEnabledAsync	(	bool	param,
		void(*)(ErrorCode::ErrorCodeType retCode, UserData userData)	UserCallBack,
		UserData	userData
	)

set camera tap zoom function parameters, non-blocking calls

Parameters

param	tap zoom enable data
UserCallBack	callback function defined by user retCode is the ErrorCode::ErrorCodeType error code userData the interface to pass userData in when the callback is called
userData	when UserCallBack is called, used in UserCallBack

It should be paid attention that, tap zoom have not getter API

◆ setTapZoomEnabledSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::setTapZoomEnabledSync	(	bool	param,
		int	timeout
	)

set camera tap zoom parameters, blocking calls

Parameters

param	tap zoom enable data
timeout	blocking timeout in seconds

It should be paid attention that, tap zoom have not getter API

Returns: ErrorCode::ErrorCodeType error code

◆ setTapZoomMultiplierAsync()

void DJI::OSDK::CameraModule::setTapZoomMultiplierAsync	(	TapZoomMultiplierData	param,
		void(*)(ErrorCode::ErrorCodeType retCode, UserData userData)	UserCallBack,
		UserData	userData
	)

set camera tap zoom function parameters, non-blocking calls

Parameters

param	tap zoom multiplier data
UserCallBack	callback function defined by user retCode is the ErrorCode::ErrorCodeType error code userData the interface to pass userData in when the callback is called
userData	when UserCallBack is called, used in UserCallBack

It should be paid attention that, tap zoom have not getter API

◆ setTapZoomMultiplierSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::setTapZoomMultiplierSync	(	TapZoomMultiplierData	param,
		int	timeout
	)

set camera tap zoom parameters, blocking calls

Parameters

param	tap multiplier enable data
timeout	blocking timeout in seconds

It should be paid attention that, tap zoom have not getter API

Returns: ErrorCode::ErrorCodeType error code

◆ startContinuousOpticalZoomAsync()

void DJI::OSDK::CameraModule::startContinuousOpticalZoomAsync	(	zoomDirectionData	zoomDirection,
		zoomSpeedData	zoomSpeed,
		void(*)(ErrorCode::ErrorCodeType retCode, UserData userData)	UserCallBack,
		UserData	userData
	)

start camera optical zooming, non-blocking calls

Parameters

zoomDirection	optical zoom direction, ref to DJI::OSDK::CameraModule::ZoomDirection
zoomSpeed	optical zoom direction, ref to DJI::OSDK::CameraModule::ZoomSpeed
UserCallBack	callback function defined by user retCode is the ErrorCode::ErrorCodeType error code userData the interface to pass userData in when the callback is called
userData	when UserCallBack is called, used in UserCallBack

◆ startContinuousOpticalZoomSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::startContinuousOpticalZoomSync	(	zoomDirectionData	zoomDirection,
		zoomSpeedData	zoomSpeed,
		int	timeout
	)

start camera optical zooming, blocking calls

Parameters

zoomDirection	optical zoom direction, ref to DJI::OSDK::CameraModule::ZoomDirection
zoomSpeed	optical zoom direction, ref to DJI::OSDK::CameraModule::ZoomSpeed
timeout	blocking timeout in seconds

Returns: ErrorCode::ErrorCodeType error code

◆ startRecordVideoAsync()

void DJI::OSDK::CameraModule::startRecordVideoAsync	(	void(*)(ErrorCode::ErrorCodeType retCode, UserData userData)	UserCallBack,
		UserData	userData
	)

start to take video, non-blocking calls

Parameters

UserCallBack	callback function defined by user retCode is the ErrorCode::ErrorCodeType error code userData the interface to pass userData in when the callback is called
userData	when UserCallBack is called, used in UserCallBack

◆ startRecordVideoSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::startRecordVideoSync ( int timeout )

start to take video, blocking calls

Parameters

timeout blocking timeout in seconds

Returns: ErrorCode::ErrorCodeType error code

◆ startShootPhotoAsync()

void DJI::OSDK::CameraModule::startShootPhotoAsync	(	ShootPhotoMode	mode,
		void(*)(ErrorCode::ErrorCodeType retCode, UserData userData)	UserCallBack,
		UserData	userData
	)

start to shoot photo, non-blocking calls

Parameters

mode	take photo mode, input limit see enum DJI::OSDK::CameraModule::TakePhotoMode
UserCallBack	callback function defined by user retCode is the ErrorCode::ErrorCodeType error code userData the interface to pass userData in when the callback is called
userData	when UserCallBack is called, used in UserCallBack

◆ startShootPhotoSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::startShootPhotoSync	(	ShootPhotoMode	mode,
		int	timeout
	)

start to shoot photo, blocking calls

Parameters

mode	take photo mode, input limit see enum DJI::OSDK::CameraModule::TakePhotoMode
timeout	blocking timeout in seconds

Returns: ErrorCode::ErrorCodeType error code

◆ stopContinuousOpticalZoomAsync()

void DJI::OSDK::CameraModule::stopContinuousOpticalZoomAsync	(	void(*)(ErrorCode::ErrorCodeType retCode, UserData userData)	UserCallBack,
		UserData	userData
	)

stop camera optical zooming, non-blocking calls

Parameters

UserCallBack	callback function defined by user retCode is the ErrorCode::ErrorCodeType error code userData the interface to pass userData in when the callback is called
userData	when UserCallBack is called, used in UserCallBack

◆ stopContinuousOpticalZoomSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::stopContinuousOpticalZoomSync ( int timeout )

stop camera optical zooming, blocking calls

Parameters

timeout blocking timeout in seconds

Returns: ErrorCode::ErrorCodeType error code

◆ stopRecordVideoAsync()

void DJI::OSDK::CameraModule::stopRecordVideoAsync	(	void(*)(ErrorCode::ErrorCodeType retCode, UserData userData)	UserCallBack,
		UserData	userData
	)

stop to take video, non-blocking calls

Parameters

UserCallBack	callback function defined by user retCode is the ErrorCode::ErrorCodeType error code userData the interface to pass userData in when the callback is called
userData	when UserCallBack is called, used in UserCallBack

◆ stopRecordVideoSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::stopRecordVideoSync ( int timeout )

stop to take video, blocking calls

Parameters

timeout blocking timeout in seconds

Returns: ErrorCode::ErrorCodeType error code

◆ stopShootPhotoAsync()

void DJI::OSDK::CameraModule::stopShootPhotoAsync	(	void(*)(ErrorCode::ErrorCodeType retCode, UserData userData)	UserCallBack,
		UserData	userData
	)

stop to shoot photo, non-blocking calls

Parameters

UserCallBack	callback function defined by user retCode is the ErrorCode::ErrorCodeType error code userData the interface to pass userData in when the callback is called
userData	when UserCallBack is called, used in UserCallBack

◆ stopShootPhotoSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::stopShootPhotoSync ( int timeout )

stop to shoot photo, blocking calls

Parameters

timeout blocking timeout in seconds

Returns: ErrorCode::ErrorCodeType error code

◆ tapZoomAtTargetAsync()

void DJI::OSDK::CameraModule::tapZoomAtTargetAsync	(	TapZoomPosData	tapZoomPos,
		void(*)(ErrorCode::ErrorCodeType retCode, UserData userData)	UserCallBack,
		UserData	userData
	)

set camera tap zoom point, non-blocking calls

Parameters

tapZoomPos	the param of tap zoom, including x,y value
UserCallBack	callback function defined by user retCode is the ErrorCode::ErrorCodeType error code userData the interface to pass userData in when the callback is called
userData	when UserCallBack is called, used in UserCallBack

◆ tapZoomAtTargetSync()

ErrorCode::ErrorCodeType DJI::OSDK::CameraModule::tapZoomAtTargetSync	(	TapZoomPosData	tapZoomPos,
		int	timeout
	)

set camera tap zoom point, blocking calls

Parameters

tapZoomPos	the param of tap zoom, including x,y value
timeout	blocking timeout in seconds

Returns: ErrorCode::ErrorCodeType error code

The documentation for this class was generated from the following file:

osdk-core/modules/inc/payload/dji_camera_module.hpp

Onboard SDK

Classes

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ ExposureCompensationData

◆ ExposureModeData

◆ FocusModeData

◆ ISOParamData

◆ ShootPhotoModeData

◆ WorkModeData

Member Enumeration Documentation

◆ Aperture

◆ ContiCapMode

◆ ExposureCompensation

◆ ExposureMode

◆ FocusMode

◆ ISO

◆ PhotoAEBCount

◆ PhotoBurstCount

◆ ShootPhotoMode

◆ ShutterMode

◆ ShutterSpeed

◆ WorkMode

◆ ZoomDirection

◆ ZoomSpeed

Member Function Documentation

◆ getApertureAsync()

◆ getApertureSync()

◆ getExposureCompensationAsync()

◆ getExposureCompensationSync()

◆ getExposureModeAsync()

◆ getExposureModeSync()

◆ getFocusModeAsync()

◆ getFocusModeSync()

◆ getFocusTargetAsync()

◆ getFocusTargetSync()

◆ getISOAsync()

◆ getISOSync()

◆ getModeAsync()

◆ getModeSync()

◆ getOpticalZoomFactorSync()

◆ getPhotoAEBCountAsync()

◆ getPhotoAEBCountSync()

◆ getPhotoBurstCountAsync()

◆ getPhotoBurstCountSync()

◆ getPhotoIntervalDatasAsync()

◆ getPhotoIntervalDatasSync()

◆ getShootPhotoModeAsync()

◆ getShootPhotoModeSync()

◆ getShutterSpeedAsync()

◆ getShutterSpeedSync()

◆ getTapZoomEnabledAsync()

◆ getTapZoomEnabledSync()

◆ getTapZoomMultiplierAsync()

◆ getTapZoomMultiplierSync()

◆ obtainDownloadRightSync()

◆ setApertureAsync()

◆ setApertureSync()

◆ setExposureCompensationAsync()

◆ setExposureCompensationSync()

◆ setExposureModeAsync()

◆ setExposureModeSync()

◆ setFocusModeAsync()

◆ setFocusModeSync()

◆ setFocusTargetAsync()

◆ setFocusTargetSync()

◆ setISOAsync()

◆ setISOSync()

◆ setModeAsync()

◆ setModeSync()

◆ setOpticalZoomFactorSync()

◆ setPhotoAEBCountAsync()

◆ setPhotoAEBCountSync()

◆ setPhotoBurstCountAsync()

◆ setPhotoBurstCountSync()

◆ setPhotoTimeIntervalSettingsAsync()

◆ setPhotoTimeIntervalSettingsSync()

◆ setShootPhotoModeAsync()