Creates a production studio.

Usage notes

You must enable the production studio feature before you can call this operation to create a production studio. For more information, see Enable the production studio feature.

You can call this operation to create production studios in general mode or playlist mode. Production studios in playlist mode can be used for carousel playback.

Limits

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. For more information, 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 CreateCaster

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

CasterName String No liveCaster****

The name of the production studio.

ClientToken String Yes 53200b81-b761-4c10-842a-a0726d97****

The client token that is used to ensure the idempotence of the request.

You can specify a custom value for this parameter, but you must make sure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

NormType Integer Yes 1

The type of the production studio. Valid values:

  • 1: general mode
  • 6: playlist mode (for carousel playback)
ChargeType String Yes PostPaid

The billing method. Only the pay-as-you-go billing method is supported. Valid values:

  • PrePaid: subscription. This billing method is not yet supported.
  • PostPaid: pay-as-you-go
PurchaseTime String No 2017-08-20T12:10:10Z

The time when the production studio was purchased. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

Note This parameter is valid only if you set the ChargeType parameter to PrePaid.
ExpireTime String No 2017-08-22T12:10:10Z

The expiration time of the production studio. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

Note This parameter is valid only if you set the ChargeType parameter to PrePaid.
CasterTemplate String No lp_sd

The preset resolution of the production studio. If the subscription billing method is used, this parameter supports the following valid values:

  • lp_ld: low definition
  • lp_sd: standard definition
  • lp_hd: high definition
  • lp_ud: ultra high definition
  • lp_ld_v: low definition (portrait mode)
  • lp_sd_v: standard definition (portrait mode)
  • lp_hd_v: high definition (portrait mode)
  • lp_ud_v: ultra high definition (portrait mode)
Note If the pay-as-you-go billing method is used, you must call the SetCasterConfig operation to specify the resolution.

Response parameters

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

The ID of the production studio. You can specify the ID in a request to query the streaming URLs of the production studio, start the production studio, add a video resource, a layout, a component, or a playlist to the production studio, or query layouts of the production studio.

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

The ID of the request.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=CreateCaster
&ChargeType=PostPaid
&ClientToken=53200b81-b761-4c10-842a-a0726d97****
&NormType=1
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<CreateCasterResponse>
<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
<CasterId>a2b8e671-2fe5-4642-a2ec-bf93880e1****</CasterId>
</CreateCasterResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, see Service error codes.