Edit

IMFMediaSession::ClearTopologies method (mfidl.h)

  • Article

Clears all of the presentations that are queued for playback in the Media Session.

Syntax

HRESULT ClearTopologies();

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code Description
S_OK
 The method succeeded.
MF_E_INVALIDREQUEST
 The operation cannot be performed in the Media Session's current state.
MF_E_SHUTDOWN
 The Media Session has been shut down.

Remarks

This method is asynchronous. When the operation completes, the Media Session sends an MESessionTopologiesCleared event.

This method does not clear the current topology; it only removes topologies that are placed in the queue, waiting for playback. To remove the current topology, call IMFMediaSession::SetTopology with the MFSESSION_SETTOPOLOGY_CLEAR_CURRENT flag.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header mfidl.h
Library Mfuuid.lib

See also

IMFMediaSession