All Products
Search

This Product

    ApsaraVideo Live:StartCasterScene

    Document Center

    ApsaraVideo Live:StartCasterScene

    Last Updated:Aug 15, 2025

    Starts a specified Program View (PVW) scene. This operation is used to start preview scenes.

    Operation description

    You can call this operation to start a specified Program View (PVW) scene. A PVW scene is a preview scene.

    QPS limits

    The queries per second (QPS) limit for a single user is 10. If you exceed this limit, API calls are throttled. Throttling can affect your business. We recommend that you call this operation within the specified limit.

    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

    live:StartCasterScene

    update

    *Caster

    acs:live:*:{#accountId}:caster/{#CasterId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    No

    The ID of the region.

    cn-shanghai
    CasterId

    string

    Yes

    The ID of the production studio.

    • If you created the production studio by calling the CreateCaster operation, use the CasterId value returned in the response.

    • If you created the production studio in the ApsaraVideo Live console, go to the Production Studio > Cloud Production Studio page to view the ID.

    Note

    The production studio ID is displayed as its name on the Cloud Production Studio page.

    80787064-1c94-4dc1-85ce-9409960a****
    SceneId

    string

    Yes

    The ID of the scene.

    This parameter is valid only for PVW scenes.

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

    Response parameters

    Parameter

    Type

    Description

    Example

    object

    RequestId

    string

    The ID of the request.

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

    string

    The output stream URL of the current scene. This URL is used for playback in the production studio and is not a bypass output.

    http://live/caster/example.org

    Examples

    Success response

    JSON format

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

    Error codes

    HTTP status code

    Error code

    Error message

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

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.