IWMReaderNetworkConfig::SetConnectionBandwidth 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 SetConnectionBandwidth method specifies the connection bandwidth for the client.
Syntax
HRESULT SetConnectionBandwidth(
[in] DWORD dwConnectionBandwidth
);
Parameters
[in] dwConnectionBandwidth
Specifies the maximum bandwidth for the connection, in bits per second. Specify zero for the reader to automatically detect the bandwidth
Return value
The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.
| Return code | Description |
|---|---|
|
The method succeeded. |
|
NULL or invalid argument passed in. |
Remarks
By default, the SDK automatically detects the bandwidth of the connection to the server. When auto-detection is set, a call to GetConnectionBandwidth following the Open request returns the dynamically detected connection bandwidth.
Setting a bandwidth by using this method is sometimes called bandwidth-throttling because it deliberately limits the available bandwidth.
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) |