DJI Onboard SDK  4.0
Public Member Functions | List of all members
CameraManagerSyncSample Class Reference

camera manager sync sample More...

#include <camera_manager_sync_sample.hpp>

Public Member Functions

 CameraManagerSyncSample (Vehicle *vehiclePtr)
 
ErrorCode::ErrorCodeType setEVSyncSample (PayloadIndexType index, CameraModule::ExposureCompensation dataTarget)
 Sample to set exposure compensation value for camera, using async api. More...
 
ErrorCode::ErrorCodeType setExposureModeSyncSample (PayloadIndexType index, CameraModule::ExposureMode dataTarget)
 Sample to set exposure mode for camera, using async api. More...
 
ErrorCode::ErrorCodeType setISOSyncSample (PayloadIndexType index, CameraModule::ISO dataTarget)
 Sample to set ISO value for camera, using async api. More...
 
ErrorCode::ErrorCodeType setShutterSpeedSyncSample (PayloadIndexType index, CameraModule::ShutterSpeed dataTarget)
 Sample to set shutter speed for camera, using async api. More...
 
ErrorCode::ErrorCodeType setApertureSyncSample (PayloadIndexType index, CameraModule::Aperture dataTarget)
 Sample to set shutter aperture value for camera, using async api. More...
 
ErrorCode::ErrorCodeType setFocusPointSyncSample (PayloadIndexType index, float x, float y)
 Sample to set focus point for camera, using async api. More...
 
ErrorCode::ErrorCodeType setTapZoomPointSyncSample (PayloadIndexType index, uint8_t multiplier, float x, float y)
 Sample to set tap-zoom point for camera, using async api. More...
 
ErrorCode::ErrorCodeType startZoomSyncSample (PayloadIndexType index, CameraModule::zoomDirectionData direction, CameraModule::zoomSpeedData speed)
 Sample to execute continuous zoom on camera, using async api. More...
 
ErrorCode::ErrorCodeType stopZoomSyncSample (PayloadIndexType index)
 Sample to stop continuous zoom on camera, using async api. More...
 
ErrorCode::ErrorCodeType startShootSinglePhotoSyncSample (PayloadIndexType index)
 Sample to shoot single photo, using async api. More...
 
ErrorCode::ErrorCodeType startShootBurstPhotoSyncSample (PayloadIndexType index, CameraModule::PhotoBurstCount count)
 Sample to shoot burst photo, using async api. More...
 
ErrorCode::ErrorCodeType startShootAEBPhotoSyncSample (PayloadIndexType index, CameraModule::PhotoAEBCount photoNum)
 Sample to shoot AEB photo, using async api. More...
 
ErrorCode::ErrorCodeType startShootIntervalPhotoSyncSample (PayloadIndexType index, CameraModule::PhotoIntervalData intervalData)
 Sample to start shooting interval photo, using async api. More...
 
ErrorCode::ErrorCodeType shootPhotoStopSyncSample (PayloadIndexType index)
 Sample to stop shooting, using async api. More...
 
ErrorCode::ErrorCodeType startRecordVideoSyncSample (PayloadIndexType index)
 Sample to start record video, using async api. More...
 
ErrorCode::ErrorCodeType stopRecordVideoSyncSample (PayloadIndexType index)
 Sample to stop record video, using async api. More...
 

Detailed Description

camera manager sync sample

Member Function Documentation

◆ setApertureSyncSample()

ErrorCode::ErrorCodeType CameraManagerSyncSample::setApertureSyncSample ( PayloadIndexType  index,
CameraModule::Aperture  dataTarget 
)

Sample to set shutter aperture value for camera, using async api.

Note
In this interface, aperture value will be got then be set.
Parameters
indexpayload node index, input limit see enum DJI::OSDK::PayloadIndexType
dataTargetthe target aperture value
Returns
ErrorCode::ErrorCodeType error code

◆ setEVSyncSample()

