IActiveBasicDevice::GetEffectiveBandwidth method (windows.media.streaming.h)

[The feature associated with this page, Windows Media Streaming API, is a legacy feature. It has been superseded by Media Casting. Media Casting has been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use Media Casting instead of Windows Media Streaming API, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

Gets the current effective bandwidth for the device.

Syntax

HRESULT GetEffectiveBandwidth(
  [in, retval] ::boolean transmitSpeed,
  [out]        UINT64    *currentSpeed
);

Parameters

[in, retval] transmitSpeed

Specifies whether the transmit speed is retrieved or the receive speed is retrieved.

true to retrieve the transmit speed. false to retrieve the receive speed.

[out] currentSpeed

Receives the current effective bandwidth.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

See also

IActiveBasicDevice

IBasicDevice