Skip to content

Imaging

Imaging service implementation.

Imaging

Bases: ONVIFService

0.0.1 1.0 set_imaging.py

Imaging service client.

Property Details
First introduced ONVIF 1.0 (November 2008)
Binding name ImagingBinding (ver20/imaging/wsdl/imaging.wsdl)
Operations imaging.wsdl
Spec Imaging

GetServiceCapabilities 

GetServiceCapabilities()

Returns the capabilities of the imaging service.

The result is returned in a typed answer.

Output
  • Capabilities [Capabilities]
    The capabilities for the imaging service is returned in the Capabilities element.
    • ImageStabilization - optional; [boolean]
      Indicates whether or not Image Stabilization feature is supported. The use of this capability is deprecated, a client should use GetOption to find out if image stabilization is supported.
    • Presets - optional; [boolean]
      Indicates whether or not Imaging Presets feature is supported.
    • AdaptablePreset - optional; [boolean]
      Indicates whether or not imaging preset settings can be updated.

GetOptions 

GetOptions(VideoSourceToken)

This operation gets the valid ranges for the imaging parameters that have device specific ranges.

This command is mandatory for all device implementing the imaging service. The command returns all supported parameters and their ranges such that these can be applied to the SetImagingSettings command.

For read-only parameters which cannot be modified via the SetImagingSettings command only a single option or identical Min and Max values is provided.

Input
  • VideoSourceToken [ReferenceToken]
    Reference token to the VideoSource for which the imaging parameter options are requested.
    Maximum length: 64
