Scenario Definition¶
Title: Scenario Definition
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
Description: Voluptuous validation schema for Scenario Definition
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - alias | No | string | No | - | - |
| - condition | No | string | No | - | - |
| - media | No | object | No | - | - |
| - action_groups | No | array of string | No | - | - |
| - delivery_selection | No | enum (of string) | No | - | - |
| - delivery | No | object | No | - | - |
1. Property Scenario Definition > alias¶
| Type | string |
| Required | No |
2. Property Scenario Definition > condition¶
| Type | string |
| Required | No |
3. Property Scenario Definition > media¶
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - camera_entity_id | No | string | No | - | - |
| - camera_delay | No | integer | No | - | - |
| - camera_ptz_preset | No | Combination | No | - | - |
| - clip_url | No | string | No | - | - |
| - snapshot_url | No | string | No | - | - |
| - jpeg_opts | No | object | No | - | - |
3.1. Property Scenario Definition > media > camera_entity_id¶
| Type | string |
| Required | No |
3.2. Property Scenario Definition > media > camera_delay¶
| Type | integer |
| Required | No |
| Default | 0 |
3.3. Property Scenario Definition > media > camera_ptz_preset¶
| Type | combining |
| Required | No |
| Additional properties | Any type allowed |
| Any of(Option) |
|---|
| item 0 |
| item 1 |
3.3.1. Property Scenario Definition > media > camera_ptz_preset > anyOf > item 0¶
| Type | integer |
| Required | No |
| Restrictions | |
|---|---|
| Minimum | ≥ 0 |
3.3.2. Property Scenario Definition > media > camera_ptz_preset > anyOf > item 1¶
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
3.4. Property Scenario Definition > media > clip_url¶
| Type | string |
| Required | No |
3.5. Property Scenario Definition > media > snapshot_url¶
| Type | string |
| Required | No |
3.6. Property Scenario Definition > media > jpeg_opts¶
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | object | No | - | - |
4. Property Scenario Definition > action_groups¶
| Type | array of string |
| Required | No |
| Default | [] |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| action_groups items | - |
4.1. Scenario Definition > action_groups > action_groups items¶
| Type | string |
| Required | No |
5. Property Scenario Definition > delivery_selection¶
| Type | enum (of string) |
| Required | No |
Must be one of: * “explicit” * “fixed” * “implicit”
6. Property Scenario Definition > delivery¶
| Type | object |
| Required | No |
| Additional properties | Each additional property must conform to the schema |
| Default | {} |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | object | No | - | - |
6.1. Property Scenario Definition > delivery > additionalProperties¶
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - target | No | array of string | No | - | - |
| - enabled | No | string | No | - | - |
| - data | No | object | No | - | - |
6.1.1. Property Scenario Definition > delivery > additionalProperties > target¶
| Type | array of string |
| Required | No |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| target items | - |
6.1.1.1. Scenario Definition > delivery > additionalProperties > target > target items¶
| Type | string |
| Required | No |
6.1.2. Property Scenario Definition > delivery > additionalProperties > enabled¶
| Type | string |
| Required | No |
| Default | true |
6.1.3. Property Scenario Definition > delivery > additionalProperties > data¶
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | object | No | - | - |
Generated using json-schema-for-humans on 2025-10-26 at 08:54:32 +0000