ErrorCode::ErrorCodeType CameraManagerSyncSample::setEVSyncSample ( PayloadIndexType  index,
CameraModule::ExposureCompensation  dataTarget 
)

Sample to set exposure compensation value for camera, using async api.

Note
In this interface, exposure compensation value will be got then be set.
Parameters
indexpayload node index, input limit see enum DJI::OSDK::PayloadIndexType
dataTargetthe target exposure compensation value
Returns
ErrorCode::ErrorCodeType error code

◆ setExposureModeSyncSample()

ErrorCode::ErrorCodeType CameraManagerSyncSample::setExposureModeSyncSample ( PayloadIndexType  index,
CameraModule::ExposureMode  dataTarget 
)

Sample to set exposure mode for camera, using async api.

Note
In this interface, exposure will be got then be set.
Parameters
indexpayload node index, input limit see enum DJI::OSDK::PayloadIndexType
dataTargetthe target exposure mode
Returns
ErrorCode::ErrorCodeType error code

◆ setFocusPointSyncSample()

ErrorCode::ErrorCodeType CameraManagerSyncSample::setFocusPointSyncSample ( PayloadIndexType  index,
float  x,
float  y 
)

Sample to set focus point for camera, using async api.

Note
In this interface, focus mode will be set to be AUTO. Then the focus point will be set to be (x, y)
Parameters
indexpayload node index, input limit see enum DJI::OSDK::PayloadIndexType
xthe x value of target focus point, 0~1
ythe y value of target focus point, 0~1
Returns
ErrorCode::ErrorCodeType error code

◆ setISOSyncSample()

ErrorCode::ErrorCodeType CameraManagerSyncSample::setISOSyncSample ( PayloadIndexType  index,
CameraModule::ISO  dataTarget 
)

Sample to set ISO value for camera, using async api.

Note
In this interface, ISO will be got then be set.
Parameters
indexpayload node index, input limit see enum DJI::OSDK::PayloadIndexType
dataTargetthe target ISO value
Returns
ErrorCode::ErrorCodeType error code

◆ setShutterSpeedSyncSample()

ErrorCode::ErrorCodeType CameraManagerSyncSample::setShutterSpeedSyncSample ( PayloadIndexType  index,
CameraModule::ShutterSpeed  dataTarget 
)

Sample to set shutter speed for camera, using async api.

Note
In this interface, shutter speed will be got then be set.
Parameters
indexpayload node index, input limit see enum DJI::OSDK::PayloadIndexType
dataTargetthe target shutter speed
Returns
ErrorCode::ErrorCodeType error code

◆ setTapZoomPointSyncSample()

ErrorCode::ErrorCodeType CameraManagerSyncSample::setTapZoomPointSyncSample ( PayloadIndexType  index,
uint8_t  multiplier,
float  x,
float  y 
)

Sample to set tap-zoom point for camera, using async api.

Note
In this interface, tap-zoom function will be enable and the multiplier will be set. Then the tap-zoom function will start with the target tap-zoom point (x, y)
Parameters
indexpayload node index, input limit see enum DJI::OSDK::PayloadIndexType
multiplierthe zoom multiplier of each tap zoom
xthe x value of target tap-zoom point, 0~1
ythe y value of target tap-zoom point, 0~1
Returns
ErrorCode::ErrorCodeType error code

◆ shootPhotoStopSyncSample()

ErrorCode::ErrorCodeType CameraManagerSyncSample::shootPhotoStopSyncSample ( PayloadIndexType  index)

Sample to stop shooting, using async api.

Note
In this interface, camera will stop all the shooting action
Parameters
indexpayload node index, input limit see enum DJI::OSDK::PayloadIndexType
Returns
ErrorCode::ErrorCodeType error code

◆ startRecordVideoSyncSample()

ErrorCode::ErrorCodeType CameraManagerSyncSample::startRecordVideoSyncSample ( PayloadIndexType  index)

Sample to start record video, using async api.

