All Products
Search

This Product

    ApsaraVideo Live:SetCasterChannel

    Document Center

    ApsaraVideo Live:SetCasterChannel

    Last Updated:Aug 15, 2025

    Sets a channel for a production studio.

    Operation description

    Call the CreateCaster operation to create a production studio. You can then call this operation to set a channel for the production studio.

    QPS limit

    The queries per second (QPS) limit for this operation is 10 for each user. Exceeding this limit triggers throttling, which may affect your business. Call this operation at a reasonable rate to prevent interruptions.

    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:SetCasterChannel

    update

    *Caster

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

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    No

    The region ID.

    cn-shanghai
    CasterId

    string

    Yes

    The ID of the production studio.

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

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

    Note

    The production studio name in the list on the Cloud Production Studio page is the production studio ID.

    a2b8e671-2fe5-4642-a2ec-bf93880e****
    ChannelId

    string

    Yes

    The channel ID.

    The reference ID for the layout scene. You can set a maximum of one resource for each channel. The total number of channels is determined when you create the production studio. The format is `RV01` to `RV12`.

    RV01
    ResourceId

    string

    No

    The ID of the video source.

    16A96B9A-F203-4EC5-8E43-CB92E68F****
    SeekOffset

    integer

    No

    This parameter applies only to video files, not live streams. The value must be greater than or equal to 0. It specifies the offset from the first frame at which to start reading the file. Unit: milliseconds (ms).

    1000
    PlayStatus

    integer

    No

    The playback status. This parameter applies only to video files, not live streams. Valid values:

    • 1 (default): Playback.

    • 0: Pause.

    1
    FaceBeauty

    string

    No

    The facial retouching settings. Valid values: 0 (whole), 1 (skin smoothing), 2 (skin whitening), 3 (dark circle removal), and 4 (nasolabial fold removal).

    0

    Response parameters

    Parameter

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

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

    Examples

    Success response

    JSON format

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

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidUserId.Malformed %s
    400 InvalidCasterId.Malformed %s
    400 DuplicateLocationID %s
    400 InvalidParameter.PlayStatus %s
    400 InvalidChannelId.Malformed %s
    400 InvalidParameter.SeekOffset %s
    400 IncorrectChannel.Disable %s
    400 ResourceOfChannelExist %s
    400 InvalidParameter.Malformed %s
    401 IllegalOperation %s
    500 InternalError %s
    404 InvalidCaster.NotFound %s
    404 InvalidResource.NotFound %s

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.