Edit

IAMExtTransport::put_MediaState method (strmif.h)

  • Article

[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 put_MediaState method sets the current state of the media.

Syntax

HRESULT put_MediaState(
  [in] long State
);

Parameters

[in] State

Specifies the media state as a long integer. Use one of the following:

Value Description
ED_MEDIA_SPIN_DOWN For disk media: Stop spinning. For tape media: Unthread the tape.
ED_MEDIA_SPIN_UP For disk media: Start spinning. For tape media: Thread the tape.
ED_MEDIA_UNLOAD Eject the media from the drive.
 

These constants are for disk and tape media. Other devices might need to define new constants.

Return value

When this method succeeds, it returns S_OK. Otherwise it returns an HRESULT error code.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header strmif.h (include Dshow.h)
Library Strmiids.lib

See also

Error and Success Codes

IAMExtTransport Interface

IAMExtTransport::get_MediaState