IMFPMediaItem::SetStreamSelection method (mfplay.h)

Article
12/05/2018

[The feature associated with this page, MFPlay, is a legacy feature. It has been superseded by MediaPlayer and IMFMediaEngine. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

Selects or deselects a stream.

Syntax

HRESULT SetStreamSelection(
  [in] DWORD dwStreamIndex,
  [in] BOOL  fEnabled
);

Parameters

[in] dwStreamIndex

Zero-based index of the stream. To get the number of streams, call IMFPMediaItem::GetNumberOfStreams.

[in] fEnabled

Specify whether to select or deselect the stream.

Value	Meaning
TRUE	The stream is selected. During playback, this stream will play.
FALSE	The stream is not selected. During playback, this stream will not play.

Return value

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

Remarks

You can use this method to change which streams are selected. The change goes into effect the next time that IMFPMediaPlayer::SetMediaItem is called with this media item. If the media item is already set on the player, the change does not happen unless you call SetMediaItem again with this media item.

Requirements

Requirement	Value
Minimum supported client	Windows 7 [desktop apps only]
Minimum supported server	Windows Server 2008 R2 [desktop apps only]
Target Platform	Windows
Header	mfplay.h

Share via