IMultiMediaStream::SetState method (mmstream.h)

Article
4/26/2023

[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 This interface is deprecated. New applications should not use it.

The SetState method runs or stops the multimedia stream object.

Syntax

HRESULT SetState(
  [in] STREAM_STATE NewState
);

Parameters

[in] NewState

A member of the STREAM_STATE enumeration, specifying the new state (running or stopped).

Return value

Returns an HRESULT value. Possible values include the following.

Return code	Description
E_INVALIDARG	Invalid argument.
S_OK	Success.

Remarks

Stopping the multimedia stream object deletes any data that is pending.

Requirements

Requirement	Value
Target Platform	Windows
Header	mmstream.h

Share via