Skip to main content

Camera capability support interface.

ICameraSupport2​

DescriptionCamera capability support interface.

method getResolutionAndFrameRate​

fun getResolutionAndFrameRate(
        lensType: LensTypeEnum,
        flightMode: FightModeEnum?,
        modeEnum: RecordModeEnum?
    ): List<VideoResolutionFrameBean>

Description: Returns the list of supported video resolutions and frame rates.

Input Parameters: lensType:Lens type [LensTypeEnum] flightMode:Flight mode [FightModeEnum] modeEnum:Camera recording mode [RecordModeEnum]

Output Parameter: The list of currently supported video resolutions and frame rates.

Related Parameters: LensTypeEnum,FightModeEnum,RecordModeEnum,VideoResolutionFrameBean

method getHDRSupportPhoto​

fun getHDRSupportPhoto(
        lensType: LensTypeEnum,
        flightMode: FightModeEnum,
        photoFormat: PhotoFormatEnum,
        modeEnum: CameraModeEnum
    ): List<PhotoResolutionEnum>

Description: Returns the list of photo resolutions that support HDR.

Input Parameters: lensType:Lens type [LensTypeEnum] flightMode:Flight mode [FightModeEnum] photoFormat:Photo format [PhotoFormatEnum] modeEnum:Photo shooting mode [CameraModeEnum]

Output Parameter: The list of photo resolutions that support HDR.

Related Parameters: LensTypeEnum,FightModeEnum,PhotoFormatEnum,CameraModeEnum,PhotoResolutionEnum

method getCameraModeRange​

fun getCameraModeRange(
        lensType: LensTypeEnum,
        flightMode: FightModeEnum,
        modeEnum: TakePhotoModeEnum
    ): ArrayList<CameraModeEnum>

Description: Returns the current valid camera modes (CameraModeEnum).

Input Parameters: lensType:Lens type [LensTypeEnum] flightMode:Flight mode [FightModeEnum] modeEnum:Photo shooting mode [TakePhotoModeEnum]

Output Parameter: An list representing the valid camera modes.

Related Parameters: LensTypeEnum,FightModeEnum,TakePhotoModeEnum,CameraModeEnum

method getManualFocus​

fun getManualFocus(
        lensType: LensTypeEnum
    ): RangeStepIntValue?

Description: Returns the range of manual focus values. "Default": {"Min": 1,"Max": 50,"Step": 1 }

Input Parameters: lensType:Lens type [LensTypeEnum]

Output Parameter: A RangeStepIntValue object representing the manual focus range.

Related Parameters: LensTypeEnum,RangeStepIntValue

method getPhotoZoom​

    fun getPhotoZoom(
        lensType: LensTypeEnum,
        videoZoomType: VideoZoomTypeEnum
    ): RangeStepValue?

Description: Returns the zoom range for taking photos.

Input Parameters: lensType:Lens type [LensTypeEnum] videoZoomType：The type of video zoom.[VideoZoomTypeEnum]

Output Parameter: A RangeStepValue object representing the zoom range for taking photos.

Related Parameters: LensTypeEnum,VideoZoomTypeEnum,RangeStepIntValue

method getVideoZoom​

    fun getVideoZoom(
        lensType: LensTypeEnum,
        videoZoomType: VideoZoomTypeEnum
    ): RangeStepValue?

Description: Returns the zoom range for video recording.

Input Parameters: lensType:Lens type [LensTypeEnum] videoZoomType：The type of video zoom.[VideoZoomTypeEnum]

Output Parameter: A RangeStepValue object representing the zoom range for video recording.[RangeStepIntValue]

Related Parameters: LensTypeEnum,VideoZoomTypeEnum,RangeStepIntValue

method getWatermarkTimestamp​

    fun getWatermarkTimestamp(
        lensType: LensTypeEnum,
        photoFormat: PhotoFormatEnum
    ): Int

Description: Returns the watermark and timestamp value.

Input Parameters: lensType:Lens type [LensTypeEnum] photoFormat：The type of video zoom.[PhotoFormatEnum]

Output Parameter: An Int representing the watermark and timestamp value.[Int]

