IMediaPosition::put_Rate method (control.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 put_Rate method sets the playback rate.

Syntax

HRESULT put_Rate(
  [in] double dRate
);

Parameters

[in] dRate

Playback rate. Must not be zero.

Return value

Returns an HRESULT value. Possible values include the following.

Remarks

The playback rate is expressed as a ratio of the normal speed. Thus, 1.0 is normal playback speed, 0.5 is half speed, and 2.0 is twice speed. For audio streams, changing the rate also changes the pitch.

For more information, see the remarks in IMediaSeeking::SetRate.

Requirements

See also

Error and Success Codes

IMediaPosition Interface