Configures a channel of a production studio.

Usage note

The ChannelId parameter is required in the request.

QPS limit

A single user can perform a maximum of 10 queries per second (QPS). Throttling is triggered when the number of calls per second exceeds the QPS limit. The throttling may affect your business. Thus, we recommend that you observe the QPS limit on this operation. For more information about what a single user means and the QPS details, see QPS limit on an API operation in ApsaraVideo Live.

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 SetCasterChannel

The operation that you want to perform. Set the value to SetCasterChannel.

CasterId String Yes a2b8e671-2fe5-4642-a2ec-bf93880e****

The ID of the production studio.

If you create a production studio through the CreateCaster interface, check the value of the CasterId parameter in the response.

If you create a production studio through the ApsaraVideo Live Console, log in to the console, then check the ID of the production studio through the following path:

Production Studios > Production Studio Management

Note The CasterId is reflected in the Name column on the Production Studio Management page.
ChannelId String Yes RV01

The ID of the channel. You can call the DescribeCasterChannels operation to get the ID.

When channels are enabled, the layout references the channel IDs. You can specify up to one video resource for a channel. The number of video resources is limited by the number of the channels of the production studio. The value must be in the RV[Number] format, such as RV01 and RV12.

RegionId String No cn-shanghai

The ID of the region.

ResourceId String No 16A96B9A-F203-4EC5-8E43-CB92E68F****

The ID of the video resource. It is included in the response when you call the AddCasterVideoResource operation.

SeekOffset Integer No 1000

The offset of the position where the system starts to read the video resource. The value must be greater than 0, which indicates an offset from the first frame. This parameter does not take effect for live streams. Unit: milliseconds.

PlayStatus Integer No 1

The playback status. This parameter takes effect only when the video resource is a file. Valid values:

  • 1: indicates that the video is being played. This is the default value.
  • 0: indicates that the playback is paused.

Response parameters

Parameter Type Example Description
RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

The ID of the request.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=SetCasterChannel
&CasterId=a2b8e671-2fe5-4642-a2ec-bf93880e****
&ChannelId=RV01
&ResourceId=16A96B9A-F203-4EC5-8E43-CB92E68F****
&<Common request parameters>

Sample success responses

XML format

<SetCasterChannelResponse>
      <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
</SetCasterChannelResponse>

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.