Related Parameters: LensTypeEnum,PhotoFormatEnum,Int

method getExposureModeRange​

    fun getExposureModeRange(
        lensType: LensTypeEnum
    ): ArrayList<ExposureModeEnum>

Description: Returns the list of valid camera exposure modes.

Input Parameters: lensType:Lens type [LensTypeEnum]

Output Parameter: A list of ExposureModeEnum representing the valid camera exposure modes.[ExposureModeEnum]

Related Parameters: LensTypeEnum,ExposureModeEnum

method getExposureCompensationRange​

    fun getExposureCompensationRange(
        lensType: LensTypeEnum
    ): ArrayList<ExposureExposureCompensationEnum>

Description: Returns the list of valid exposure compensation ranges.

Input Parameters: lensType:Lens type [LensTypeEnum]

Output Parameter: The list of valid exposure compensation ranges.

Related Parameters: LensTypeEnum,ExposureExposureCompensationEnum

method getImageISOList​

    fun getImageISOList(
        lensType: LensTypeEnum,
        isPhoto: Boolean,
        pattern: Int = PatternModeEnum.MANUAL.value,
        modeEnum: TakePhotoModeEnum
    ): ArrayList<ImageISOEnum>

Description: Returns the list of valid camera ISO ranges.

Input Parameters: lensType:Lens type [LensTypeEnum]; isPhoto:Whether it's a photo[Boolean]; pattern:Camera interface mode [Int] (default is PatternModeEnum.MANUAL.value)[Int]; modeEnum:Camera shooting mode[TakePhotoModeEnum];

Output Parameter: The list of valid camera ISO ranges.

Related Parameters: LensTypeEnum,Boolean,Int,TakePhotoModeEnum,ImageISOEnum

method getPhotoISOModeRange​

    fun getPhotoISOModeRange(
        lensType: LensTypeEnum
    ): List<ISOModeEnum>

Description: Returns the list of valid camera ISO modes for photos.

Input Parameters: lensType:Lens type [LensTypeEnum];

Output Parameter: The list of valid camera ISO modes for photos.

Related Parameters: LensTypeEnum,ISOModeEnum

method getVideoISOModeRange​

    fun getVideoISOModeRange(
        lensType: LensTypeEnum
    ): List<ISOModeEnum>

Description: Returns the list of valid camera ISO modes for videos.

Input Parameters: lensType:Lens type [LensTypeEnum];

Output Parameter: The list of valid camera ISO modes for videos.

Related Parameters: LensTypeEnum,ISOModeEnum

method getShutterList​

    fun getShutterList(
        lensType: LensTypeEnum,
        isPhoto: Boolean,
        fps: Int,
        modeEnum: TakePhotoModeEnum
    ): ArrayList<ShutterSpeedData>

Description: Returns the list of valid camera shutter speeds.

Input Parameters: lensType:Lens type [LensTypeEnum]; isPhoto:Whether it's a photo[Boolean]; fps:FPS[Int]; modeEnum：Camera shooting mode[TakePhotoModeEnum]

Output Parameter: The list of valid camera shutter speeds.

Related Parameters: LensTypeEnum,TakePhotoModeEnum,ShutterSpeedData

method getApertureRange​

    fun getApertureRange(
        lensType: LensTypeEnum
    ): List<Double>

Description: Returns the valid aperture range for the camera.

Input Parameters: lensType:Lens type [LensTypeEnum];

Output Parameter: The valid aperture range for the camera.

Related Parameters: LensTypeEnum

method getVideoFileFormatRange​

    fun getVideoFileFormatRange(
        lensType: LensTypeEnum
    ): List<VideoFormatEnum>

Description: Returns the list of valid video file formats.

Input Parameters: lensType:Lens type [LensTypeEnum];

Output Parameter: The list of valid video file formats.

Related Parameters: LensTypeEnum,VideoFormatEnum

method getPicInVideoIntervalRange​

    fun getPicInVideoIntervalRange(
        lensType: LensTypeEnum
    ): List<VideoPivEnum>

Description: Returns the list of valid intervals for taking pictures while recording video.