Output
  • ImagingOptions [ImagingOptions20]
    Valid ranges for the imaging parameters that are categorized as device specific.
    • BacklightCompensation - optional; [BacklightCompensationOptions20]
      Valid range of Backlight Compensation.
      • Mode - unbounded; [BacklightCompensationMode]
        'ON' or 'OFF'
        Enum Value Enum Description
        OFF Backlight compensation is disabled.
        ON Backlight compensation is enabled.
      • Level - optional; [FloatRange]
        Level range of BacklightCompensation.
        • Min [float]
        • Max [float]
    • Brightness - optional; [FloatRange]
      Valid range of Brightness.
      • Min [float]
      • Max [float]
    • ColorSaturation - optional; [FloatRange]
      Valid range of Color Saturation.
      • Min [float]
      • Max [float]
    • Contrast - optional; [FloatRange]
      Valid range of Contrast.
      • Min [float]
      • Max [float]
    • Exposure - optional; [ExposureOptions20]
      Valid range of Exposure.
      • Mode - unbounded; [ExposureMode]
        Exposure Mode
        • Auto - Enabled the exposure algorithm on the device.
        • Manual - Disabled exposure algorithm on the device.
        Enum Value Enum Description
        AUTO —
        MANUAL —
      • Priority - optional, unbounded; [ExposurePriority]
        The exposure priority mode (low noise/framerate).
        Enum Value Enum Description
        LowNoise —
        FrameRate —
      • MinExposureTime - optional; [FloatRange]
        Valid range of the Minimum ExposureTime.
        • Min [float]
        • Max [float]
      • MaxExposureTime - optional; [FloatRange]
        Valid range of the Maximum ExposureTime.
        • Min [float]
        • Max [float]
      • MinGain - optional; [FloatRange]
        Valid range of the Minimum Gain.
        • Min [float]
        • Max [float]
      • MaxGain - optional; [FloatRange]
        Valid range of the Maximum Gain.
        • Min [float]
        • Max [float]
      • MinIris - optional; [FloatRange]
        Valid range of the Minimum Iris.
        • Min [float]
        • Max [float]
      • MaxIris - optional; [FloatRange]
        Valid range of the Maximum Iris.
        • Min [float]
        • Max [float]
      • ExposureTime - optional; [FloatRange]
        Valid range of the ExposureTime.
        • Min [float]
        • Max [float]
      • Gain - optional; [FloatRange]
        Valid range of the Gain.
        • Min [float]
        • Max [float]
      • Iris - optional; [FloatRange]
        Valid range of the Iris.
        • Min [float]
        • Max [float]
    • Focus - optional; [FocusOptions20]
      Valid range of Focus.
      • AutoFocusModes - optional, unbounded; [AutoFocusMode]
        Supported modes for auto focus.
        • AUTO - The device supports automatic focus adjustment.
        • MANUAL - The device supports manual focus adjustment.
        Enum Value Enum Description
        AUTO —
        MANUAL —
      • DefaultSpeed - optional; [FloatRange]
        Valid range of DefaultSpeed.
        • Min [float]
        • Max [float]
      • NearLimit - optional; [FloatRange]
        Valid range of NearLimit.
        • Min [float]
        • Max [float]
      • FarLimit - optional; [FloatRange]
        Valid range of FarLimit.
        • Min [float]
        • Max [float]
      • Extension - optional; [FocusOptions20Extension]
        • AFModes - optional; [StringAttrList]
          Supported options for auto focus. Options shall be chosen from tt:AFModes.
    • IrCutFilterModes - optional, unbounded; [IrCutFilterMode]
      Valid range of IrCutFilterModes.
      Enum Value Enum Description
      ON —
      OFF —
      AUTO —
    • Sharpness - optional; [FloatRange]
      Valid range of Sharpness.
      • Min [float]
      • Max [float]
    • WideDynamicRange - optional; [WideDynamicRangeOptions20]
      Valid range of WideDynamicRange.
      • Mode - unbounded; [WideDynamicMode]
        Enum Value Enum Description
        OFF —
        ON —
      • Level - optional; [FloatRange]
        • Min [float]
        • Max [float]
    • WhiteBalance - optional; [WhiteBalanceOptions20]
      Valid range of WhiteBalance.
      • Mode - unbounded; [WhiteBalanceMode]
        Mode of WhiteBalance.
        • AUTO
        • MANUAL
        Enum Value Enum Description
        AUTO —
        MANUAL —
      • YrGain - optional; [FloatRange]
        • Min [float]
        • Max [float]
      • YbGain - optional; [FloatRange]
        • Min [float]
        • Max [float]
      • Extension - optional; [WhiteBalanceOptions20Extension]
    • Extension - optional; [ImagingOptions20Extension]
      • ImageStabilization - optional; [ImageStabilizationOptions]
        Options of parameters for Image Stabilization feature.
        • Mode - unbounded; [ImageStabilizationMode]
          Supported options of Image Stabilization mode parameter.
          Enum Value Enum Description
          OFF —
          ON —
          AUTO —
          Extended —
        • Level - optional; [FloatRange]
          Valid range of the Image Stabilization.
          • Min [float]
          • Max [float]
        • Extension - optional; [ImageStabilizationOptionsExtension]
      • Extension - optional; [ImagingOptions20Extension2]
        • IrCutFilterAutoAdjustment - optional; [IrCutFilterAutoAdjustmentOptions]
          Options of parameters for adjustment of Ir cut filter auto mode.
          • BoundaryType - unbounded; [string]
            Supported options of boundary types for adjustment of Ir cut filter auto mode. The options shall be chosen from tt:IrCutFilterAutoBoundaryType.
          • BoundaryOffset - optional; [boolean]
            Indicates whether or not boundary offset for toggling Ir cut filter is supported.
          • ResponseTimeRange - optional; [DurationRange]
            Supported range of delay time for toggling Ir cut filter.
            • Min [duration]
            • Max [duration]
          • Extension - optional; [IrCutFilterAutoAdjustmentOptionsExtension]
        • Extension - optional; [ImagingOptions20Extension3]
          • ToneCompensationOptions - optional; [ToneCompensationOptions]
            Options of parameters for Tone Compensation feature.
            • Mode - unbounded; [string]
              Supported options for Tone Compensation mode. Its options shall be chosen from tt:ToneCompensationMode Type.
            • Level [boolean]
              Indicates whether or not support Level parameter for Tone Compensation.
          • DefoggingOptions - optional; [DefoggingOptions]
            Options of parameters for Defogging feature.
            • Mode - unbounded; [string]
              Supported options for Defogging mode. Its options shall be chosen from tt:DefoggingMode Type.
            • Level [boolean]
              Indicates whether or not support Level parameter for Defogging.
          • NoiseReductionOptions - optional; [NoiseReductionOptions]
            Options of parameter for Noise Reduction feature.
            • Level [boolean]
              Indicates whether or not support Level parameter for NoiseReduction.
          • Extension - optional; [ImagingOptions20Extension4]

