CreateLiveRecordTemplate-阿里云帮助中心

Operation description

Real-time recording requires a recording template. A recording template specifies the output format of recording files (m3u8, mp4, or flv), the recording file duration, and other information.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ice:CreateLiveRecordTemplate

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RecordFormat	array<object>	Yes	The list of recording formats.
	object	No	The recording format.
Format	string	Yes	The format. Note If you select the m3u8 format, you must also set the request parameters SliceOssObjectPrefix and SliceDuration.	m3u8
SliceDuration	integer	No	The duration of a single slice. Unit: seconds. Note This parameter takes effect only when Format is set to m3u8. If this parameter is not specified, the default value is 30 seconds. Valid values: 5 to 30.	30
OssObjectPrefix	string	No	The name of the recording file stored in OSS. The file name must be less than 256 bytes and supports variable matching, including {JobId}, {Sequence}, {StartTime}, {EndTime}, {EscapedStartTime}, and {EscapedEndTime}. The parameter value must contain {StartTime} or {EscapedStartTime} and {EndTime} or {EscapedEndTime}.	record/{JobId}/{Sequence}_{EscapedStartTime}_{EscapedEndTime}
SliceOssObjectPrefix	string	No	The name of the TS slice. Note This parameter is required only when Format is set to m3u8. The default slice duration is 30 seconds. The name must be less than 256 bytes and supports variable matching, including {JobId}, {UnixTimestamp}, and {Sequence}. The parameter value must contain the {UnixTimestamp} and {Sequence} variables.	record/{JobId}/{UnixTimestamp}_{Sequence}
CycleDuration	integer	No	The cycle recording duration. Unit: seconds. If this parameter is not specified, the default value is 6 hours. Note If a live stream is interrupted during a recording cycle but resumes within 3 minutes, the recording continues in the same recording file. A live stream must be interrupted for more than 3 minutes before the last recording file is generated. If you need to modify the default 3-minute interruption time, submit a ticket.	3600
Name	string	Yes	The template name.

Response elements

Element	Type	Description	Example
	object	Schema of Response
TemplateId	string	The template ID.	**96e8864746a0b6f3**
RequestId	string	The request ID.	0622C702-41BE-467E-AF2E-883D4517962E

Examples

Success response

JSON format

{
  "TemplateId": "****96e8864746a0b6f3****",
  "RequestId": "0622C702-41BE-467E-AF2E-883D4517962E"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.