IAMTimelineEffectable::EffectInsBefore 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.]

The EffectInsBefore method inserts an effect into the object at the specified priority level.

Syntax

HRESULT EffectInsBefore(
   IAMTimelineObj *pFX,
   long           Priority
);

Parameters

pFX

Pointer to the IAMTimelineObj interface of the effect.

Priority

Priority level at which to insert the effect. Use the value –1 to insert the effect at the end of the priority list.

Return value

Returns S_OK if successful or E_NOTIMPL if the object is not an effect. Otherwise, returns another HRESULT value indicating the cause of the error.

Remarks

The start and stop times of the effect are clipped within the bounds of the object's time range, if necessary. If there is already an effect at the specified priority level, all the effects from that point on move down the priority list to make room for the new effect.

Requirements

See also

IAMTimelineEffectable Interface

Error and Success Codes