IMFRateSupport::GetFastestRate method (mfidl.h)

Article
02/22/2024

Gets the fastest playback rate supported by the object.

Syntax

HRESULT GetFastestRate(
  [in]  MFRATE_DIRECTION eDirection,
  [in]  BOOL             fThin,
  [out] float            *pflRate
);

Parameters

[in] eDirection

Specifies whether to query to the fastest forward playback rate or reverse playback rate. The value is a member of the MFRATE_DIRECTION enumeration.

[in] fThin

If TRUE, the method retrieves the fastest thinned playback rate. Otherwise, the method retrieves the fastest non-thinned playback rate. For information about thinning, see About Rate Control.

[out] pflRate

Receives the fastest playback rate that the object supports.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code	Description
S_OK	The method succeeded.
MF_E_REVERSE_UNSUPPORTED	The object does not support reverse playback.
MF_E_THINNING_UNSUPPORTED	The object does not support thinning.

Remarks

For some formats (such as ASF), thinning means dropping all frames that are not I-frames. If a component produces stream data, such as a media source or a demultiplexer, it should pay attention to the fThin parameter and return MF_E_THINNING_UNSUPPORTED if it cannot thin the stream.

If the component processes or receives a stream (most transforms or media sinks), it may ignore this parameter if it does not care whether the stream is thinned. In the Media Session's implementation of rate support, if the transforms do not explicitly support reverse playback, the Media Session will attempt to playback in reverse with thinning but not without thinning. Therefore, most applications will set fThin to TRUE when using the Media Session for reverse playback.

If eDirection is MFRATE_REVERSE, the method retrieves the fastest reverse playback rate. This is a negative value, assuming the object supports reverse playback.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2008 [desktop apps \| UWP apps]
Target Platform	Windows
Header	mfidl.h
Library	Mfuuid.lib