limit_bit_rate
- Property Manager name: Bit Rate Limiting
- Behavior version: The
v2024-05-31
rule format supports thelimit_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
.
Option | Type | Description | Requires | |
---|---|---|---|---|
enabled | boolean | When enabled, activates the bit rate limiting behavior. | {"displayType":"boolean","tag":"input","type":"checkbox"} | |
bitrate_table | object array | Specifies a download rate that corresponds to a | {"displayType":"object array","tag":"input","todo":true} {"if":{"attribute":"enabled","op":"eq","value":true}} | |
bitrate_table[].bitrate_value | number | The numeric indicator of the download rate. | {"displayType":"number","tag":"input","type":"number"} | |
bitrate_table[].bitrate_unit | enum | The unit of measurement, either | {"displayType":"enum","options":["KBPS","MBPS","GBPS"],"tag":"select"} | |
Supported values: GBPS KBPS MBPS | ||||
threshold_table | object array | Specifies the minimum size of the file or the amount of elapsed download time before applying the bit rate limit from the corresponding | {"displayType":"object array","tag":"input","todo":true} {"if":{"attribute":"enabled","op":"eq","value":true}} | |
threshold_table[].threshold_value | number | The numeric indicator of the minimum file size or elapsed download time. | {"displayType":"number","tag":"input","type":"number"} | |
threshold_table[].threshold_unit | enum | The unit of measurement, either | {"displayType":"enum","options":["BYTES","SECONDS"],"tag":"select"} | |
Supported values: BYTES SECONDS |
Updated 6 days ago