调用DescribeCasterConfig查询导播台配置信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeCasterConfig

系统规定参数。取值:DescribeCasterConfig

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

导播台ID。

返回数据

名称 类型 示例值 描述
CallbackUrl String http://test.aliyunlive.com/callBackLive

用户回调地址。

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

导播台ID。

CasterName String coco-caster10

导播台名称。

ChannelEnable Integer 1

是否启用Channel。 取值:

  • 0:不启用。
  • 1:启用。
Delay Float 0

延时播放。单位:秒 。

  • 0:禁用延时。
  • 大于0:启用延时。
DomainName String sophon-test.aliyunlive.com

主播流域名。

ProgramEffect Integer 0

轮播生效标志。 取值:

  • 0:不生效 。
  • 1:生效。
ProgramName String program_name

轮播台名称。

RecordConfig Struct

录制配置参数为空时,表示不启用录制功能。

OssBucket String test123

存储位置。

OssEndpoint String oss-cn-shanghai.aliyuncs.com

存储位置所在OSS节点。

RecordFormat Array of RecordFormat

录制格式配置。

RecordFormat
CycleDuration Integer 3600

录制时长。

Format String m3u8

录制格式。

OssObjectPrefix String record/{AppName}/{StreamName}

录制文件名。

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

切片名称。

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

请求ID。

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

用户自定义导播台旁路输出地址。

TranscodeConfig Struct

转码配置。

CasterTemplate String lp_hd

导播台转码模板。取值:

  • lp_ld:流畅。
  • lp_sd:标清。
  • lp_hd:高清。
  • lp_ud:超清。
  • lp_ld_v:竖屏流畅。
  • lp_sd_v:竖屏标清。
  • lp_hd_v:竖屏高清。
  • lp_ud_v:竖屏超清。
LiveTemplateIds List lld

直播转码配置。取值:

  • lsd:标清 。
  • lld:流畅。
  • lud:超清。
  • lhd:高清自适应转码模板 。
  • daobo-lsd:标清。
  • daobo-lld:流畅。
  • daobo-lud:超清。
  • daobo-lhd:高清 。
UrgentMaterialId String 98646538-bcf9-4aef-bd4a-e6bb76588****

备播视频,媒资库素材ID。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=DescribeCasterConfig
&CasterId=LIVEPRODUCER_POST-cn-0pp1czt****
&<公共请求参数>

正常返回示例

XML格式

<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格式

{
  "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
               }
          ]
      }
}

错误码

访问错误中心查看更多错误码。