Legacy Documentation: Version 5.6 (Go to current version)
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.


Suggest a change


Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.


Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.



public var BandwidthPeakFactor: float;
public float BandwidthPeakFactor;


Defines, when multiplied internally by InitialBandwidth, the maximum bandwidth that can be used under burst conditions.

If you do not send any data for some time, the bandwidth available to your app is the full bandwidth specified in InitialBandwidth. However, it is possible to occupy more than this bandwidth for a short period of time, known as a burst. This property limits the bandwidth that can be used during such a burst. This parameter can be considered to be a smoothing factor for oscillating traffic; if traffic is irregular and the peak bandwidth is high, the network may see spikes of bandwidth use leading to packets being discarded by traffic shaping or management functions elsewhere in the network. For more information, see the token bucket algorithm, in particular a discussion of burst size.