Creates a live stream recording template to submit live stream recording jobs.
Operation description
You must specify a recording template for live stream recording. You can configure information such as the format and duration of a recording in a recording template. The recording format can be M3U8, MP4, or FLV.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ice:CreateLiveRecordTemplate | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RecordFormat | array<object> | Yes | The list of recording formats. | |
| object | Yes | The recording format. | ||
| Format | string | Yes | The format. Note
If you set this parameter to m3u8, you must also specify the SliceOssObjectPrefix and SliceDuration parameters.
| m3u8 |
| SliceDuration | integer | No | The duration of a single segment. Unit: seconds. Note
This parameter takes effect only if you set Format to m3u8.
If you do not specify this parameter, the default value 30 seconds is used. Valid values: 5 to 30. | 30 |
| OssObjectPrefix | string | No | The name of the recording file that is stored in Object Storage Service (OSS).
| record/{JobId}/{Sequence}_{EscapedStartTime}_{EscapedEndTime} |
| SliceOssObjectPrefix | string | No | The name of the TS segment. Note
This parameter is required only if you set Format to m3u8.
| record/{JobId}/{UnixTimestamp}_{Sequence} |
| CycleDuration | integer | No | The duration of the recording cycle. Unit: seconds. If you do not specify this parameter, the default value 6 hours is used. Note
| 3600 |
| Name | string | Yes | The name of the template. |
Response parameters
Examples
Sample success responses
JSONformat
{
"TemplateId": "****96e8864746a0b6f3****",
"RequestId": "0622C702-41BE-467E-AF2E-883D4517962E"
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|