All Products
Search
Document Center

ApsaraVideo Live:InitializeAutoShowListTask

Last Updated:Nov 14, 2024

Creates a scheduled task to start and stop the playback of a playlist at the specified points in time.

Operation description

You can call this operation to create a scheduled task to start and stop the playback of a playlist at the specified points in time. Make sure that the parameter settings are valid for calling this operation.

QPS limit

You can call this operation up to 10 times per second 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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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 Resources is 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.
OperationAccess levelResource typeCondition keyAssociated operation
live:InitializeAutoShowListTaskget
*Caster
acs:live:*:{#accountId}:caster/{#CasterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceIdsstringNo

The IDs of on-demand media asset files in the playlist. Only on-demand video files are supported. You can specify up to three video files in the playlist. The video files in the playlist are automatically played in sequence. The playback stops at the point in time specified by the EndTime parameter.

Note
  • You can obtain the ID of a video file in the ApsaraVideo Live console or by calling an API operation. For more information, see Media asset management or CreateUploadVideo . - If the video files are all played before the time specified by EndTime, the final frame of the final video file is played until the time specified by EndTime arrives.
["89e02xxxxfb349axxxxa0c350d**** ","6ae0xxxxxb349axxxxa0c350a****"]
StartTimelongYes

The start timestamp. Unit: milliseconds.

1645688994000
EndTimelongYes

The end timestamp. Unit: milliseconds.

1645688994000
CasterConfigstringYes

The configurations of the production studio. The following configurations are involved:

  • CasterTemplate: required. The output resolution.
  • LiveTemplate: optional. The templates to be used for transcoding.
Note Set the value to a JSON string. Use upper camel case for fields of the string.
{"CasterTemplate": "lp_ld","LiveTemplates":["lhd", "lsd","lud"]}
DomainNamestringYes

The output streaming domain.

example.aliyundoc.com
CallBackUrlstringNo

The callback URL.

http://***.com/callback

Response parameters

ParameterTypeDescriptionExample
object
CasterIdstring

The ID of the production studio.

Note The value of this parameter can be used as the value of a request parameter to query the streaming URL of the production studio, start the production studio, add video resources to the production studio, add a production studio layout, query production studio layouts, add a production studio component, and add a production studio playlist.
b4810848-bcf9-4aef-bd4a-e6bba2d9****
RequestIdstring

The request ID.

16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
StreamListstring

The list of output video streams.

  • videoFormat: the format of the streaming URL.
  • outputStreamUrl: the source URL.
  • transcodeConfig: the output resolution specified for video transcoding of the source URL.
[{"videoFormat":"flv","outputStreamUrl":"http://example.aliyundoc.com","transcodeConfig":"original"}]

Examples

Sample success responses

JSONformat

{
  "CasterId": "b4810848-bcf9-4aef-bd4a-e6bba2d9****",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  "StreamList": "[{\"videoFormat\":\"flv\",\"outputStreamUrl\":\"http://example.aliyundoc.com\",\"transcodeConfig\":\"original\"}]"
}

Error codes

HTTP status codeError codeError message
400InvalidParameter.PurchaseTime%s
400InvalidParameter.ExpireTime%s
400MissingParameter%s
400InvalidChargeType.Malformed%s
400InvalidChargeType.PostSupport%s
400InvalidCasterTemplate.Malformed%s
400InvalidParameter.Malformed%s
400InvalidParameter.ChargeType%s
400InvalidPeriod.Malformed%s
400InvalidClientToken.Malformed%s
400IncorrectCasterStatus%s
400InvalidCasterId.Malformed%s
400InvalidUserId.Malformed%s
400IncorrectCasterStatus.EnableChannel%s
400InvalidParameter.StartTime%s
401CasterNumberExceed%s
401IllegalOperation%s
404InvalidParameter.NormType%s
404InvalidConfiguration.NotFound%s
404InvalidCaster.NotFound%s
404InvalidDomainName.NotFound%s
408CreateCaster.Timeout%s
500InternalError%s

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history