IWRdsGraphicsChannelEvents::OnMetricsUpdate method (wrdsgraphicschannels.h)

Called to notify the RemoteFX graphics services that network conditions have changed.

Syntax

HRESULT OnMetricsUpdate(
  [in] DWORD  bandwidth,
  [in] DWORD  RTT,
  [in] UINT64 lastSentByteIndex
);

Parameters

[in] bandwidth

The expected bandwidth, in bytes per second. If this parameter contains WRdsGraphicsChannels_Bandwidth_Unavailable, bandwidth statistics are not available.

[in] RTT

The round trip time (RTT) of the link, in milliseconds. If this parameter contains WRdsGraphicsChannels_RTT_Unavailable, latency statistics are not available.

[in] lastSentByteIndex

The byte index of the last byte that was sent from this channel at this time. This value begins at zero and increases for the lifetime of the connection. This value will roll back to zero when an overflow occurs.

Return value

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

Requirements

Requirement Value
Minimum supported client Windows 8
Minimum supported server Windows Server 2012
Target Platform Windows
Header wrdsgraphicschannels.h

See also

IWRdsGraphicsChannelEvents