StartCaster - 启动导播台

启动导播台。若PVW、PGM场景不存在则创建,启动PVW、PGM场景,启动底层音视频处理任务。

接口说明

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

QPS 限制

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
live:StartCasterupdate
  • Caster
    acs:live:*:{#accountId}:caster/{#CasterId}

请求参数

名称类型必填描述示例值
CasterIdstring

导播台 ID。

  • 如果您通过 CreateCaster 接口创建导播台,请查看 CreateCaster 接口调用返回的参数 CasterId 值。

  • 如果您通过直播控制台创建导播台,请通过直播控制台 > 导播台 > 云导播台页面查看。

说明 直播控制台云导播台页面导播台列表中的导播台名称即导播台 ID。
80787064-1c94-4dc1-85ce-9409960a****

返回参数

名称类型描述示例值
object

导播台信息。

PgmSceneInfosarray<object>

PGM 场景信息列表。

SceneInfoobject

PGM 场景信息列表。

SceneIdstring

场景 ID。

b5f8c837-ceeb-424f-b30b-68e94e86****
StreamInfosarray<object>

旁路输出播放地址列表。

StreamInfoobject

旁路输出播放地址列表。

OutputStreamUrlstring

播放地址。

rtmp://abclive/caster/example.net
TranscodeConfigstring

转码配置。 取值:

  • lsd:标清。
  • lld:流畅。
  • lud:超清。
  • lhd:高清。
lld
VideoFormatstring

格式。取值:

  • flv
  • rtmp
  • m3u8
flv
StreamUrlstring

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

rtmp://abclive/caster/example.edu
PvwSceneInfosarray<object>

PVW 场景信息列表。

SceneInfoobject

PVW 场景信息列表。

SceneIdstring

场景 ID。

b5f8c837-ceeb-424f-b30b-68e94e86****
StreamUrlstring

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

rtmp://abclive/caster/example.net
RequestIdstring

请求 ID。

6EBD1AC4-C34D-4AE1-963E-B688A228BE31

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息
400InvalidShowList.EmptyList%s
400InvalidUserId.Malformed%s
400InvalidCasterId.Malformed%s
400IncorrectSceneStatus%s
400IncorrectCasterStatus.Cease%s
400IncorrectCasterStatus.Expire%s
400IncorrectCasterStatus.Inuse%s
400IncorrectSceneStatus.Inuse%s
400InvalidParameter.Malformed%s
400IncorrectChannel.Disable%s
401IllegalOperation%s
403UserQuotaExceed%s
404InvalidCaster.NotFound%s
404InvalidDomainName.NotFound%s
404InvalidTranscode.NotFound%s
404InvalidDelay.NotFound%s
404InvalidCasterTemplate.NotFound%s
404InvalidConfiguration.NotFound%s
404InvalidResource.NotFound%s
500InternalError%s

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

变更历史

变更时间变更内容概要操作
暂无变更历史