Input Parameters: lensType:Lens type [LensTypeEnum];

Output Parameter: Returns the list of valid intervals for taking pictures while recording video.

Related Parameters: LensTypeEnum,VideoPivEnum

method getVideoStandardRange​

    fun getVideoStandardRange(
        lensType: LensTypeEnum
    ): List<VideoStandardEnum>

Description: Returns the list of valid video standards.

Input Parameters: lensType:Lens type [LensTypeEnum];

Output Parameter: Returns the list of valid video standards.

Related Parameters: LensTypeEnum,VideoStandardEnum

method getPhotoFileFormatRange​

    fun getPhotoFileFormatRange(
        lensType: LensTypeEnum,
        modeEnum: TakePhotoModeEnum,
        photoResolution: PhotoResolutionEnum
    ): List<PhotoFormatEnum>

Description: Returns the list of valid photo file formats.

Input Parameters: lensType:Lens type [LensTypeEnum]; modeEnum：Shooting mode[TakePhotoModeEnum] photoResolution：Photo resolution[PhotoResolutionEnum]

Output Parameter: Returns the list of valid photo file formats.

Related Parameters: LensTypeEnum,TakePhotoModeEnum,PhotoResolutionEnum,PhotoFormatEnum

method getPhotoBurstCountRange​

    fun getPhotoBurstCountRange(
        lensType: LensTypeEnum
    ): List<Int>

Description: Returns the list of valid burst count options for taking multiple photos quickly.

Input Parameters: lensType:Lens type [LensTypeEnum];

Output Parameter: Returns the list of valid burst count options for taking multiple photos quickly.

Related Parameters: LensTypeEnum

method getPhotoAEBCaptureCountRange​

    fun getPhotoAEBCaptureCountRange(
        lensType: LensTypeEnum
    ): List<Int>

Description: Returns the list of valid capture count options for Auto Exposure Bracketing (AEB) photos.

Input Parameters: lensType:Lens type [LensTypeEnum];

Output Parameter: Returns the list of valid capture count options for Auto Exposure Bracketing (AEB) photos.

Related Parameters: LensTypeEnum

method getPhotoIntervalParamRange​

    fun getPhotoIntervalParamRange(
        lensType: LensTypeEnum
    ): List<Int>

Description: Returns the list of valid interval options for time-lapse photography.

Input Parameters: lensType:Lens type [LensTypeEnum];

Output Parameter: Returns the list of valid interval options for time-lapse photography.

Related Parameters: LensTypeEnum

method getWhiteBalanceList​

  fun getWhiteBalanceList(
        lensType: LensTypeEnum
    ): ArrayList<WhiteBalanceEnum>

Description: Returns the list of available white balance options for the current camera.

Input Parameters: lensType:Lens type [LensTypeEnum];

Output Parameter: Returns the list of available white balance options for the current camera.

Related Parameters: LensTypeEnum,WhiteBalanceEnum

method getCustomColorTemperatureRange​

    fun getCustomColorTemperatureRange(
        lensType: LensTypeEnum
    ): RangeStepIntValue?

Description: Returns the range of custom color temperature values for the current camera's white balance.

Input Parameters: lensType:Lens type [LensTypeEnum];

Output Parameter: Returns the range of custom color temperature values for the current camera's white balance.[RangeStepIntValue]

Related Parameters: LensTypeEnum,RangeStepIntValue

method getDehazeModeRange​

    fun getDehazeModeRange(
        lensType: LensTypeEnum
    ): List<DefogModeEnum>

Description: Returns the list of available dehaze (defog) modes for the current camera.

Input Parameters: lensType:Lens type [LensTypeEnum];

Output Parameter: Returns the list of available dehaze (defog) modes for the current camera.

Related Parameters: LensTypeEnum,DefogModeEnum

method getDehazeSettingSwitchRange​

    fun getDehazeSettingSwitchRange(
        lensType: LensTypeEnum
    ): List<DefogEnum>

Description: Returns the list of available options for enabling or disabling dehaze (defog) settings on the current camera.

Input Parameters: lensType:Lens type [LensTypeEnum];

