Share via


IWMSyncReader::GetMaxStreamSampleSize 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 GetMaxStreamSampleSize method retrieves the maximum sample size for a specified stream in the file that is open in the synchronous reader.

Syntax

HRESULT GetMaxStreamSampleSize(
  [in]  WORD  wStream,
  [out] DWORD *pcbMax
);

Parameters

[in] wStream

WORD containing the stream number for which you want to retrieve the maximum sample size.

[out] pcbMax

Pointer to a DWORD value that receives the maximum sample size, in bytes, for the stream specified in wStream.

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

OR

wStream specifies an invalid stream number.

ASF_E_INVALIDSTATE
No file is open in the synchronous reader.

Remarks

This method retrieves the maximum sample size for an individual stream. The stream may be one of several in an output. If you are using output numbers, you should use IWMSyncReader::GetMaxOutputSampleSize to retrieve the maximum sample size for the entire output.

Requirements

Requirement Value
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