All Products
Search
Document Center

ApsaraVideo Live:AddLiveRecordVodConfig

Last Updated:Feb 21, 2024

Configures the Live-to-VOD feature.

Usage notes

You can call this operation to configure the Live-to-VOD feature to store recordings in the media library of ApsaraVideo VOD.

Note If you use an Alibaba Finance Cloud account, you cannot configure the Live-to-VOD feature.

QPS limit

This operation can be called up to 1,000 times per minute for each Alibaba Cloud account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter

Type

Required

Example

Description

Action String Yes AddLiveRecordVodConfig

The operation that you want to perform. Set the value to AddLiveRecordVodConfig.

DomainName String Yes example.com

The main streaming domain.

Note Make sure that ApsaraVideo VOD is activated in the same region as the live center that is associated to the streaming domain.
AppName String Yes testName

The name of the application to which the live stream belongs.

StreamName String No stream

The name of the live stream.

VodTranscodeGroupId String Yes e2d796d3bb5fd8049d32bff62f94****

The ID of the transcoding template group in ApsaraVideo VOD.

CycleDuration Integer No 300

The duration of each recording cycle. Unit: seconds. Valid values: 300 to 21600. Default value: 3600.

AutoCompose String No OFF

Specifies whether to enable automatic merging. Valid values:

  • ON: enables automatic merging. If you set this parameter to ON, you must specify ComposeVodTranscodeGroupId.
  • OFF: disables automatic merging.
Note If you enable automatic merging, the VOD files that are created from live streams are automatically merged by using the editing and production feature of ApsaraVideo VOD. For information about the billing of this feature, see Billing of value-added services.
StorageLocation String No ****-tjptr2vatm.oss-cn-shanghai.aliyuncs.com

The Object Storage Service (OSS) path in which the recordings are stored.

ComposeVodTranscodeGroupId String No *****

The ID of the transcoding template group in ApsaraVideo VOD. The template group is used to transcode the video file that is automatically generated by merging the VOD files created from live streams.

Note
  • This parameter is required if you set AutoCompose to ON.
  • For more information about automatic merging and transcoding, see FAQ about Live-to-VOD.
  • For information about the billing of transcoding in ApsaraVideo VOD, see Billing of basic services.
OnDemand Integer No 0

Specifies whether to enable on-demand recording. Valid values:

  • 0 (default): disables on-demand recording.
  • 1: enables on-demand recording by using the HTTP callback method.

Response parameters

Parameter

Type

Example

Description

RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

The ID of the request.

Examples

Sample request

http(s)://live.aliyuncs.com/?Action=AddLiveRecordVodConfig
&AppName=AppName
&DomainName=example.com
&VodTranscodeGroupId=e2d796d3bb5fd8049d32bff62f94****
&<Common request parameters>

Sample success response

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<AddLiveRecordVodConfigResponse>
	<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
</AddLiveRecordVodConfigResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

Error codes

HttpCode

Error code

Error message

Description

400 ConfigAlreadyExists Config has already exist. The configuration already exists.

For a list of error codes, see Service error codes.