IMediaDet::get_FrameRate method

[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.]

Note

[Deprecated. This API may be removed from future releases of Windows.]

 

The get_FrameRate method retrieves the frame rate of the current stream. The stream must be a video stream.

Syntax

HRESULT get_FrameRate(
  [out, retval] double *pVal
);

Parameters

pVal [out, retval]

Receives the frame rate, in frames per second.

Return value

Returns an HRESULT value. Possible values include the following:

Return code	Description
S_FALSE	Video format header does not specify a frame rate.
S_OK	Success.
E_INVALIDARG	Invalid argument.
E_POINTER	NULL pointer argument.
VFW_E_INVALIDMEDIATYPE	Invalid media type.

 

Remarks

This method cannot retrieve the frame rate from an ASF file.

Before calling this method, set the file name and stream by calling IMediaDet::put_Filename and IMediaDet::put_CurrentStream.

If the media detector is in bitmap grab mode, this method returns E_INVALIDARG. For more information, see IMediaDet::EnterBitmapGrabMode.

Note

The header file Qedit.h is not compatible with Direct3D headers later than version 7.

 

Note

To obtain Qedit.h, download the Microsoft Windows SDK Update for Windows Vista and .NET Framework 3.0. Qedit.h is not available in the Microsoft Windows SDK for Windows 7 and .NET Framework 3.5 Service Pack 1.

 

Requirements

Requirement	Value
Header	Qedit.h
Library	Strmiids.lib

See also

IMediaDet Interface

Error and Success Codes