AddLiveRecordVodConfig - ApsaraVideo Live

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 You cannot configure the Live-to-VOD feature by using a Finance Cloud account.

QPS limit

You can call this operation up to 1,000 times per minute per 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 of 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 recording cycle. Unit: seconds. Valid values: 300 to 21600. Default value: 3600.
AutoCompose	String	No	ON	Specifies whether to enable automatic merging. If you set the value to ON, automatic merging is enabled and the ComposeVodTranscodeGroupId parameter is required. If you do not specify this parameter, automatic merging is disabled. 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 the feature, see Billing of value-added services.
StorageLocation	String	No	****-tjptr2vatm.oss-cn-shanghai.aliyuncs.com	The storage location.
ComposeVodTranscodeGroupId	String	No	*****	The ID of the transcoding template group in ApsaraVideo VOD that is used to transcode the video file. The video file is generated by merging the VOD files created from live streams. Note This parameter is required if you set the AutoCompose parameter 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 request ID.

Examples

Sample requests

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

Sample success responses

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

HTTP status code	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.