The ALIYUN::ESA::VideoProcessing resource creates a video processing configuration for a site.
Syntax
{
"Type": "ALIYUN::ESA::VideoProcessing",
"Properties": {
"SiteId": Integer,
"FlvVideoSeekMode": String,
"FlvSeekStart": String,
"FlvSeekEnd": String,
"Mp4SeekEnd": String,
"Mp4SeekStart": String,
"RuleEnable": String,
"Rule": String,
"RuleName": String,
"Sequence": Integer,
"SiteVersion": Integer,
"VideoSeekEnable": String
}
}Properties
Parameter | Type | Required | Editable | Description | Constraint |
SiteId | Integer | Yes | No | The ID of the site. | None |
FlvSeekEnd | String | No | Yes | The custom end parameter for seeking in FLV videos. | None |
FlvSeekStart | String | No | Yes | The custom start parameter for seeking in FLV videos. | None |
FlvVideoSeekMode | String | No | Yes | The seek mode for FLV videos. | Valid values:
|
Mp4SeekEnd | String | No | Yes | The custom end parameter for seeking in MP4 videos. | None |
Mp4SeekStart | String | No | Yes | The custom start parameter for seeking in MP4 videos. | None |
Rule | String | No | Yes | The content of the rule. | A conditional expression used to match user requests. This property is not required when you add a global configuration. The following scenarios are supported:
|
RuleEnable | String | No | Yes | The rule switch. | This property is not required when you add a global configuration. Valid values:
|
RuleName | String | No | Yes | The rule name. | This property is not required when you add a global configuration. |
Sequence | Integer | No | Yes | The rule execution order. | A smaller value indicates a higher priority. This property applies only when you set or modify the execution order of a single rule. |
SiteVersion | Integer | No | No | The version number of the site configuration. | For sites with configuration version management enabled, you can use this property to specify the active configuration version. The default value is |
VideoSeekEnable | String | No | Yes | Specifies whether to enable the seek function. | Valid values:
|
Return values
Fn::GetAtt
VideoSeekEnable: Indicates whether the seek function is enabled.
RuleEnable: Indicates whether the rule is enabled. This attribute is not returned for a global configuration.
FlvVideoSeekMode: The seek mode for FLV videos.
Sequence: The execution order of the rule. A smaller value indicates a higher priority.
FlvSeekEnd: The custom end parameter for seeking in FLV videos.
Mp4SeekEnd: The custom end parameter for seeking in MP4 videos.
FlvSeekStart: The custom start parameter for FLV.
Rule: The conditional expression that defines the rule. This attribute is not returned for a global configuration.
ConfigId: The config ID.
Mp4SeekStart: The custom start parameter for seeking in MP4 videos.
SiteVersion: The version number of the site configuration.
ConfigType: The configuration type.
RuleName: The rule name. This attribute is not returned for a global configuration.
Examples
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
VideoSeekEnable:
Type: String
Description:
en: |-
Specifies whether to enable the seek function. Valid values:
- `on`: Enables the seek function.
- `off`: Disables the seek function.
AllowedValues:
- 'on'
- 'off'
Required: false
SiteId:
Type: Number
Description:
en: The ID of the site. You can call the ListSites operation to obtain the site ID.
Required: true
RuleEnable:
Type: String
Description:
en: |-
The rule switch. This parameter is not required when you add a global configuration. Valid values:
- `on`: Enables the rule.
- `off`: Disables the rule.
AllowedValues:
- 'on'
- 'off'
Required: false
FlvVideoSeekMode:
Type: String
Description:
en: |-
The seek mode for FLV videos. Valid values:
- `by_byte`: Seeks by byte.
- `by_time`: Seeks by time.
AllowedValues:
- by_byte
- by_time
Required: false
Mp4SeekEnd:
Type: String
Description:
en: The custom end parameter for seeking in MP4 videos.
Required: false
FlvSeekStart:
Type: String
Description:
en: The custom start parameter for seeking in FLV videos.
Required: false
Sequence:
Type: Number
Description:
en: The rule execution order. A smaller value indicates a higher priority. This parameter is applicable only when you set or modify the execution order of a single rule.
Required: false
Rule:
Type: String
Description:
en: |-
The conditional expression used to match user requests. This parameter is not required for a global configuration. The following scenarios are supported:
- To match all requests, set the value to 'true'.
- To match specific requests, use a custom expression. Example: '(http.host eq "video.example.com")'.
Required: false
Mp4SeekStart:
Type: String
Description:
en: The custom start parameter for seeking in MP4 videos.
Required: false
SiteVersion:
Type: Number
Description:
en: The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to specify the active configuration version. The default value is '0'.
Required: false
FlvSeekEnd:
Type: String
Description:
en: The custom end parameter for seeking in FLV videos.
Required: false
RuleName:
Type: String
Description:
en: The name of the rule. This parameter is not required when you add a global configuration.
Required: false
Resources:
ExtensionResource:
Type: ALIYUN::ESA::VideoProcessing
Properties:
VideoSeekEnable:
Ref: VideoSeekEnable
SiteId:
Ref: SiteId
RuleEnable:
Ref: RuleEnable
FlvVideoSeekMode:
Ref: FlvVideoSeekMode
Mp4SeekEnd:
Ref: Mp4SeekEnd
FlvSeekStart:
Ref: FlvSeekStart
Sequence:
Ref: Sequence
Rule:
Ref: Rule
Mp4SeekStart:
Ref: Mp4SeekStart
SiteVersion:
Ref: SiteVersion
FlvSeekEnd:
Ref: FlvSeekEnd
RuleName:
Ref: RuleName
Outputs:
VideoSeekEnable:
Description: Indicates whether the seek function is enabled.
Value:
Fn::GetAtt:
- ExtensionResource
- VideoSeekEnable
RuleEnable:
Description: Indicates whether the rule is enabled.
Value:
Fn::GetAtt:
- ExtensionResource
- RuleEnable
FlvVideoSeekMode:
Description: The seek mode for FLV videos.
Value:
Fn::GetAtt:
- ExtensionResource
- FlvVideoSeekMode
Sequence:
Description: The rule execution order. A smaller value indicates a higher priority.
Value:
Fn::GetAtt:
- ExtensionResource
- Sequence
FlvSeekEnd:
Description: The custom end parameter for seeking in FLV videos.
Value:
Fn::GetAtt:
- ExtensionResource
- FlvSeekEnd
Mp4SeekEnd:
Description: The custom end parameter for seeking in MP4 videos.
Value:
Fn::GetAtt:
- ExtensionResource
- Mp4SeekEnd
FlvSeekStart:
Description: The custom start parameter for seeking in FLV videos.
Value:
Fn::GetAtt:
- ExtensionResource
- FlvSeekStart
Rule:
Description: The conditional expression that defines the rule.
Value:
Fn::GetAtt:
- ExtensionResource
- Rule
ConfigId:
Description: The config ID.
Value:
Fn::GetAtt:
- ExtensionResource
- ConfigId
Mp4SeekStart:
Description: The custom start parameter for seeking in MP4 videos.
Value:
Fn::GetAtt:
- ExtensionResource
- Mp4SeekStart
SiteVersion:
Description: The version number of the site configuration.
Value:
Fn::GetAtt:
- ExtensionResource
- SiteVersion
ConfigType:
Description: The configuration type.
Value:
Fn::GetAtt:
- ExtensionResource
- ConfigType
RuleName:
Description: The rule name. This attribute is not returned for a global configuration.
Value:
Fn::GetAtt:
- ExtensionResource
- RuleName
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"VideoSeekEnable": {
"Type": "String",
"Description": {
"en": "Specifies whether to enable the seek function. Valid values:\n- `on`: Enables the seek function.\n- `off`: Disables the seek function."
},
"AllowedValues": [
"on",
"off"
],
"Required": false
},
"SiteId": {
"Type": "Number",
"Description": {
"en": "The ID of the site. You can call the ListSites operation to obtain the site ID."
},
"Required": true
},
"RuleEnable": {
"Type": "String",
"Description": {
"en": "The rule switch. This parameter is not required when you add a global configuration. Valid values:\n- `on`: Enables the rule.\n- `off`: Disables the rule."
},
"AllowedValues": [
"on",
"off"
],
"Required": false
},
"FlvVideoSeekMode": {
"Type": "String",
"Description": {
"en": "The seek mode for FLV videos. Valid values:\n- `by_byte`: Seeks by byte.\n- `by_time`: Seeks by time."
},
"AllowedValues": [
"by_byte",
"by_time"
],
"Required": false
},
"Mp4SeekEnd": {
"Type": "String",
"Description": {
"en": "The custom end parameter for seeking in MP4 videos."
},
"Required": false
},
"FlvSeekStart": {
"Type": "String",
"Description": {
"en": "The custom start parameter for seeking in FLV videos."
},
"Required": false
},
"Sequence": {
"Type": "Number",
"Description": {
"en": "The rule execution order. A smaller value indicates a higher priority. This parameter is applicable only when you set or modify the execution order of a single rule."
},
"Required": false
},
"Rule": {
"Type": "String",
"Description": {
"en": "The conditional expression used to match user requests. This parameter is not required for a global configuration. The following scenarios are supported:\n- To match all requests, set the value to 'true'.\n- To match specific requests, use a custom expression. Example: '(http.host eq \\\"video.example.com\\\")'."
},
"Required": false
},
"Mp4SeekStart": {
"Type": "String",
"Description": {
"en": "The custom start parameter for seeking in MP4 videos."
},
"Required": false
},
"SiteVersion": {
"Type": "Number",
"Description": {
"en": "The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to specify the active configuration version. The default value is '0'."
},
"Required": false
},
"FlvSeekEnd": {
"Type": "String",
"Description": {
"en": "The custom end parameter for seeking in FLV videos."
},
"Required": false
},
"RuleName": {
"Type": "String",
"Description": {
"en": "The name of the rule. This parameter is not required when you add a global configuration."
},
"Required": false
}
},
"Resources": {
"ExtensionResource": {
"Type": "ALIYUN::ESA::VideoProcessing",
"Properties": {
"VideoSeekEnable": {
"Ref": "VideoSeekEnable"
},
"SiteId": {
"Ref": "SiteId"
},
"RuleEnable": {
"Ref": "RuleEnable"
},
"FlvVideoSeekMode": {
"Ref": "FlvVideoSeekMode"
},
"Mp4SeekEnd": {
"Ref": "Mp4SeekEnd"
},
"FlvSeekStart": {
"Ref": "FlvSeekStart"
},
"Sequence": {
"Ref": "Sequence"
},
"Rule": {
"Ref": "Rule"
},
"Mp4SeekStart": {
"Ref": "Mp4SeekStart"
},
"SiteVersion": {
"Ref": "SiteVersion"
},
"FlvSeekEnd": {
"Ref": "FlvSeekEnd"
},
"RuleName": {
"Ref": "RuleName"
}
}
}
},
"Outputs": {
"VideoSeekEnable": {
"Description": "Indicates whether the seek function is enabled.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"VideoSeekEnable"
]
}
},
"RuleEnable": {
"Description": "Indicates whether the rule is enabled.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"RuleEnable"
]
}
},
"FlvVideoSeekMode": {
"Description": "The seek mode for FLV videos.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"FlvVideoSeekMode"
]
}
},
"Sequence": {
"Description": "The rule execution order. A smaller value indicates a higher priority.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"Sequence"
]
}
},
"FlvSeekEnd": {
"Description": "The custom end parameter for seeking in FLV videos.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"FlvSeekEnd"
]
}
},
"Mp4SeekEnd": {
"Description": "The custom end parameter for seeking in MP4 videos.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"Mp4SeekEnd"
]
}
},
"FlvSeekStart": {
"Description": "The custom start parameter for seeking in FLV videos.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"FlvSeekStart"
]
}
},
"Rule": {
"Description": "The conditional expression that defines the rule.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"Rule"
]
}
},
"ConfigId": {
"Description": "The config ID.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"ConfigId"
]
}
},
"Mp4SeekStart": {
"Description": "The custom start parameter for seeking in MP4 videos.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"Mp4SeekStart"
]
}
},
"SiteVersion": {
"Description": "The version number of the site configuration.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"SiteVersion"
]
}
},
"ConfigType": {
"Description": "The configuration type.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"ConfigType"
]
}
},
"RuleName": {
"Description": "The rule name. This attribute is not returned for a global configuration.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"RuleName"
]
}
}
}
}