IWMReaderNetworkConfig::GetConnectionBandwidth 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 GetConnectionBandwidth method retrieves the connection bandwidth for the client.

Syntax

HRESULT GetConnectionBandwidth(
  [out] DWORD *pdwConnectionBandwidth
);

Parameters

[out] pdwConnectionBandwidth

Pointer to a DWORD containing the connection bandwidth, in bits per second.

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
NULL or invalid argument passed in.

Remarks

If this method returns zero, the bandwidth could not be detected. If the application has not called SetConnectionBandwidth (or called it with a zero parameter), the return value is the connection rate detected by the reader.

If you want to determine the connection bandwidth before receiving a sample, use this method.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only],Windows Media Format 7 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

IWMReaderNetworkConfig Interface

IWMReaderNetworkConfig::SetConnectionBandwidth