Starts a production studio.

Usage note

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

QPS limit

A single user can perform a maximum of 10 queries per second (QPS). Throttling is triggered when the number of calls per second exceeds the QPS limit. The throttling may affect your business. Thus, we recommend that you observe the QPS limit on this operation. For more information about what a single user means and the QPS details, 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 StartCaster

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

CasterId String Yes 80787064-1c94-4dc1-85ce-9409960a****

The ID of the production studio.

If you create a production studio through the CreateCaster interface, check the value of the CasterId parameter in the response.

If you create a production studio through the ApsaraVideo Live Console, log in to the console, then check the ID of the production studio through the following path:

Production Studios > Production Studio Management

Note The CasterId is reflected in the Name column on the Production Studio Management page.
RegionId String No cn-shanghai

The ID of the region.

Response parameters

Parameter Type Example Description
RequestId String 6EBD1AC4-C34D-4AE1-963E-B688A228BE31

The ID of the request.

PvwSceneInfos Array of SceneInfo

The information about the preview scene.

SceneInfo
SceneId String b5f8c837-ceeb-424f-b30b-68e94e86****

The ID of the scene.

StreamUrl String rtmp://abclive/caster/definc.flv

The streaming URL of the preview scene for the production studio. The value is not a third-party ingest URL.

PgmSceneInfos Array of SceneInfo

The information about the program scene.

SceneInfo
SceneId String b5f8c837-ceeb-424f-b30b-68e94e86****

The ID of the scene.

StreamUrl String rtmp://abclive/caster/******.flv

The streaming URL of the program scene for the production studio. The value is not a third-party ingest URL.

StreamInfos Array of StreamInfo

The information about the third-party ingest URLs.

StreamInfo
TranscodeConfig String lld

The configuration about transcoding for the production studio. Valid values:

  • lsd: standard definition.
  • lld: low definition.
  • lud: ultra high definition.
  • lhd: high definition.
VideoFormat String flv

The format to which the scene transcodes the stream for playback. Valid values:

  • flv
  • rtmp
  • m3u8
OutputStreamUrl String rtmp://abclive/caster/******.flv

The streaming URL.

Examples

Sample requests

https://live.aliyuncs.com/?Action=StartCaster
&CasterId=80787064-1c94-4dc1-85ce-9409960a****
&<Common request parameters>

Sample success responses

XML format

<StartCasterResponse>
  <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
  <PvwSceneInfos>
        <SceneId>b5f8c837-ceeb-424f-b30b-68e94e86****</SceneId>
        <StreamUrl>rtmp://aliLive/caster/1975ee99db904ebb83908d43bc878188?auth_key=1506396160-0-0-063397072a9980fd418d43eb00e0****</StreamUrl>
  </PvwSceneInfos>
  <PgmSceneInfos>
        <SceneId>b5f8c837-ceeb-424f-b30b-68e94e86****</SceneId>
        <StreamUrl>rtmp://aliLive/caster/1975ee99db904ebb83908d43bc878188?auth_key=1506396160-0-0-063397072a9980fd418d43eb00e02e10</StreamUrl>
        <StreamInfos>
              <VideoFormat>flv</VideoFormat>
              <OutputStreamUrl>http://aliLive/caster/fb628e2469f94f2aa2c0c219af8b2527_lld.flv?auth_key=1506396160-0-0-7de771a77102680861853af862d5****</OutputStreamUrl>
              <TranscodeConfig>lld</TranscodeConfig>
        </StreamInfos>
        <StreamInfos>
              <VideoFormat>rtmp</VideoFormat>
              <OutputStreamUrl>rtmp://aliLive/caster/fb628e2469f94f2aa2c0c219af8b2527_lld?auth_key=1506396160-0-0-77ed32cd82ed32ccd51a832b5765****</OutputStreamUrl>
              <TranscodeConfig>lld</TranscodeConfig>
        </StreamInfos>
        <StreamInfos>
              <VideoFormat>m3u8</VideoFormat>
              <OutputStreamUrl>http://aliLive/caster/fb628e2469f94f2aa2c0c219af8b2527.m3u8?auth_key=1506396160-0-0-d51f0512dcf76aa749f79f53ae64****</OutputStreamUrl>
              <TranscodeConfig>lld</TranscodeConfig>
        </StreamInfos>
  </PgmSceneInfos>
</StartCasterResponse>

JSON format

{
    "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
    "PvwSceneInfos": [
        {
           "SceneId":"b5f8c837-ceeb-424f-b30b-68e94e86****",
           "StreamUrl":"rtmp://aliLive/caster/1975ee99db904ebb83908d43bc878188?auth_key=1506396160-0-0-063397072a9980fd418d43eb00e0****"
        }
    ],
    "PgmSceneInfos": [
      {
         "SceneId":"b5f8c837-ceeb-424f-b30b-68e94e86****",
         "StreamUrl":"rtmp://aliLive/caster/1975ee99db904ebb83908d43bc878188?auth_key=1506396160-0-0-063397072a9980fd418d43eb00e0****",
         "StreamInfos": [
                {
                    "VideoFormat": "flv",
                    "OutputStreamUrl": "http://aliLive/caster/fb628e2469f94f2aa2c0c219af8b2527_lld.flv?auth_key=1506396160-0-0-7de771a77102680861853af862d5****",
                    "TranscodeConfig": "lld"
                },
                {
                    "VideoFormat": "rtmp",
                    "OutputStreamUrl": "rtmp://aliLive/caster/fb628e2469f94f2aa2c0c219af8b2527_lld? auth_key=1506396160-0-0-77ed32cd82ed32ccd51a832b5765****",
                    "TranscodeConfig": "lld"
                },
                {
                    "VideoFormat": "m3u8",
                    "OutputStreamUrl": "http://aliLive/caster/fb628e2469f94f2aa2c0c219af8b2527.m3u8?auth_key=1506396160-0-0-d51f0512dcf76aa749f79f53ae6421d2",
                    "TranscodeConfig": "lld"
                }
            ]
      }
    ]
}

Error codes

For a list of error codes, visit the API Error Center.