GetImagingSettings 

GetImagingSettings(VideoSourceToken)

Get the ImagingConfiguration for the requested VideoSource.

Input
  • VideoSourceToken [ReferenceToken]
    Reference token to the VideoSource for which the ImagingSettings.
    Maximum length: 64
Output
  • ImagingSettings [ImagingSettings20]
    ImagingSettings for the VideoSource that was requested.
    • BacklightCompensation - optional; [BacklightCompensation20]
      Enabled/disabled BLC mode (on/off).
      • Mode [BacklightCompensationMode]
        Backlight compensation mode (on/off).
        Enum Value Enum Description
        OFF Backlight compensation is disabled.
        ON Backlight compensation is enabled.
      • Level - optional; [float]
        Optional level parameter (unit unspecified).
    • Brightness - optional; [float]
      Image brightness (unit unspecified).
    • ColorSaturation - optional; [float]
      Color saturation of the image (unit unspecified).
    • Contrast - optional; [float]
      Contrast of the image (unit unspecified).
    • Exposure - optional; [Exposure20]
      Exposure mode of the device.
      • Mode [ExposureMode]
        Exposure Mode
        • Auto - Enabled the exposure algorithm on the device.
        • Manual - Disabled exposure algorithm on the device.
        Enum Value Enum Description
        AUTO —
        MANUAL —
      • Priority - optional; [ExposurePriority]
        The exposure priority mode (low noise/framerate).
        Enum Value Enum Description
        LowNoise —
        FrameRate —
      • Window - optional; [Rectangle]
        Rectangular exposure mask.
        • bottom - required; [float]
        • top - required; [float]
        • right - required; [float]
        • left - required; [float]
      • MinExposureTime - optional; [float]
        Minimum value of exposure time range allowed to be used by the algorithm.
      • MaxExposureTime - optional; [float]
        Maximum value of exposure time range allowed to be used by the algorithm.
      • MinGain - optional; [float]
        Minimum value of the sensor gain range that is allowed to be used by the algorithm.
      • MaxGain - optional; [float]
        Maximum value of the sensor gain range that is allowed to be used by the algorithm.
      • MinIris - optional; [float]
        Minimum value of the iris range allowed to be used by the algorithm. 0dB maps to a fully opened iris and positive values map to higher attenuation.
      • MaxIris - optional; [float]
        Maximum value of the iris range allowed to be used by the algorithm. 0dB maps to a fully opened iris and positive values map to higher attenuation.
      • ExposureTime - optional; [float]
        The fixed exposure time used by the image sensor (μs).
      • Gain - optional; [float]
        The fixed gain used by the image sensor (dB).
      • Iris - optional; [float]
        The fixed attenuation of input light affected by the iris (dB). 0dB maps to a fully opened iris and positive values map to higher attenuation.
    • Focus - optional; [FocusConfiguration20]
      Focus configuration.
      • AFMode - optional; [StringAttrList]
        Zero or more modes as defined in enumeration tt:AFModes.
      • AutoFocusMode [AutoFocusMode]
        Mode of auto focus.
        • AUTO - The device automatically adjusts focus.
        • MANUAL - The device does not automatically adjust focus.
        Note: for devices supporting both manual and auto operation at the same time manual operation may be supported even if the Mode parameter is set to Auto.
        Enum Value Enum Description
        AUTO —
        MANUAL —
      • DefaultSpeed - optional; [float]
      • NearLimit - optional; [float]
        Parameter to set autofocus near limit (unit: meter).
      • FarLimit - optional; [float]
        Parameter to set autofocus far limit (unit: meter).
      • Extension - optional; [FocusConfiguration20Extension]
    • IrCutFilter - optional; [IrCutFilterMode]
      Infrared Cutoff Filter settings.
      Enum Value Enum Description
      ON —
      OFF —
      AUTO —
    • Sharpness - optional; [float]
      Sharpness of the Video image.
    • WideDynamicRange - optional; [WideDynamicRange20]
      WDR settings.
      • Mode [WideDynamicMode]
        Wide dynamic range mode (on/off).
        Enum Value Enum Description
        OFF —
        ON —
      • Level - optional; [float]
        Optional level parameter (unit unspecified).
    • WhiteBalance - optional; [WhiteBalance20]
      White balance settings.
      • Mode [WhiteBalanceMode]
        'AUTO' or 'MANUAL'
        Enum Value Enum Description
        AUTO —
        MANUAL —
      • CrGain - optional; [float]
        Rgain (unitless).
      • CbGain - optional; [float]
        Bgain (unitless).
      • Extension - optional; [WhiteBalance20Extension]
    • Extension - optional; [ImagingSettingsExtension20]
      • ImageStabilization - optional; [ImageStabilization]
        Optional element to configure Image Stabilization feature.
        • Mode [ImageStabilizationMode]
          Parameter to enable/disable Image Stabilization feature.
          Enum Value Enum Description
          OFF —
          ON —
          AUTO —
          Extended —
        • Level - optional; [float]
          Optional level parameter (unit unspecified)
        • Extension - optional; [ImageStabilizationExtension]
      • Extension - optional; [ImagingSettingsExtension202]
        • IrCutFilterAutoAdjustment - optional, unbounded; [IrCutFilterAutoAdjustment]
          An optional parameter applied to only auto mode to adjust timing of toggling Ir cut filter.
          • BoundaryType [string]
            Specifies which boundaries to automatically toggle Ir cut filter following parameters are applied to. Its options shall be chosen from tt:IrCutFilterAutoBoundaryType.
          • BoundaryOffset - optional; [float]
            Adjusts boundary exposure level for toggling Ir cut filter to on/off specified with unitless normalized value from +1.0 to -1.0. Zero is default and -1.0 is the darkest adjustment (Unitless).
          • ResponseTime - optional; [duration]
            Delay time of toggling Ir cut filter to on/off after crossing of the boundary exposure levels.
          • Extension - optional; [IrCutFilterAutoAdjustmentExtension]
        • Extension - optional; [ImagingSettingsExtension203]
          • ToneCompensation - optional; [ToneCompensation]
            Optional element to configure Image Contrast Compensation.
            • Mode [string]
              Parameter to enable/disable or automatic ToneCompensation feature. Its options shall be chosen from tt:ToneCompensationMode Type.
            • Level - optional; [float]
              Optional level parameter specified with unitless normalized value from 0.0 to +1.0.
            • Extension - optional; [ToneCompensationExtension]
          • Defogging - optional; [Defogging]
            Optional element to configure Image Defogging.
            • Mode [string]
              Parameter to enable/disable or automatic Defogging feature. Its options shall be chosen from tt:DefoggingMode Type.
            • Level - optional; [float]
              Optional level parameter specified with unitless normalized value from 0.0 to +1.0.
            • Extension - optional; [DefoggingExtension]
          • NoiseReduction - optional; [NoiseReduction]
            Optional element to configure Image Noise Reduction.
            • Level [float]
              Level parameter specified with unitless normalized value from 0.0 to +1.0. Level=0 means no noise reduction or minimal noise reduction.
          • Extension - optional; [ImagingSettingsExtension204]