Output Parameter: Returns the list of available options for enabling or disabling dehaze (defog) settings on the current camera.

Related Parameters: LensTypeEnum,DefogEnum

method getDehazeSettingSwitchMergeRange​

    fun getDehazeSettingSwitchMergeRange(
        lensType: LensTypeEnum
    ): List<DefogEnum>

Description: Returns the list of available options for enabling or disabling dehaze (defog) settings on the current camera.

Input Parameters: lensType:Lens type [LensTypeEnum];

Output Parameter: Returns the list of available options for enabling or disabling dehaze (defog) settings on the current camera.

Related Parameters: LensTypeEnum,DefogEnum

method getAntiFlickerRange​

    fun getAntiFlickerRange(
        lensType: LensTypeEnum
    ): List<Int>

Description: Returns the list of available anti-flicker settings for the current camera.

Input Parameters: lensType:Lens type [LensTypeEnum];

Output Parameter: Returns the list of available anti-flicker settings for the current camera

Related Parameters: LensTypeEnum

method getTransferMode​

    fun getTransferMode(
        lensType: LensTypeEnum
    ): List<VideoTransMissionModeEnum>

Description: Returns the list of available video transmission clarity modes for the current camera.

Input Parameters: lensType:Lens type [LensTypeEnum];

Output Parameter: Returns the list of available video transmission clarity modes for the current camera.

Related Parameters: LensTypeEnum,VideoTransMissionModeEnum

method getPhotoResolution​

    fun getPhotoResolution(
        lensType: LensTypeEnum,
        flightMode: FightModeEnum,
        modeEnum: TakePhotoModeEnum
    ): List<PhotoResolutionEnum>

Description: Returns the list of available photo resolutions for the current camera.

Input Parameters: lensType:Lens type [LensTypeEnum]; flightMode：Flight mode [FightModeEnum]； modeEnum：The current photo taking mode.[TakePhotoModeEnum];

Output Parameter: Returns the list of available photo resolutions for the current camera.

Related Parameters: LensTypeEnum,PhotoResolutionEnum

method getPhotoResolutionTwice​

    fun getPhotoResolutionTwice(
        lensType: LensTypeEnum ,
        flightMode: FightModeEnum,
        modeEnum: TakePhotoModeEnum
    ): List<PhotoResolution>

Description: Returns the list of available photo resolutions for the current camera. If no corresponding enum is available, returns UNKNOWN and retrieves the album resolution list again.

Input Parameters: lensType:Lens type [LensTypeEnum]; flightMode：Flight mode [FightModeEnum]； modeEnum：The current photo taking mode.[TakePhotoModeEnum];

Output Parameter: The list of available photo resolutions for the current camera.

Related Parameters: LensTypeEnum,PhotoResolution

method getSharpnessRange​

    fun getSharpnessRange(
        lensType: LensTypeEnum,
        modeEnum: TakePhotoModeEnum
    ): List<Int>

Description: Returns the list of available sharpness settings for the current camera.

Input Parameters: lensType:Lens type [LensTypeEnum]; modeEnum：The current photo taking mode.[TakePhotoModeEnum];

Output Parameter: Returns the list of available sharpness settings for the current camera.

Related Parameters: LensTypeEnum,TakePhotoModeEnum

method getContrastRange​

    fun getContrastRange(
        lensType: LensTypeEnum,
        modeEnum: TakePhotoModeEnum
    ): List<Int>

Description: Returns the list of available contrast settings for the current camera.

Input Parameters: lensType:Lens type [LensTypeEnum]; modeEnum：The current photo taking mode.[TakePhotoModeEnum];

Output Parameter: Returns the list of available contrast settings for the current camera.

Related Parameters: LensTypeEnum,TakePhotoModeEnum

method getSaturationRange​

    fun getSaturationRange(
        lensType: LensTypeEnum,
        modeEnum: TakePhotoModeEnum
    ): List<Int>

Description: Returns the list of available saturation settings for the current camera.

Input Parameters: lensType:Lens type [LensTypeEnum]; modeEnum：The current photo taking mode.[TakePhotoModeEnum];

Output Parameter: Returns the list of available saturation settings for the current camera.

