IWMSyncReader::SetStreamsSelected method (wmsdkidl.h)

Artikel
4/26/2023

[The feature associated with this page, Windows Media Format 11 SDK, is a legacy feature. It has been superseded by Source Reader and Sink Writer. Source Reader and Sink Writer have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use Source Reader and Sink Writer instead of Windows Media Format 11 SDK, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The SetStreamsSelected method configures the samples to be delivered from a list of streams. Each stream can be set to deliver all samples, no samples, or only cleanpoint samples.

Syntax

HRESULT SetStreamsSelected(
  [in] WORD                 cStreamCount,
  [in] WORD                 *pwStreamNumbers,
  [in] WMT_STREAM_SELECTION *pSelections
);

Parameters

[in] cStreamCount

Count of streams listed at pwStreamNumbers.

[in] pwStreamNumbers

Pointer to an array of WORD values containing the stream numbers.

[in] pSelections

Pointer to an array of WMT_STREAM_SELECTION enumeration values. These values correspond with the stream numbers listed at pwStreamNumbers. Each value specifies the samples to deliver for the appropriate stream.

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.
E_INVALIDARG	pwStreamNumbers or pSelections is NULL. OR cStreamCount is zero.
NS_E_INVALID_REQUEST	No file is loaded in the synchronous reader.
E_OUTOFMEMORY	The method is unable to allocate memory for an internal object.

Remarks

You can call SetStreamsSelects at any time after a file has been loaded into the synchronous reader. You can continue making calls as needed during playback.

This method is identical to IWMReaderAdvanced::SetStreamsSelected except that, in the synchronous reader, stream selection is always manual. Also, because IWMSyncReader::GetNextSample includes a stream number output, you can select as many mutually exclusive streams as you like and receive samples for them.

Requirements


Minimum supported client	Windows 2000 Professional [desktop apps only],Windows Media Format 9 Series SDK, or later versions of the SDK
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	wmsdkidl.h (include Wmsdk.h)
Library	Wmvcore.lib; WMStubDRM.lib (if you use DRM)