SetImagingSettings 

SetImagingSettings(
    VideoSourceToken, ImagingSettings, ForcePersistence=None
)

Set the ImagingConfiguration for the requested VideoSource.

Input
  • VideoSourceToken [ReferenceToken]
    Maximum length: 64
  • ImagingSettings [ImagingSettings20]
    • BacklightCompensation - optional; [BacklightCompensation20]
      Enabled/disabled BLC mode (on/off).
      • Mode [BacklightCompensationMode]
        Backlight compensation mode (on/off).
        Enum Value Enum Description
        OFF Backlight compensation is disabled.
        ON Backlight compensation is enabled.
      • Level - optional; [float]
        Optional level parameter (unit unspecified).
    • Brightness - optional; [float]
      Image brightness (unit unspecified).
    • ColorSaturation - optional; [float]
      Color saturation of the image (unit unspecified).
    • Contrast - optional; [float]
      Contrast of the image (unit unspecified).
    • Exposure - optional; [Exposure20]
      Exposure mode of the device.
      • Mode [ExposureMode]
        Exposure Mode
        • Auto - Enabled the exposure algorithm on the device.
        • Manual - Disabled exposure algorithm on the device.
        Enum Value Enum Description
        AUTO —
        MANUAL —
      • Priority - optional; [ExposurePriority]
        The exposure priority mode (low noise/framerate).
        Enum Value Enum Description
        LowNoise —
        FrameRate —
      • Window - optional; [Rectangle]
        Rectangular exposure mask.
        • bottom - required; [float]
        • top - required; [float]
        • right - required; [float]
        • left - required; [float]
      • MinExposureTime - optional; [float]
        Minimum value of exposure time range allowed to be used by the algorithm.
      • MaxExposureTime - optional; [float]
        Maximum value of exposure time range allowed to be used by the algorithm.
      • MinGain - optional; [float]
        Minimum value of the sensor gain range that is allowed to be used by the algorithm.
      • MaxGain - optional; [float]
        Maximum value of the sensor gain range that is allowed to be used by the algorithm.
      • MinIris - optional; [float]
        Minimum value of the iris range allowed to be used by the algorithm. 0dB maps to a fully opened iris and positive values map to higher attenuation.
      • MaxIris - optional; [float]
        Maximum value of the iris range allowed to be used by the algorithm. 0dB maps to a fully opened iris and positive values map to higher attenuation.
      • ExposureTime - optional; [float]
        The fixed exposure time used by the image sensor (μs).
      • Gain - optional; [float]
        The fixed gain used by the image sensor (dB).
      • Iris - optional; [float]
        The fixed attenuation of input light affected by the iris (dB). 0dB maps to a fully opened iris and positive values map to higher attenuation.
    • Focus - optional; [FocusConfiguration20]
      Focus configuration.
      • AFMode - optional; [StringAttrList]
        Zero or more modes as defined in enumeration tt:AFModes.
      • AutoFocusMode [AutoFocusMode]
        Mode of auto focus.
        • AUTO - The device automatically adjusts focus.
        • MANUAL - The device does not automatically adjust focus.
        Note: for devices supporting both manual and auto operation at the same time manual operation may be supported even if the Mode parameter is set to Auto.
        Enum Value Enum Description
        AUTO —
        MANUAL —
      • DefaultSpeed - optional; [float]
      • NearLimit - optional; [float]
        Parameter to set autofocus near limit (unit: meter).
      • FarLimit - optional; [float]
        Parameter to set autofocus far limit (unit: meter).
      • Extension - optional; [FocusConfiguration20Extension]
    • IrCutFilter - optional; [IrCutFilterMode]
      Infrared Cutoff Filter settings.
      Enum Value Enum Description
      ON —
      OFF —
      AUTO —
    • Sharpness - optional; [float]
      Sharpness of the Video image.
    • WideDynamicRange - optional; [WideDynamicRange20]
      WDR settings.
      • Mode [WideDynamicMode]
        Wide dynamic range mode (on/off).
        Enum Value Enum Description
        OFF —
        ON —
      • Level - optional; [float]
        Optional level parameter (unit unspecified).
    • WhiteBalance - optional; [WhiteBalance20]
      White balance settings.
      • Mode [WhiteBalanceMode]
        'AUTO' or 'MANUAL'
        Enum Value Enum Description
        AUTO —
        MANUAL —
      • CrGain - optional; [float]
        Rgain (unitless).
      • CbGain - optional; [float]
        Bgain (unitless).
      • Extension - optional; [WhiteBalance20Extension]
    • Extension - optional; [ImagingSettingsExtension20]
      • ImageStabilization - optional; [ImageStabilization]
        Optional element to configure Image Stabilization feature.
        • Mode [ImageStabilizationMode]
          Parameter to enable/disable Image Stabilization feature.
          Enum Value Enum Description
          OFF —
          ON —
          AUTO —
          Extended —
        • Level - optional; [float]
          Optional level parameter (unit unspecified)
        • Extension - optional; [ImageStabilizationExtension]
      • Extension - optional; [ImagingSettingsExtension202]
        • IrCutFilterAutoAdjustment - optional, unbounded; [IrCutFilterAutoAdjustment]
          An optional parameter applied to only auto mode to adjust timing of toggling Ir cut filter.
          • BoundaryType [string]
            Specifies which boundaries to automatically toggle Ir cut filter following parameters are applied to. Its options shall be chosen from tt:IrCutFilterAutoBoundaryType.
          • BoundaryOffset - optional; [float]
            Adjusts boundary exposure level for toggling Ir cut filter to on/off specified with unitless normalized value from +1.0 to -1.0. Zero is default and -1.0 is the darkest adjustment (Unitless).
          • ResponseTime - optional; [duration]
            Delay time of toggling Ir cut filter to on/off after crossing of the boundary exposure levels.
          • Extension - optional; [IrCutFilterAutoAdjustmentExtension]
        • Extension - optional; [ImagingSettingsExtension203]
          • ToneCompensation - optional; [ToneCompensation]
            Optional element to configure Image Contrast Compensation.
            • Mode [string]
              Parameter to enable/disable or automatic ToneCompensation feature. Its options shall be chosen from tt:ToneCompensationMode Type.
            • Level - optional; [float]
              Optional level parameter specified with unitless normalized value from 0.0 to +1.0.
            • Extension - optional; [ToneCompensationExtension]
          • Defogging - optional; [Defogging]
            Optional element to configure Image Defogging.
            • Mode [string]
              Parameter to enable/disable or automatic Defogging feature. Its options shall be chosen from tt:DefoggingMode Type.
            • Level - optional; [float]
              Optional level parameter specified with unitless normalized value from 0.0 to +1.0.
            • Extension - optional; [DefoggingExtension]
          • NoiseReduction - optional; [NoiseReduction]
            Optional element to configure Image Noise Reduction.
            • Level [float]
              Level parameter specified with unitless normalized value from 0.0 to +1.0. Level=0 means no noise reduction or minimal noise reduction.
          • Extension - optional; [ImagingSettingsExtension204]
  • ForcePersistence - optional; [boolean]

