跳到内容

StreamLive API 参考 ​

更新时间

StreamLive 的 API 服务代码为 mdl,API 版本为 2020-03-26。按安全组 → 输入 → 频道的顺序创建,启动频道后确认实际接收与播放情况。

调用规范 ​

项目值
EndpointPOST https://mdl.tencentcloudapi.com
Action参见下方 API 列表
请求签名使用官方 SDK / TCCLI 的 Tencent Cloud API 3.0 签名

基本信息 ​

项目值
API 服务代码mdl
API 版本2020-03-26
认证Tencent Cloud API 3.0 / TC3-HMAC-SHA256
调用工具Tencent Cloud SDK / TCCLI

执行前准备 ​

配置 TCCLI 的认证与权限。示例地域为 ap-seoul,REPLACE_ 标识符与文档用 IP 203.0.113.10/32 需替换为实际值。重新执行创建命令前,请确认已有的创建结果。

API 列表与请求参数 ​

Action操作
CreateStreamLiveInputSecurityGroup创建
DescribeStreamLiveInputSecurityGroups查询
CreateStreamLiveInput创建
DescribeStreamLiveInput查询
CreateStreamLiveChannel创建
DescribeStreamLiveChannel查询
StartStreamLiveChannel启动
StopStreamLiveChannel停止

响应与执行流程 ​

请保存创建响应中返回的资源 ID,并通过查询 API 确认状态。创建请求成功与实际输入接收、输出传输成功需区分开来。确认该资源的状态后再执行下一步。

错误与调用限制 ​

连接确认 ​

现象确认事项
CLI Action确认 Action 名称与 TCCLI 版本是否准确
输入信号 —推流地址、AppName / StreamName、输入安全组
模板名称英文 / 数字 1~20 位
仅输出一种画质Outputs 与各模板的绑定、实际主播放列表
频道修改确认操作对象与所需的频道状态

提交请求类咨询时,请提供 Action、地域、响应码、RequestId 与发生时间。测试结束后清理传输 / 存储 / 分发资源。

请求示例 ​

1. 输入安全组 ​

安全组创建 API 为 CreateStreamLiveInputSecurityGroup。

bash
tccli mdl CreateStreamLiveInputSecurityGroup --region ap-seoul \
  --Name demo_source_allowlist --Whitelist '["203.0.113.10/32"]'

需允许实际推流方的公网 IP。若前置使用了 StreamLink,需确认的是 StreamLink 发起连接所用的推流侧地址,而不是观众或操作 PC 的 IP。

操作Action
创建CreateStreamLiveInputSecurityGroup
列表查询DescribeStreamLiveInputSecurityGroups
详情查询DescribeStreamLiveInputSecurityGroup
修改ModifyStreamLiveInputSecurityGroup
删除DeleteStreamLiveInputSecurityGroup
bash
tccli mdl DescribeStreamLiveInputSecurityGroups --region ap-seoul

在创建或查询响应中确认要使用的安全组 ID。该输入安全组是与普通 CVM/VPC 安全组不同的 StreamLive 资源。

2. 创建 RTMP 输入 ​

bash
tccli mdl CreateStreamLiveInput --region ap-seoul \
  --Name demo_input --Type RTMP_PUSH \
  --SecurityGroupIds '["REPLACE_SECURITY_GROUP_ID"]' \
  --InputSettings '[{"AppName":"demo","StreamName":"source"}]'

上述配置为 RTMP_PUSH 示例。Pull 类型需确认源 URL,SRT 类型需确认相应的 SRT 配置。一个输入只能关联一个安全组。

bash
tccli mdl DescribeStreamLiveInput --region ap-seoul --Id REPLACE_INPUT_ID

使用查询响应或控制台中显示的推流地址。

3. 创建频道 ​

将 频道配置 中的 JSON 保存为 channel.json,并替换输入 ID 与 StreamPackage 频道 ID。

bash
tccli mdl CreateStreamLiveChannel --region ap-seoul --cli-input-json file://channel.json
配置作用
AttachedInputs要连接的输入
AVTemplates视频 / 音频合并型模板
AudioTemplates, VideoTemplates分离型音频 / 视频模板
OutputGroups输出方式、按画质输出、目的地

在合并型示例中,每个按画质划分的 Output 各关联一个模板。

4. 查询 / 启动 ​

bash
tccli mdl DescribeStreamLiveChannel --region ap-seoul --Id REPLACE_CHANNEL_ID
tccli mdl StartStreamLiveChannel --region ap-seoul --Id REPLACE_CHANNEL_ID

执行后确认频道状态、输入信号、输出列表、打包器接收情况以及播放器播放情况。

5. 停止与变更 ​

bash
tccli mdl StopStreamLiveChannel --region ap-seoul --Id REPLACE_CHANNEL_ID

需要停止频道的变更,请在维护时段或准备好备用路径后,于 IDLE 状态下应用。

引擎目录·相关文档 ​

参考文档 ​

基于 VitePress 构建 · 部署于腾讯云 EdgeOne Pages