CreateLiveRecordTemplate - - Alibaba Cloud Documentation Center

Operation description

Live recording requires a Live Record Template. You can use a template to configure settings such as the recording format (for example, M3U8, MP4, or FLV) and the duration of Recording Files.

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	A recording format object.
Format	string	Yes	The recording 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 each slice in seconds. Note This parameter is valid only when `Format` is set to `m3u8`. The default value is 30. The value must be an integer from 5 to 30.	30
OssObjectPrefix	string	No	The name of the Recording File stored in Object Storage Service (OSS). The file name must be less than 256 bytes and supports the following variables: {JobId}, {Sequence}, {StartTime}, {EndTime}, {EscapedStartTime}, and {EscapedEndTime}. The value must include either the {StartTime} or {EscapedStartTime} variable and either the {EndTime} or {EscapedEndTime} variable.	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 file name must be less than 256 bytes and supports the following variables: {JobId}, {UnixTimestamp}, and {Sequence}. The value must include the {UnixTimestamp} and {Sequence} variables.	record/{JobId}/{UnixTimestamp}_{Sequence}
CycleDuration	integer	No	The duration of a recording cycle in seconds. If you omit this parameter, it defaults to 6 hours. Note If a stream interruption during a recording cycle lasts less than 3 minutes, the recording continues in the same Recording File. A Recording File is finalized only after a stream interruption lasts for more than 3 minutes. To change this default 3-minute threshold, submit a ticket.	3600
Name	string	Yes	The name of the Live Record Template.

Response elements

Element	Type	Description	Example
	object	The response object.
TemplateId	string	The ID of the Live Record Template.	**96e8864746a0b6f3**
RequestId	string	The ID of the request.	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.