Related Parameters: LensTypeEnum,TakePhotoModeEnum

method getLensFocusModeRange​

    fun getLensFocusModeRange(
        lensType: LensTypeEnum ,
        modeEnum: CameraModeEnum
    ): List<Int>

Description: Returns the list of available focus modes for the current camera.

Input Parameters: lensType:Lens type [LensTypeEnum]; modeEnum：The current camera mode.[CameraModeEnum];

Output Parameter: Returns the list of available focus modes for the current camera.

Related Parameters: LensTypeEnum,CameraModeEnum

method supportedIrColor​

   fun supportedIrColor(
        lensType: LensTypeEnum
    ): List<ThermalColorEnum>

Description: Returns the list of available thermal imaging pseudo-color information for the current camera.

Input Parameters: lensType:Lens type [LensTypeEnum];

Output Parameter: Returns the list of available thermal imaging pseudo-color information for the current camera.

Related Parameters: LensTypeEnum,ThermalColorEnum

method getThermalIRTempMode​

   fun getThermalIRTempMode(
        lensType: LensTypeEnum
    ): List<IRTempModeEnum>

Description: Returns the list of available thermal imaging temperature measurement modes for the current camera.

Input Parameters: lensType:Lens type [LensTypeEnum];

Output Parameter: Returns the list of available thermal imaging temperature measurement modes for the current camera.

Related Parameters: LensTypeEnum,IRTempModeEnum

method getThermalIrImageEnhance​

    fun getThermalIrImageEnhance(
        lensType: LensTypeEnum
    ): RangeStepIntValue?

Description: Returns the range of thermal imaging image enhancement settings for the current camera.

Input Parameters: lensType:Lens type [LensTypeEnum];

Output Parameter: Returns the range of thermal imaging image enhancement settings for the current camera.[RangeStepIntValue]

Related Parameters: LensTypeEnum,RangeStepIntValue

method getThermalIrNr​

    fun getThermalIrNr(
        lensType: LensTypeEnum
    ): MutableList<Int>

Description: Returns the list of available thermal imaging noise reduction settings for the current camera.

Input Parameters: lensType:Lens type [LensTypeEnum];

Output Parameter: Returns the list of available thermal imaging noise reduction settings for the current camera.

Related Parameters: LensTypeEnum

method getIrGain​

    fun getIrGain(
        lensType: LensTypeEnum
    ): IrGain?

Description: Returns the thermal imaging noise reduction settings.

Input Parameters: lensType:Lens type [LensTypeEnum];

Output Parameter: Returns the thermal imaging noise reduction settings.[IrGain]

Related Parameters: LensTypeEnum，IrGain

method getIrIsoThermMode​

    fun getIrIsoThermMode(
        lensType: LensTypeEnum
    ): List<Int>

Description: Returns the list of available isotherm modes for thermal imaging.

Input Parameters: lensType:Lens type [LensTypeEnum];

Output Parameter: Returns the list of available isotherm modes for thermal imaging.

Related Parameters: LensTypeEnum

method getIrTempAlarm​

  fun getIrTempAlarm(
        lensType: LensTypeEnum
    ): IRHotColdValue?

Description: Returns the thermal imaging temperature alarm settings.

Input Parameters: lensType:Lens type [LensTypeEnum];

Output Parameter: Returns the thermal imaging temperature alarm settings.[IRHotColdValue]

Related Parameters: LensTypeEnum

method isIrTempSpanEnable​

    fun isIrTempSpanEnable(
        lensType: LensTypeEnum
    ): Boolean

Description: Indicates whether infrared temperature span stretching is supported.

Input Parameters: lensType:Lens type [LensTypeEnum];

Output Parameter: Indicates whether infrared temperature span stretching is supported.[IRHotColdValue]

Related Parameters: LensTypeEnum，IRHotColdValue

method getIrTempSpanRange​

    fun getIrTempSpanRange(
        lensType: LensTypeEnum
    ): IRTempSpanValue?

Description: Returns the range of infrared temperature span stretching.

Input Parameters: lensType:Lens type [LensTypeEnum];

