limitBitRate


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