AddCasterProgram - ApsaraVideo Live - Alibaba Cloud Documentation Center

Adds the episode list for carousel playback in a production studio.

Operation description

Create a production studio, add input sources to the production studio, and then call this operation to add the episode list for carousel playback in the production studio. This operation supports videos and components as episodes. For information about how to create a production studio, see CreateCaster .

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
live:AddCasterProgram	create	Caster `acs:live::{#accountId}:caster/{#CasterId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
Episode	array<object>	Yes	The information about episodes in the episode list.
	object	Yes	The information about the episode.
ComponentId	array	No	The components. Components in the production studio are listed from the bottom to the top in an array. Note This parameter is required and takes effect when the Episode.N.EpisodeType parameter is set to Component. This parameter is optional when the Episode.N.EpisodeType parameter is set to Resource. In this case, if this parameter is specified, the components are bound to and switched together with video resources.
	string	No	The ID of the component.	a2b8e671-2fe5-4642-a2ec-bf931826****
EndTime	string	No	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.	2016-06-29T10:02:00Z
EpisodeName	string	No	The name of the episode.	program_name_1
EpisodeType	string	No	The type of the episode. Resource: a video resource If you set this parameter to Resource, you must specify the Episode.N.ResourceId and Episode.N.SwitchType parameters. Component: a component If you set this parameter to Component, you must specify the Episode.N.ComponentId.N parameter.	Resource
ResourceId	string	No	The ID of the video resource. Note This parameter takes effect and is required when the Episode.N.EpisodeType parameter is set to Resource. This parameter is invalid if you set the Episode.N.EpisodeType parameter to Component. If the video resource was added by calling the AddCasterVideoResource operation, check the value of the response parameter ResourceId to obtain the ID.	a2b8e671-2fe5-4642-a2ec-bf93880e****
StartTime	string	No	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.	2016-06-29T09:00:00Z
SwitchType	string	No	The policy for switching episodes. Valid values: Note This parameter takes effect only when the Episode.N.EpisodeType parameter is set to Resource. TimeFirst: The episode starts when the previous 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.	TimeFirst
CasterId	string	Yes	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.	LIVEPRODUCER_POST-cn-0pp1czt****

Note N in the preceding request parameters indicates the sequence number. For example, Episode.N.EpisodeName specifies the name of episode N. For example, Episode.1.EpisodeName specifies the name of the first episode, and Episode.2.EpisodeName specifies the name of the second episode.

Response parameters

Parameter	Type	Description	Example
	object
EpisodeIds	array<object>	The IDs of the episodes. The episode IDs are listed in the same order as specified by the variable N.
EpisodeId	object
EpisodeId	string	The ID of the episode. You can use the ID as a request parameter in the API operation that is used to modify the episode list, query the information about the episode list, delete the episode, or modify the configurations of the episode.	16A96B9A-F203-4EC5-8E43-CB92E68F****
RequestId	string	The request ID.	16A96B9A-F203-4EC5-8E43-CB92E68F****

Examples

Sample success responses

JSONformat

{
  "EpisodeIds": {
    "EpisodeId": [
      {
        "EpisodeId": "16A96B9A-F203-4EC5-8E43-CB92E68F****"
      }
    ]
  },
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F****"
}

Error codes

HTTP status code	Error code	Error message
400	MissingParameter	%s
400	InvalidParameter.Malformed	%s
400	SwitchTypeInvalid.Malformed	%s
400	IncorrectStartTime	%s
400	IncorrectEndTime	%s
400	EpisodeConflict.Malformed	%s
400	InvalidCasterId.Malformed	%s
400	InvalidParameter.EndTime	%s
401	IllegalOperation	%s
404	InvalidCaster.NotFound	%s
404	InvalidResource.NotFound	%s
404	InvalidComponent.NotFound	%s
500	InternalError	%s

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

Change history

Change time	Summary of changes	Operation

No change history