StartCaster - ApsaraVideo Live - Alibaba Cloud Documentation Center

Starts a production studio. If the Preview (PVW) and Program (PGM) scenarios do not exist, this operation creates them, and then starts the scenarios and the underlying audio and video processing tasks.

Operation description

Before starting a production studio, call the CreateCaster operation to create the studio. Then, call this operation to start it. If the Preview (PVW) and Program (PGM) scenarios do not exist, this operation creates them, and then starts the scenarios and their underlying audio and video processing tasks.

QPS Limit

The queries per second (QPS) limit for this operation is 10 calls per second per user. If you exceed this limit, API calls are throttled. Throttling may affect your business. Call this operation within the 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:StartCaster

update

*Caster

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

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 the production studio by calling the CreateCaster operation, use the CasterId value returned in the response. If you create the production studio in the ApsaraVideo Live console, go to the Production Studio > Cloud Production Studio page to view the ID. Note The name of the production studio in the list on the Cloud Production Studio page is the production studio ID.	80787064-1c94-4dc1-85ce-9409960a****

Response parameters

Parameter	Type	Description	Example
	object	The information about the production studio.
PgmSceneInfos	object
SceneInfo	array<object>	The list of PGM scenarios.
	object	A PGM scenario.
SceneId	string	The scenario ID.	b5f8c837-ceeb-424f-b30b-68e94e86****
StreamInfos	object
StreamInfo	array<object>	The list of bypass output streams.
	object	A bypass output stream.
OutputStreamUrl	string	The playback URL.	rtmp://abclive/caster/example.net
TranscodeConfig	string	The transcoding configuration. Valid values: lsd: standard definition. lld: low definition. lud: ultra-high definition. lhd: high definition.	lld
VideoFormat	string	The format. Valid values: flv. rtmp. m3u8.	flv
StreamUrl	string	The playback stream URL for the PGM scenario of the production studio. This is not the URL for the bypass output stream.	rtmp://abclive/caster/example.edu
PvwSceneInfos	object
SceneInfo	array<object>	The list of PVW scenarios.
	object	A PVW scenario.
SceneId	string	The scenario ID.	b5f8c837-ceeb-424f-b30b-68e94e86****
StreamUrl	string	The playback stream URL for the PVW scenario of the production studio. This is not the URL for the bypass output stream.	rtmp://abclive/caster/example.net
RequestId	string	The request ID.	6EBD1AC4-C34D-4AE1-963E-B688A228BE31

Examples

Success response

JSON format

{
  "PgmSceneInfos": {
    "SceneInfo": [
      {
        "SceneId": "b5f8c837-ceeb-424f-b30b-68e94e86****",
        "StreamInfos": {
          "StreamInfo": [
            {
              "OutputStreamUrl": "rtmp://abclive/caster/example.net",
              "TranscodeConfig": "lld",
              "VideoFormat": "flv"
            }
          ]
        },
        "StreamUrl": "rtmp://abclive/caster/example.edu"
      }
    ]
  },
  "PvwSceneInfos": {
    "SceneInfo": [
      {
        "SceneId": "b5f8c837-ceeb-424f-b30b-68e94e86****",
        "StreamUrl": "rtmp://abclive/caster/example.net"
      }
    ]
  },
  "RequestId": "6EBD1AC4-C34D-4AE1-963E-B688A228BE31"
}

Error codes

HTTP status code	Error code	Error message
400	InvalidShowList.EmptyList	%s
400	InvalidUserId.Malformed	%s
400	InvalidCasterId.Malformed	%s
400	IncorrectSceneStatus	%s
400	IncorrectCasterStatus.Cease	%s
400	IncorrectCasterStatus.Expire	%s
400	IncorrectCasterStatus.Inuse	%s
400	IncorrectSceneStatus.Inuse	%s
400	InvalidParameter.Malformed	%s
400	IncorrectChannel.Disable	%s
401	IllegalOperation	%s
500	InternalError	%s
403	UserQuotaExceed	%s
404	InvalidCaster.NotFound	%s
404	InvalidDomainName.NotFound	%s
404	InvalidTranscode.NotFound	%s
404	InvalidDelay.NotFound	%s
404	InvalidCasterTemplate.NotFound	%s
404	InvalidConfiguration.NotFound	%s
404	InvalidResource.NotFound	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.