Modifies an episode list of a production studio.

Usage note

This operation is only applicable to the production studio whose NormType is set to 0 (the playlist mode) when you call the CreateCaster operation.

QPS limit

A single user can perform a maximum of 4 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 ModifyCasterProgram

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

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

The ID of the production studio. It is included in the response when you call the CreateCaster operation.

RegionId String No cn-shanghai

The ID of the region.

Episode.N.EpisodeId String No a2b8e671-2fe5-4642-a2ec-bf938887****

The ID of the episode.

Episode.N.EpisodeType String No Resource

The type of the episode. Valid values:

  • Resource: a video resource.
  • Component: a component.
Episode.N.EpisodeName String No program_name_2

The name of the episode.

Episode.N.ResourceId String No a2b8e671-2fe5-4642-a2ec-bf938887****

The ID of the video resource.

Episode.N.ComponentId.N RepeatList No ["a2b8e671-2fe5-4642-a2ec-bf93888****" ]

The ID of the component. Components in the production studio are listed from the bottom to the top in an array. When the production studio switches to another video resource, the components are also switched.

  • The parameter takes effect and is required only when the Episode.N.EpisodeType parameter is set to Component.
  • If the Episode.N.EpisodeType parameter is set to Resource, the components are bound with and switched together with video resources.
Episode.N.StartTime String No 2016-06-29T09:02:00Z

The start time of the episode. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

Episode.N.EndTime String No 2016-06-29T10:04:00Z

The end time of the episode. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

Episode.N.SwitchType String No TimeFirst

The policy for switching the video resources of the episode. This parameter takes effect only when the Episode.N.EpisodeType parameter is set to Resource. Valid values:

  • TimeFirst: The episode starts when the preceding episode ends and ends when the next episode starts. If no next episode exists, the episode keeps repeating until a new episode is added or the production studio stops. This value is required for live video resources.
  • ContentFirst: The episode starts and ends as scheduled.

To modify an episode, you must specify at least one episode-related parameter.

Note

N in request parameters indicates the sequence number. Example:

The Episode.N.EpisodeName parameter specifies the name of episode N. The Episode.1.EpisodeName parameter specifies the name of the first episode. The Episode.2.EpisodeName parameter specifies the name of the second episode.

Response parameters

Parameter Type Example Description
CasterId String a2b8e671-2fe5-4642-a2ec-bf93880e****

The ID of the production studio.

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

The ID of the request.

Examples

Sample requests

https://live.aliyuncs.com/?Action=ModifyCasterProgram
&CasterId=a2b8e671-2fe5-4642-a2ec-bf93880e****
&Episode.1.EpisodeId=a2b8e671-2fe5-4642-a2ec-bf938887****
&Episode.1.EpisodeName=program_name_2
&Episode.1.EpisodeType=Resource
&<Common request parameters>

Sample success responses

XML format

<ModifyCasterProgramResponse>
      <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
      <CasterId>a2b8e671-2fe5-4642-a2ec-bf93880e****</CasterId>
</ModifyCasterProgramResponse>

JSON format

{
    "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
    "CasterId": "a2b8e671-2fe5-4642-a2ec-bf93880e****"
}

Error codes

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