GetMoveOptions 

GetMoveOptions(VideoSourceToken)

Imaging move operation options supported for the Video source.

Input
  • VideoSourceToken [ReferenceToken]
    Reference token to the VideoSource for the requested move options.
    Maximum length: 64
Output
  • MoveOptions [MoveOptions20]
    Valid ranges for the focus lens move options.
    • Absolute - optional; [AbsoluteFocusOptions]
      Valid ranges for the absolute control.
      • Position [FloatRange]
        Valid ranges of the position.
        • Min [float]
        • Max [float]
      • Speed - optional; [FloatRange]
        Valid ranges of the speed.
        • Min [float]
        • Max [float]
    • Relative - optional; [RelativeFocusOptions20]
      Valid ranges for the relative control.
      • Distance [FloatRange]
        Valid ranges of the distance.
        • Min [float]
        • Max [float]
      • Speed - optional; [FloatRange]
        Valid ranges of the speed.
        • Min [float]
        • Max [float]
    • Continuous - optional; [ContinuousFocusOptions]
      Valid ranges for the continuous control.
      • Speed [FloatRange]
        Valid ranges of the speed.
        • Min [float]
        • Max [float]

Move 

Move(VideoSourceToken, Focus)

The Move command moves the focus lens in an absolute, a relative or in a continuous manner from its current position.

