Build a PVW-PGM Caster Studio via StartCaster API - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Starts a production studio. If the PVW and PGM scenes do not exist, they are created. The PVW and PGM scenes are started, and the underlying audio and video processing tasks are initiated.

Operation description

Create a production studio by calling the CreateCaster operation, and then call this operation to start the production studio. If the PVW and PGM scenes do not exist, they are created. The PVW and PGM scenes are started, and the underlying audio and video processing tasks are initiated.

Before calling this operation, call SetCasterConfig to configure DomainName. If DomainName is not configured, the error InvalidDomainName.NotFound is returned.

QPS limit

The single-user QPS limit for this operation is 10 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation as appropriate.

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

Response elements

Element	Type	Description	Example
	object	The production studio information.
PgmSceneInfos	object
SceneInfo	array<object>	The list of PGM scene information.
	array<object>	The list of PGM scene information.
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 scene information.
	object	The list of PVW scene information.
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	Description
400	InvalidUserId.Malformed	%s, please check userId.	The userId passed in is invalid, please check.
400	InvalidCasterId.Malformed	%s, please check and try again later.	The parameter CasterId is invalid, please check and try again.
400	IncorrectSceneStatus	%s, please check and try again later.	Scene status is not supported, please check and try again.
400	IncorrectCasterStatus.Inuse	%s, please check and try again later.	Caster status is inuse, please check and try again later.
400	IncorrectSceneStatus.Inuse	%s, please check and try again later.	Scene is on, please check and try again.
400	InvalidParameter.Malformed	There are invalid parameters: %s.	There are invalid parameters: %s.
400	IncorrectChannel.Disable	%s, please check and try again later.	The Channel is in a non-settable state, please check and try again.
400	IncorrectCasterStatus.Cease	%s, please check and try again later.	The caster has stopped service due to arrears, please settle and try again.
400	IncorrectCasterStatus.Expire	%s, please check and try again later.	The prepaid instance of the caster has expired, please renew it and try again.
401	IllegalOperation	%s, please check and try again later.	Operation not allowed, please check and try again.
403	UserQuotaExceed	Quota exceeded: %s.	Quota exceeded: %s.
404	InvalidCaster.NotFound	%s, please check and try again later.	The guide station does not exist, please check and try again.
404	InvalidDomainName.NotFound	%s, please check and try again later.	Domain name does not exist, please check and try again.
404	InvalidCasterTemplate.NotFound	%s, please check and try again later.	The guide template does not exist. Please check and try again.
404	InvalidConfiguration.NotFound	%s, please check and try again later.	Configuration does not exist, please check and try again.
404	InvalidResource.NotFound	%s, please check and try again later.	The resource does not exist. Please check and try again.
404	InvalidTranscode.NotFound	%s, please check and try again later.	Transcoding is not configured, please check and try again.
404	InvalidDelay.NotFound	%s, please check and try again later.	Delayed playback is not configured, please check and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.