IWMReaderAdvanced::SetReceiveStreamSamples method (wmsdkidl.h)

[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 SetReceiveStreamSamples method specifies whether stream samples are delivered to the IWMReaderCallbackAdvanced::OnStreamSample callback.

Syntax

HRESULT SetReceiveStreamSamples(
  [in] WORD wStreamNum,
  [in] BOOL fReceiveStreamSamples
);

Parameters

[in] wStreamNum

WORD containing the stream number. Stream numbers are in the range of 1 through 63.

[in] fReceiveStreamSamples

Boolean value that is True if stream samples are delivered.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Remarks

Stream samples are samples received directly from the source file, and are not decompressed. If you receive compressed samples, you must either keep them compressed, or decompress them with your application. The Windows Media Format SDK does not provide methods to decompress samples once they have been removed from a file.

The application can register itself to receive samples directly from the Windows Media streams rather than letting the reader decompress them first. To do this, the object implementing IWMReaderCallback (supplied by the application) must support IWMReaderCallbackAdvanced. To determine which streams are in an ASF file, and what their stream numbers are, call QueryInterface using the reader object to access the IWMProfile interface, and examine the streams in the profile.

Requirements

See also

IWMReaderAdvanced Interface

IWMReaderAdvanced::GetReceiveStreamSamples