Queries the configurations of a production studio.

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 DescribeCasterConfig

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

CasterId String Yes LIVEPRODUCER_POST-cn-0pp1czt****

The ID of the production studio.

RegionId String No cn-shanghai

The ID of the region.

Response parameters

Parameter Type Example Description
CallbackUrl String http://test.aliyunlive.com/callBackLive

The callback URL.

CasterId String LIVEPRODUCER_POST-cn-0pp1czt****

The ID of the production studio.

CasterName String coco-caster10

The name of the production studio.

ChannelEnable Integer 1

Indicates whether channels are enabled for the production studio. Valid values:

  • 0: Channels are disabled.
  • 1: Channels are enabled.
Delay Float 0

Indicates whether stream delay is enabled. Unit: seconds.

  • A value of 0 indicates that stream delay is disabled.
  • A value greater than 0 indicates the delay duration.
DomainName String sophon-test.aliyunlive.com

The main streaming domain.

ProgramEffect Integer 0

Indicates whether the carousel playback is enabled. Valid values:

  • 0: The carousel playback is disabled.
  • 1: The carousel playback is enabled.
ProgramName String program_name

The name of the episode list for carousel playback.

RecordConfig Struct

If this parameter is not specified, the recording feature is disabled.

OssBucket String test123

The Object Storage Service (OSS) bucket that is used to store files of the production studio.

OssEndpoint String oss-cn-shanghai.aliyuncs.com

The endpoint of OSS.

RecordFormat Array of RecordFormat

The configuration of recording.

RecordFormat
CycleDuration Integer 3600

The recording duration.

Format String m3u8

The format of the recorded file.

OssObjectPrefix String record/{AppName}/{StreamName}

The name of the recorded file.

SliceOssObjectPrefix String record/{AppName}/{StreamName}/{UnixTimestamp}

The name of the media segment file.

RequestId String 97df6b7f-3490-47d2-ac50-8833e1b64597

The ID of the request.

SideOutputUrl String rtmp://sophon-test.aliyunlive.com/caster/4a82a3d1b7f0462ea37348366201****? auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****

The custom standby URL.

TranscodeConfig Struct

The configuration about transcoding for the production studio.

CasterTemplate String lp_hd

The transcoding template of the production studio. Valid values:

  • lp_ld: Videos generated by the transcoding template are in the low definition.
  • lp_sd: Videos generated by the transcoding template are in the standard definition.
  • lp_hd: Videos generated by the transcoding template are in the high definition.
  • lp_ud: Videos generated by the transcoding template are in the ultra high definition.
  • lp_ld_v: Videos generated by the transcoding template are in the low definition and in portrait mode.
  • lp_sd_v: Videos generated by the transcoding template are in the standard definition and in portrait mode.
  • lp_hd_v: Videos generated by the transcoding template are in the high definition and in portrait mode.
  • lp_ud_v: Videos generated by the transcoding template are in the ultra high definition and in portrait mode.
LiveTemplateIds List lld

The configuration of the live-to-VOD template. Valid values:

  • lsd: Videos generated by the live-to-VOD template are in the standard definition.
  • lld: Videos generated by the live-to-VOD template are in the low definition.
  • lud: Videos generated by the live-to-VOD template are in the ultra high definition.
  • lhd: Videos generated by the live-to-VOD template are in the high definition.
  • daobo-lsd: Videos generated by the live-to-VOD template are in the standard definition and in portrait mode.
  • daobo-lld: Videos generated by the live-to-VOD template are in the low definition and in portrait mode.
  • daobo-lud: Videos generated by the live-to-VOD template are in the ultra high definition and in portrait mode.
  • daobo-lhd: Videos generated by the live-to-VOD template are in the high definition and in portrait mode.
UrgentMaterialId String 98646538-bcf9-4aef-bd4a-e6bb76588****

The ID of the material from the media library that is used as the standby video.

Examples

Sample requests

http(s)://live.aliyuncs.com/? Action=DescribeCasterConfig
&CasterId=LIVEPRODUCER_POST-cn-0pp1czt****
&<Common request parameters>

Sample success responses

XML format

<DescribeCasterConfigResponse>
      <RequestId>97df6b7f-3490-47d2-ac50-8833e1b64597</RequestId>
      <CasterName>coco-caster10</CasterName>
      <DomainName>sophon-test.aliyunlive.com</DomainName>
      <TranscodeConfig>
            <CasterTemplate>lp_hd</CasterTemplate>
            <LiveTemplate>lld</LiveTemplate>
      </TranscodeConfig>
      <Delay>0</Delay>
      <RecordConfig>
            <Endpoint>live-cn-shanghai.aliyuncs.com</Endpoint>
            <OssBucket>oss-cn-shanghai.aliyuncs.com</OssBucket>
            <VideoFormat>
                  <Format>flv</Format>
                  <Prefix>record/{AppName}/{StreamName}</Prefix>
                  <SlicePrefix>record/{AppName}/{StreamName}/{UnixTimestamp}</SlicePrefix>
                  <Interval>3600</Interval>
            </VideoFormat>
            <VideoFormat>
                  <Format>m3u8</Format>
                  <Prefix>record/{AppName}/{StreamName}</Prefix>
                  <SlicePrefix>record/{AppName}/{StreamName}/{UnixTimestamp}</SlicePrefix>
                  <Interval>3600</Interval>
            </VideoFormat>
      </RecordConfig>
</DescribeCasterConfigResponse>

JSON format

{
  "RequestId": "97df6b7f-3490-47d2-ac50-8833e1b64597",
      "CasterName": "coco-caster10",
      "DomainName": "sophon-test.aliyunlive.com",
      "TranscodeConfig": {
          "CasterTemplate": "lp_hd",
          "LiveTemplate": [
              "lld"
          ]
      },
      "Delay": 0,
      "RecordConfig": {
          "Endpoint": "live-cn-shanghai.aliyuncs.com",
          "OssBucket": "oss-cn-shanghai.aliyuncs.com",
          "VideoFormat": [
              {
                  "Format":"flv",
                  "Prefix": "record/{AppName}/{StreamName}",
                  "SlicePrefix":"record/{AppName}/{StreamName}/{UnixTimestamp}",
                  "Interval":3600
               },
              {
                  "Format":"m3u8",
                  "Prefix": "record/{AppName}/{StreamName}",
                  "SlicePrefix":"record/{AppName}/{StreamName}/{UnixTimestamp}",
                  "Interval":3600
               }
          ]
      }
}

Error codes

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