The speed argument is optional for absolute and relative control, but required for continuous. If no speed argument is used, the default speed is used. Focus adjustments through this operation will turn off the autofocus. A device with support for remote focus control should support absolute, relative or continuous control through the Move operation. The supported MoveOpions are signalled via the GetMoveOptions command. At least one focus control capability is required for this operation to be functional.

The move operation contains the following commands:

Absolute – Requires position parameter and optionally takes a speed argument. A unitless type is used by default for focus positioning and speed. Optionally, if supported, the position may be requested in m-1 units.

Relative – Requires distance parameter and optionally takes a speed argument. Negative distance means negative direction.

Continuous – Requires a speed argument. Negative speed argument means negative direction.

Input
  • VideoSourceToken [ReferenceToken]
    Reference to the VideoSource for the requested move (focus) operation.
    Maximum length: 64
  • Focus [FocusMove]
    Content of the requested move (focus) operation.
    • Absolute - optional; [AbsoluteFocus]
      Parameters for the absolute focus control.
      • Position [float]
        Position parameter for the absolute focus control.
      • Speed - optional; [float]
        Speed parameter for the absolute focus control.
    • Relative - optional; [RelativeFocus]
      Parameters for the relative focus control.
      • Distance [float]
        Distance parameter for the relative focus control.
      • Speed - optional; [float]
        Speed parameter for the relative focus control.
    • Continuous - optional; [ContinuousFocus]
      Parameter for the continuous focus control.
      • Speed [float]
        Speed parameter for the Continuous focus control.