Note
In this interface, camera will be set to be the RECORD_VIDEO mode then start to record video.
Parameters
indexpayload node index, input limit see enum DJI::OSDK::PayloadIndexType
Returns
ErrorCode::ErrorCodeType error code

◆ startShootAEBPhotoSyncSample()

ErrorCode::ErrorCodeType CameraManagerSyncSample::startShootAEBPhotoSyncSample ( PayloadIndexType  index,
CameraModule::PhotoAEBCount  photoNum 
)

Sample to shoot AEB photo, using async api.

Note
In this interface, camera will be set to be the SHOOT_PHOTO mode then start to shoot a AEB photo.
Parameters
indexpayload node index, input limit see enum DJI::OSDK::PayloadIndexType
photoNumThe number of pictures in each AEB shooting
Returns
ErrorCode::ErrorCodeType error code

◆ startShootBurstPhotoSyncSample()

ErrorCode::ErrorCodeType CameraManagerSyncSample::startShootBurstPhotoSyncSample ( PayloadIndexType  index,
CameraModule::PhotoBurstCount  count 
)

Sample to shoot burst photo, using async api.

Note
In this interface, camera will be set to be the SHOOT_PHOTO mode then start to shoot a burst photo.
Parameters
indexpayload node index, input limit see enum DJI::OSDK::PayloadIndexType
countThe number of pictures in each burst shooting
Returns
ErrorCode::ErrorCodeType error code

◆ startShootIntervalPhotoSyncSample()

ErrorCode::ErrorCodeType CameraManagerSyncSample::startShootIntervalPhotoSyncSample ( PayloadIndexType  index,
CameraModule::PhotoIntervalData  intervalData 
)

Sample to start shooting interval photo, using async api.

Note
In this interface, camera will be set to be the SHOOT_PHOTO mode then start to shoot a interval photo.
Parameters
indexpayload node index, input limit see enum DJI::OSDK::PayloadIndexType
intervalDatathe parameter of interval shooting
Returns
ErrorCode::ErrorCodeType error code

◆ startShootSinglePhotoSyncSample()

ErrorCode::ErrorCodeType CameraManagerSyncSample::startShootSinglePhotoSyncSample ( PayloadIndexType  index)

Sample to shoot single photo, using async api.

Note
In this interface, camera will be set to be the SHOOT_PHOTO mode then start to shoot a single photo.
Parameters
indexpayload node index, input limit see enum DJI::OSDK::PayloadIndexType
Returns
ErrorCode::ErrorCodeType error code

◆ startZoomSyncSample()

ErrorCode::ErrorCodeType CameraManagerSyncSample::startZoomSyncSample ( PayloadIndexType  index,
CameraModule::zoomDirectionData  direction,
CameraModule::zoomSpeedData  speed 
)

Sample to execute continuous zoom on camera, using async api.

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 start with the designated direction and speed, and will stop after zoomTimeInSecond second(s).
Parameters
indexpayload node index, input limit see enum DJI::OSDK::PayloadIndexType
directionthe choice of zoom out or zoom in
speedzooming speed
Returns
ErrorCode::ErrorCodeType error code

◆ stopRecordVideoSyncSample()

ErrorCode::ErrorCodeType CameraManagerSyncSample::stopRecordVideoSyncSample ( PayloadIndexType  index)

Sample to stop record video, using async api.

Note
In this interface, camera will be set to be the RECORD_VIDEO mode then stop recording video.
Parameters
indexpayload node index, input limit see enum DJI::OSDK::PayloadIndexType
Returns
ErrorCode::ErrorCodeType error code

◆ stopZoomSyncSample()

ErrorCode::ErrorCodeType CameraManagerSyncSample::stopZoomSyncSample ( PayloadIndexType  index)

Sample to stop continuous zoom on camera, using async api.

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.
Parameters
indexpayload node index, input limit see enum DJI::OSDK::PayloadIndexType
Returns
ErrorCode::ErrorCodeType error code

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