Skip to content

Latest commit

 

History

History
118 lines (96 loc) · 3.79 KB

nf-mfidl-imfmediasource-pause.md

File metadata and controls

118 lines (96 loc) · 3.79 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:mfidl.IMFMediaSource.Pause
IMFMediaSource::Pause (mfidl.h)
Pauses all active streams in the media source.
113b3dc7-918e-427e-aa70-cf474b951c6d
IMFMediaSource interface [Media Foundation]
Pause method
IMFMediaSource.Pause
IMFMediaSource::Pause
Pause
Pause method [Media Foundation]
Pause method [Media Foundation]
IMFMediaSource interface
mf.imfmediasource_pause
mfidl/IMFMediaSource::Pause
mf\imfmediasource_pause.htm
mf
113b3dc7-918e-427e-aa70-cf474b951c6d
12/05/2018
113b3dc7-918e-427e-aa70-cf474b951c6d, IMFMediaSource interface [Media Foundation],Pause method, IMFMediaSource.Pause, IMFMediaSource::Pause, Pause, Pause method [Media Foundation], Pause method [Media Foundation],IMFMediaSource interface, mf.imfmediasource_pause, mfidl/IMFMediaSource::Pause
mfidl.h
Windows
Windows Vista [desktop apps \| UWP apps]
Windows Server 2008 [desktop apps \| UWP apps]
Mfuuid.lib
Windows
19H1
IMFMediaSource::Pause
mfidl/IMFMediaSource::Pause
c++
APIRef
kbSyntax
COM
mfuuid.lib
mfuuid.dll
IMFMediaSource.Pause

IMFMediaSource::Pause

-description

Pauses all active streams in the media source.

-returns

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_INVALID_STATE_TRANSITION
Invalid state transition. The media source must be in the started state.
MF_E_SHUTDOWN
The media source's Shutdown method has been called.

-remarks

This method is asynchronous. When the operation completes, the media source sends and MESourcePaused event, and every active stream sends an MEStreamPaused event. If the method returns a failure code, no events are raised.

The media source must be in the started state. The method fails if the media source is paused or stopped.

While the source is paused, calls to IMFMediaStream::RequestSample succeed, but the streams will not deliver any samples until after the source is started again. Note that the source's event queue is not serialized with the stream event queues, so the client might receive some samples after the MESourcePaused event, due to multi-threading issues. But the client will not receive any samples from a stream after the MEStreamPaused event.

Not every media source can pause. If a media source can pause, the IMFMediaSource::GetCharacteristics method returns the MFMEDIASOURCE_CAN_PAUSE flag.

-see-also

IMFMediaSource

Media Sources