Share via


IMSVidPlayback::get_Rate method (segment.h)

[The feature associated with this page, Microsoft TV Technologies, is a legacy feature. Microsoft strongly recommends that new code does not use this feature.]

The get_Rate method retrieves the playback rate.

Syntax

HRESULT get_Rate(
  [out] double *plRate
);

Parameters

[out] plRate

Pointer to a variable that receives the playback rate, as a ratio to the authored rate. For example, 0.5 means half the normal speed, 1.0 means normal speed, and 2.0 means twice the normal speed.

Return value

The method returns an HRESULT. Possible values include the following.

Return code Description
E_POINTER
NULL pointer argument.
ERROR_INVALID_STATE
The graph is not built. Call the Build or View method on the Video Control.
S_OK
The method succeeded.
Note��The value ERROR_INVALID_STATE is converted to an HRESULT with the HRESULT_FROM_WIN32 macro.

Requirements

Requirement Value
Minimum supported client Windows�XP [desktop apps only]
Minimum supported server None supported
Target Platform Windows
Header segment.h (include Msvidctl.h)

See also

IMSVidPlayback Interface