IWMBandwidthSharing::GetBandwidth method (wmsdkidl.h)

Article
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 GetBandwidth method retrieves the bandwidth and maximum buffer size of a combined stream.

Syntax

HRESULT GetBandwidth(
  [out] DWORD *pdwBitrate,
  [out] DWORD *pmsBufferWindow
);

Parameters

[out] pdwBitrate

Pointer to a DWORD containing the bit rate in bits per second. The combined bandwidths of the streams cannot exceed this value.

[out] pmsBufferWindow

Pointer to DWORD containing the buffer window in milliseconds. The combined buffer sizes of the streams cannot exceed this value.

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	One or both of the parameters are NULL.

Remarks

The settings of a bandwidth sharing object are purely informational. They are not checked for accuracy.

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)

Share via