All Products
Search
Document Center

ApsaraVideo Live:StartCaster

Last Updated:Dec 06, 2024

Starts a production studio. If the production studio does not have a PVW scene or a PGM scene, this operation creates and starts such scenes and starts audio and video processing tasks.

Operation description

You can call the CreateCaster operation to create a production studio and then call this operation to start the production studio. If the production studio does not have a PVW scene or a PGM scene, this operation creates and starts such scenes and starts audio and video processing tasks.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
live:StartCasterupdate
*Caster
acs:live:*:{#accountId}:caster/{#CasterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
CasterIdstringYes

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.
80787064-1c94-4dc1-85ce-9409960a****

Response parameters

ParameterTypeDescriptionExample
object

The information about the production studio.

PgmSceneInfosarray<object>

The PGM scenes.

SceneInfoobject

The information about the PGM scene.

SceneIdstring

The ID of the scene.

b5f8c837-ceeb-424f-b30b-68e94e86****
StreamInfosarray<object>

The stream relay URLs.

StreamInfoobject

The detailed information.

OutputStreamUrlstring

The URL.

rtmp://abclive/caster/example.net
TranscodeConfigstring

The transcoding configuration. Valid values:

  • lsd: standard definition
  • lld: low definition
  • lud: ultra-high definition
  • lhd: high definition
lld
VideoFormatstring

The format. Valid values:

  • flv
  • rtmp
  • m3u8
flv
StreamUrlstring

The streaming URL of the PGM scene in the production studio. The value is not a stream relay URL.

rtmp://abclive/caster/example.edu
PvwSceneInfosarray<object>

The PVW scenes.

SceneInfoobject

The information about the PVW scene.

SceneIdstring

The ID of the scene.

b5f8c837-ceeb-424f-b30b-68e94e86****
StreamUrlstring

The streaming URL of the PVW scene in the production studio. The value is not a stream relay URL.

rtmp://abclive/caster/example.net
RequestIdstring

The request ID.

6EBD1AC4-C34D-4AE1-963E-B688A228BE31

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError message
400InvalidShowList.EmptyList%s
400InvalidUserId.Malformed%s
400InvalidCasterId.Malformed%s
400IncorrectSceneStatus%s
400IncorrectCasterStatus.Cease%s
400IncorrectCasterStatus.Expire%s
400IncorrectCasterStatus.Inuse%s
400IncorrectSceneStatus.Inuse%s
400InvalidParameter.Malformed%s
400IncorrectChannel.Disable%s
401IllegalOperation%s
403UserQuotaExceed%s
404InvalidCaster.NotFound%s
404InvalidDomainName.NotFound%s
404InvalidTranscode.NotFound%s
404InvalidDelay.NotFound%s
404InvalidCasterTemplate.NotFound%s
404InvalidConfiguration.NotFound%s
404InvalidResource.NotFound%s
500InternalError%s

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

Change history

Change timeSummary of changesOperation
No change history