GetStatus 

GetStatus(VideoSourceToken)

Via this command the current status of the Move operation can be requested.

Supported for this command is available if the support for the Move operation is signalled via GetMoveOptions.

Input
  • VideoSourceToken [ReferenceToken]
    Reference token to the VideoSource where the imaging status should be requested.
    Maximum length: 64
Output
  • Status [ImagingStatus20]
    Requested imaging status.
    • FocusStatus20 - optional; [FocusStatus20]
      Status of focus.
      • Position [float]
        Status of focus position.
      • MoveStatus [MoveStatus]
        Status of focus MoveStatus.
        Enum Value Enum Description
        IDLE —
        MOVING —
        UNKNOWN —
      • Error - optional; [string]
        Error status of focus.
      • Extension - optional; [FocusStatus20Extension]
    • Extension - optional; [ImagingStatus20Extension]

Stop 

Stop(VideoSourceToken)

The Stop command stops all ongoing focus movements of the lense.

A device with support for remote focus control as signalled via the GetMoveOptions supports this command.

The operation will not affect ongoing autofocus operation.

Input
  • VideoSourceToken [ReferenceToken]
    Reference token to the VideoSource where the focus movement should be stopped.
    Maximum length: 64

GetPresets 

GetPresets(VideoSourceToken)

Via this command the list of available Imaging Presets can be requested.

Input
  • VideoSourceToken [ReferenceToken]
    A reference to the VideoSource where the operation should take place.
    Maximum length: 64
Output
  • Preset - unbounded; [ImagingPreset]
    List of Imaging Presets which are available for the requested VideoSource.
    • token - required; [ReferenceToken]
      Unique identifier of this Imaging Preset.
    • type - required; [string]
      Indicates Imaging Preset Type. Use timg:ImagingPresetType. Used for multi-language support and display.
    • Name [Name]
      Human readable name of the Imaging Preset.
      Maximum length: 64

GetCurrentPreset 

GetCurrentPreset(VideoSourceToken)

Via this command the last Imaging Preset applied can be requested.

If the camera configuration does not match any of the existing Imaging Presets, the output of GetCurrentPreset shall be Empty. GetCurrentPreset shall return 0 if Imaging Presets are not supported by the Video Source.

Input
  • VideoSourceToken [ReferenceToken]
    Reference token to the VideoSource where the current Imaging Preset should be requested.
    Maximum length: 64
Output
  • Preset - optional; [ImagingPreset]
    Current Imaging Preset in use for the specified Video Source.
    • token - required; [ReferenceToken]
      Unique identifier of this Imaging Preset.
    • type - required; [string]
      Indicates Imaging Preset Type. Use timg:ImagingPresetType. Used for multi-language support and display.
    • Name [Name]
      Human readable name of the Imaging Preset.
      Maximum length: 64

SetCurrentPreset 

SetCurrentPreset(VideoSourceToken, PresetToken)

The SetCurrentPreset command shall request a given Imaging Preset to be applied to the specified Video Source.

SetCurrentPreset shall only be available for Video Sources with Imaging Presets Capability. Imaging Presets are defined by the Manufacturer, and offered as a tool to simplify Imaging Settings adjustments for specific scene content. When the new Imaging Preset is applied by SetCurrentPreset, the Device shall adjust the Video Source settings to match those defined by the specified Imaging Preset.

Input
  • VideoSourceToken [ReferenceToken]
    Reference token to the VideoSource to which the specified Imaging Preset should be applied.
    Maximum length: 64
  • PresetToken [ReferenceToken]
    Reference token to the Imaging Preset to be applied to the specified Video Source.
    Maximum length: 64