IMFMediaEngineEx::InsertAudioEffect method

Inserts an audio effect.

Syntax


HRESULT InsertAudioEffect(
  [in]  IUnknown *pEffect,
  [in]  BOOL fOptional
);

Parameters

pEffect [in]

One of the following:

  • A pointer to the IMFTransform interface of a Media Foundation transform (MFT) that implements the audio effect.
  • A pointer to the IMFActivate interface of an activation object. The activation object must create an MFT for the audio effect.
fOptional [in]

Specifies whether the effect is optional.

ValueMeaning
TRUE

The effect is optional. If the Media Engine cannot add the effect, it ignores the effect and continues playback.

FALSE

The effect is required. If the Media Engine object cannot add the effect, a playback error occurs.

 

Return value

This method can return one of these values.

Return codeDescription
S_OK

Success.

MF_E_INVALIDREQUEST

The maximum number of audio effects was reached.

 

Remarks

The effect is applied when the next media resource is loaded.

Requirements

Minimum supported client

Windows 8 [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2012 [desktop apps | Windows Store apps]

Header

Mfmediaengine.h

See also

IMFMediaEngineEx

 

 

Community Additions

ADD
Show:
© 2014 Microsoft