调用StartCaster启动导播台。

使用说明

先通过CreateCaster接口创建导播台,再调用本接口启动导播台。若PVW、PGM场景不存在则创建,启动PVW、PGM场景,启动底层音视频处理任务。

QPS限制

本接口的单用户QPS限制为10次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

调试

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

请求参数

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

系统规定参数,取值:StartCaster

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

导播台ID。

  • 如果您通过CreateCaster接口创建导播台,请查看CreateCaster接口调用返回的参数CasterId值。
  • 如果您通过直播控制台创建导播台,请通过直播控制台 > 导播台 > 云导播台页面查看。
说明 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。
RegionId String cn-shanghai

地域ID。

返回数据

名称 类型 示例值 描述
RequestId String 6EBD1AC4-C34D-4AE1-963E-B688A228BE31

请求ID。

PvwSceneInfos Array of SceneInfo

PVW场景信息列表。

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

场景ID。

StreamUrl String rtmp://abclive/caster/example.net

导播台PVW场景对应播放流地址,非旁路输出流地址。

RtsUrl String rtmp://abclive/caster/aliyundoc.com

导播台PVW场景对应RTS流地址,非旁路输出流地址。

PgmSceneInfos Array of SceneInfo

PGM场景信息列表。

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

场景ID。

StreamUrl String rtmp://abclive/caster/example.edu

导播台PGM场景对应播放流地址,非旁路输出流地址。

StreamInfos Array of StreamInfo

旁路输出播放地址列表。

StreamInfo
TranscodeConfig String lld

转码配置。 取值:

  • lsd:标清。
  • lld:流畅。
  • lud:超清。
  • lhd:高清。
VideoFormat String flv

格式。取值:

  • flv
  • rtmp
  • m3u8
OutputStreamUrl String rtmp://abclive/caster/example.net

播放地址。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=StartCaster
&CasterId=80787064-1c94-4dc1-85ce-9409960a****
&<公共请求参数>

正常返回示例

XML格式

<StartCasterResponse>
  <RequestId>6EBD1AC4-C34D-4AE1-963E-B688A228BE31</RequestId>
  <PvwSceneInfos>
        <SceneInfo>
              <SceneId>b5f8c837-ceeb-424f-b30b-68e94e86****</SceneId>
              <RtsUrl></RtsUrl>
              <StreamUrl>rtmp://abclive/caster/example.net</StreamUrl>
        </SceneInfo>
  </PvwSceneInfos>
  <PgmSceneInfos>
        <SceneInfo>
              <SceneId>b5f8c837-ceeb-424f-b30b-68e94e86****</SceneId>
              <StreamUrl>rtmp://abclive/caster/example.edu</StreamUrl>
              <StreamInfos>
                    <StreamInfo>
                          <OutputStreamUrl>rtmp://abclive/caster/example.net</OutputStreamUrl>
                          <VideoFormat>flv</VideoFormat>
                          <TranscodeConfig>lld</TranscodeConfig>
                    </StreamInfo>
              </StreamInfos>
        </SceneInfo>
  </PgmSceneInfos>
</StartCasterResponse>

JSON格式

{
    "StartCasterResponse": {
        "RequestId": "6EBD1AC4-C34D-4AE1-963E-B688A228BE31",
        "PvwSceneInfos": {
            "SceneInfo": {
                "SceneId": "b5f8c837-ceeb-424f-b30b-68e94e86****",
                "RtsUrl": "",
                "StreamUrl": "rtmp://abclive/caster/example.net"
            }
        },
        "PgmSceneInfos": {
            "SceneInfo": {
                "SceneId": "b5f8c837-ceeb-424f-b30b-68e94e86****",
                "StreamUrl": "rtmp://abclive/caster/example.edu",
                "StreamInfos": {
                    "StreamInfo": {
                        "OutputStreamUrl": "rtmp://abclive/caster/example.net",
                        "VideoFormat": "flv",
                        "TranscodeConfig": "lld"
                    }
                }
            }
        }
    }
}

错误码

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