IAMTimelineEffectable::GetEffect 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 GetEffect method retrieves the effect at the specified priority level.

Syntax

HRESULT GetEffect(
  [out] IAMTimelineObj **ppFX,
        long           Which
);

Parameters

ppFX [out]

Receives the effect's IAMTimelineObj interface.

Which

Priority level of the effect to retrieve.

Return value

Returns an HRESULT value. Possible values include the following:

Return code Description
S_FALSE
No effect at the specified priority,
S_OK
Success.
E_POINTER
NULL pointer argument.

 

Remarks

If the method returns S_OK, the IAMTimelineObj interface that it returns has an outstanding reference count. Be sure to release the interface when you are finished using it.

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

IAMTimelineEffectable Interface

Error and Success Codes