GuideReference
TrainingSupportCommunity

limit_​bit_​rate

  • Property Manager name: Bit Rate Limiting
  • Behavior version: The v2023-05-30 rule format supports the limit_​bit_​rate behavior v1.2.
  • Rule format status: GA, stable
  • Access: Read-write
  • Allowed in includes: Yes

Control the rate at which content serves out to end users, optionally varying the speed depending on the file size or elapsed download time. Each bit rate specified in the bitrate_​table array corresponds to a threshold_​table entry that activates it. You can use this behavior to prevent media downloads from progressing faster than they are viewed, for example, or to differentiate various tiers of end-user experience. To apply this behavior, you should match on a content​_type, path, or filename.

OptionTypeDescriptionRequires
enabledboolean

When enabled, activates the bit rate limiting behavior.

{"displayType":"boolean","tag":"input","type":"checkbox"}
bitrate_​tableobject array

Specifies a download rate that corresponds to a threshold_​table entry. The bit rate appears as a two-member object consisting of a numeric bitrate_​value and a bitrate_​unit string, with allowed values of Kbps, Mbps, and Gbps.

{"displayType":"object array","tag":"input","todo":true}
{"if":{"attribute":"enabled","op":"eq","value":true}}
bitrate_​table[].bitrate_​valuenumber

The numeric indicator of the download rate.

{"displayType":"number","tag":"input","type":"number"}
bitrate_​table[].bitrate_​unitenum

The unit of measurement, either KBPS, MBPS, or GBPS.

{"displayType":"enum","options":["KBPS","MBPS","GBPS"],"tag":"select"}
Supported values:
GBPS
KBPS
MBPS
threshold_​tableobject array

Specifies the minimum size of the file or the amount of elapsed download time before applying the bit rate limit from the corresponding bitrate_​table entry. The threshold appears as a two-member object consisting of a numeric threshold_​value and threshold_​unit string, with allowed values of SECONDS or BYTES.

{"displayType":"object array","tag":"input","todo":true}
{"if":{"attribute":"enabled","op":"eq","value":true}}
threshold_​table[].threshold_​valuenumber

The numeric indicator of the minimum file size or elapsed download time.

{"displayType":"number","tag":"input","type":"number"}
threshold_​table[].threshold_​unitenum

The unit of measurement, either SECONDS of the elapsed download time, or BYTES of the file size.

{"displayType":"enum","options":["BYTES","SECONDS"],"tag":"select"}
Supported values:
BYTES
SECONDS