Output Parameter: Returns the range of infrared temperature span stretching.[IRTempSpanValue]

Related Parameters: LensTypeEnum，IRTempSpanValue

method getIrNrEmit​

    fun getIrNrEmit(
        lensType: LensTypeEnum
    ): RangeStepIntValue?

Description: Returns the thermal imaging radiation settings.

Input Parameters: lensType:Lens type [LensTypeEnum];

Output Parameter: Returns the thermal imaging radiation settings.[RangeStepIntValue]

Related Parameters: LensTypeEnum,RangeStepIntValue

method getVideoFileCompressionStandard​

    fun getVideoFileCompressionStandard(
        lensType: LensTypeEnum
    ): List<VideoCompressStandardEnum>

Description: Returns the list of supported video file compression standards for the current camera.

Input Parameters: lensType: Lens type [LensTypeEnum];

Output Parameter: Returns the list of supported video file compression standards for the current camera.

Related Parameters: LensTypeEnum,VideoCompressStandardEnum

method getStorageType​

    fun getStorageType(
        lensType: LensTypeEnum
    ): List<StorageTypeEnum>

Description: Returns the list of supported storage types for the current camera.

Input Parameters: lensType: Lens type [LensTypeEnum];

Output Parameter: Returns the list of supported storage types for the current camera.

Related Parameters: LensTypeEnum,StorageTypeEnum

method getPlayerID​

    fun getPlayerID(
        lensType: LensTypeEnum
    ): Int

Description: Returns the player port ID for the current camera type.

Input Parameters: lensType: Lens type [LensTypeEnum];

Output Parameter: Returns the player port ID for the current camera type.

Related Parameters: LensTypeEnum

method getAiServiceEnabled​

    fun getAiServiceEnabled(
        lensType: LensTypeEnum
    ): Boolean

Description: Indicates whether AI services are supported by the lens.

Input Parameters: lensType: Lens type [LensTypeEnum];

Output Parameter: Indicates whether AI services are supported by the lens.

Related Parameters: LensTypeEnum

method getIrcutSwitchRange​

   fun getIrcutSwitchRange(
        lensType: LensTypeEnum
    ): List<IrcutSwitchEnum>?

Description: Returns the list of available Ircut switch options.

Input Parameters: lensType: Lens type [LensTypeEnum];

Output Parameter: Returns the list of available Ircut switch options.

Related Parameters: LensTypeEnum,IrcutSwitchEnum

method isSupportFusion​

    fun isSupportFusion(): Boolean

Description: Indicates whether the gimbal supports thermal fusion.

Input Parameters: None

Output Parameter: Indicates whether the gimbal supports thermal fusion.

Related Parameters: None

method getVersion​

    fun getVersion(): String

Description: Retrieves the gimbal version.

Input Parameters: None

Output Parameter: Retrieves the gimbal version.

Related Parameters: None

method getHFov​

    fun getHFov(lensType: LensTypeEnum):Float?

Description: Returns the horizontal field of view (HFov) for the camera.

Input Parameters: lensType：Lens type [LensTypeEnum]

Output Parameter: Returns the horizontal field of view (HFov) for the camera.

Related Parameters: LensTypeEnum

method getVFov​

    fun getVFov(lensType: LensTypeEnum):Float?

Description: Returns the vertical field of view (VFov) for the camera.

Input Parameters: lensType：Lens type [LensTypeEnum]

Output Parameter: Returns the vertical field of view (VFov) for the camera.

Related Parameters: LensTypeEnum

method getFocalLength​

    fun getFocalLength(lensType: LensTypeEnum):Float?

Description: Returns the focal length for the camera.

Input Parameters: lensType：Lens type [LensTypeEnum]

Output Parameter: Returns the focal length for the camera.

Related Parameters: LensTypeEnum

method isAFAELockSupport​

    fun isAFAELockSupport(lensType: LensTypeEnum): Boolean

Description: Indicates whether the camera supports AFAE lock.

Input Parameters: lensType：Lens type [LensTypeEnum]

Output Parameter: Indicates whether the camera supports AFAE lock.

Related Parameters: LensTypeEnum