IWMSyncReader::GetReadStreamSamples method (wmsdkidl.h)

  • Article

[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 GetReadStreamSamples method ascertains whether a stream is configured to deliver compressed samples.

Syntax

HRESULT GetReadStreamSamples(
  [in]  WORD wStreamNum,
  [out] BOOL *pfCompressed
);

Parameters

[in] wStreamNum

WORD containing the stream number.

[out] pfCompressed

Pointer to a flag that receives the status of compressed delivery for the stream specified.

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
 pfCompressed is NULL.

OR

wStreamNum specifies an invalid stream number.
E_UNEXPECTED
 No file is open in the synchronous reader.

Remarks

To configure a stream to deliver compressed samples, call IWMSyncReader::SetReadStreamSamples.

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)

See also

IWMSyncReader Interface