ICameraControl::get_Zoom method (vidcap.h)

[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The get_Zoom method returns the camera's optical zoom level.

Syntax

HRESULT get_Zoom(
  [out] long *pValue,
  [out] long *pFlags
);

Parameters

[out] pValue

Receives the zoom level. The units for this setting are not defined. For information about calculating magnification from zoom level, see ICameraControl::get_FocalLengths.

[out] pFlags

Receives one or more flags. See CameraControlFlags.

Return value

Returns an HRESULT value.

Remarks

This method returns the optical zoom level only. To get the digital zoom level, call IVideoProcAmp::get_DigitalMultiplier.

Requirements

Requirement Value
Minimum supported client Windows XP with SP2 [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header vidcap.h
Library Strmiids.lib

See also

Error and Success Codes

ICameraControl Interface