Device Cap Rule

Summary

Device Cap Rule maintains a mapping between device-capabilities indicated in the Device Cap filter, and a list of filters to apply to the requested manifest.
A Device Cap Rule is applied only if the Rule Set, Origin, and Device Capabilities indicated by the dc() filter in the URI match the rule-set-id, origin-id, dev-cap, dev-value-val, and dev-value-op properties of that Device Cap Rule.

Definition

Name	Schema	Values	Comments
id	integer	unique auto-generated record-ID
rule_set_alias	string	any existing rule-set alias	What Rule Set this DeviceCap rule belongs to. May be blank for Always Run this.
origin_name	string	any existing origin-name	Origin that this DeviceCap rule belongs to. May be blank for All Origins.
dev_cap	string	video, audio, hdmi, or hdcp	What capability-type to trigger on, i.e. VideoSupport
dev_value_val	int	valid device-cap int or bitmap	Within that DevCap, which field (bit or int value) are we considering, i.e. HDR or HLG.
dev_value_op	string	==, !=, or notset	Perform the action if it is On/Equal, if it is Off/Not Equal, or if it hasn’t been set?
filters	string	any valid filters	URI path-separator delimited list of filters, as could be passed in as the URI, i.e. v-f(dvh,hdr)/l(EN,ES)
description	string		Human-readable description

REST Operations

GET device-cap-rule/<resourceId>

Return device-cap-rule resource identified by resourceId

GET device-cap-rule?<query-parameters>

Return device-cap-rule resources identified by query paramters:

Query Parameters:

parameter	type	default	comments
page	integer	0	zero indexed page of results to return (optional)
page_size	integer		items-per-page to return (required)

PUT device-cap-rule/<resourceId>

Update device-cap-rule resource identified by resourceId

JSON body parameters:

Name	Schema	Values	Comments
rule_set_alias	string	any existing rule-set alias	What Rule Set this DeviceCap rule belongs to. May be blank for Always Run this.
origin_name	string	any existing origin-name	Origin that this DeviceCap rule belongs to. May be blank for All Origins.
dev_cap	string	video, audio, hdmi, or hdcp	What capability-type to trigger on, i.e. VideoSupport
dev_value_val	int	valid device-cap int or bitmap	Within that DevCap, which field (bit or int value) are we considering, i.e. HDR or HLG.
dev_value_op	string	==, !=, or notset	Perform the action if it is On/Equal, if it is Off/Not Equal, or if it hasn’t been set?
filters	string	any valid filters	URI path-separator delimited list of filters, as could be passed in as the URI, i.e. v-f(dvh,hdr)/l(EN,ES)
description	string		Human-readable description

POST device-cap-rule

Create new device-cap-rule resource

JSON body parameters:

Name	Schema	Values	Comments
rule_set_alias	string	any existing rule-set alias	What Rule Set this DeviceCap rule belongs to. May be blank for Always Run this.
origin_name	string	any existing origin-name	Origin that this DeviceCap rule belongs to. May be blank for All Origins.
dev_cap	string	video, audio, hdmi, or hdcp	What capability-type to trigger on, i.e. VideoSupport
dev_value_val	int	valid device-cap int or bitmap	Within that DevCap, which field (bit or int value) are we considering, i.e. HDR or HLG.
dev_value_op	string	==, !=, or notset	Perform the action if it is On/Equal, if it is Off/Not Equal, or if it hasn’t been set?
filters	string	any valid filters	URI path-separator delimited list of filters, as could be passed in as the URI, i.e. v-f(dvh,hdr)/l(EN,ES)
description	string		Human-readable description

DELETE device-cap-rule/<resourceId>

Delete device-cap-rule resource identified by resourceId