All Products
Search
Document Center

ApsaraVideo Live:StartCasterScene

Last Updated:Dec 05, 2024

Starts a specified preview (PVW) scene.

Operation description

You can call this operation to start a specified PVW scene.

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.

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:StartCasterSceneupdate
*Caster
acs:live:*:{#accountId}:caster/{#CasterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
CasterIdstringYes

The ID of the production studio.

  • If the production studio was created by calling the CreateCaster operation, check the value of the response parameter CasterId to obtain the ID.
  • If the production studio was created by using the ApsaraVideo Live console, obtain the ID on the Production Studio Management page. To go to the page, log on to the ApsaraVideo Live console and click Production Studios in the left-side navigation pane.
Note You can find the ID of the production studio in the Instance ID/Name column.
80787064-1c94-4dc1-85ce-9409960a****
SceneIdstringYes

The ID of the scene.

This parameter takes effect only if the scene is a PVW scene.

242b4e2c-c30f-4442-85ba-2e3e4e3d****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

CF60DB6A-7FD6-426E-9288-122CC1A52FA7
StreamUrlstring

The streaming URL of the scene. It is used for playback, but not for stream relay.

http://live/caster/example.org

Examples

Sample success responses

JSONformat

{
  "RequestId": "CF60DB6A-7FD6-426E-9288-122CC1A52FA7",
  "StreamUrl": "http://live/caster/example.org"
}

Error codes

HTTP status codeError codeError message
400IncorrectSceneStatus%s
400IncorrectSceneStatus.Inuse%s
400IncorrectCasterStatus.Idle%s
400InvalidCasterId.Malformed%s
400InvalidSceneId.Malformed%s
401IllegalOperation%s
403UserQuotaExceed%s
404InvalidCaster.NotFound%s
404InvalidScene.NotFound%s
404InvalidLayout.NotFound%s
404InvalidConfiguration.NotFound%s
404InvalidCasterTemplate.NotFound%s
500InternalError%s

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

Change history

Change timeSummary of changesOperation
No change history