You need to enable JavaScript to run this app.
导航
生成拉流地址
最近更新时间:2023.10.12 17:39:59首次发布时间:2022.09.27 17:56:43

调用接口生成拉流地址。

说明

该接口属于历史版本 API,我们计划于 2023 年 12 月 25 日停止对其进行维护,并于 2024 年 3 月 25 日下线文档,建议您使用新版生成拉流地址接口。

注意事项

请求频率:单用户请求频率限制为 25 次/秒

请求说明

  • 请求方式:POST
  • 请求地址:https://live.volcengineapi.com?Action=GeneratePlayURL&Version=2020-08-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

Query

参数类型是否必选示例值描述
ActionStringGeneratePlayURL接口名称。当前 API 的名称为 GeneratePlayURL
VersionString2020-08-01接口版本。当前 API 的版本为 2020-08-01

Body

参数类型是否必选示例值描述
AppStringlive应用名称,默认为所有应用名称,由 1 到 30 位数字、字母、下划线及"-"和"."组成。
DomainStringpull.example.com拉流域名
StreamStringstream001流名称

Type

String

fcdn

CDN 类型,默认值为 fcdn,支持如下取值。

  • fcdn:火山引擎流媒体直播 CDN;
  • 3rd:第三方 CDN。
SuffixStringhd转码流后缀,不传默认为空,可通过调用 ListVhostTransCodePreset 接口查询。

ValidDuration

Integer

5

有效时长,拉流地址的有效时间,过期后需要重新生成。单位为秒,取值 ﹥0,缺省情况下表示 7 天。

说明

如果同时设置 ValidDurationExpiredTime,以 ExpiredTime 的时间为准。

ExpiredTime

String

2022-08-19T16:07:25+08:00

过期时间,拉流地址的有效时间,过期后需要重新生成。RFC3339 格式的 UTC 时间,精度为秒,缺省情况下表示 7 天。

说明

如果同时设置 ValidDurationExpiredTime,以 ExpiredTime 的时间为准。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构

参数类型示例值描述
URLListArray of URLList-拉流地址信息列表

URLList

参数类型示例值描述
URLStringhttp://pull.example.com/live/stream001.sdp生成的拉流地址

Type

String

pull

地址类型,可能的值为:

  • push:推流;
  • pull:拉流;
  • 3rd_play(relay_source):第三方回源;
  • 3rd_play(relay_sink):第三方转推。

CDN

String

fcdn

CDN 类型。

  • fcdn:火山引擎流媒体直播 CDN;
  • 3rd:第三方 CDN。
ProtocolStringhls协议类型,包括 hls、flv 和 rtmp

示例

请求示例

POST https://live.volcengineapi.com?Action=GeneratePlayURL&Version=2020-08-01
{
  "Domain": "pull.example.com",
  "App": "live",
  "Stream": "stream001",
  "ExpiredTime": "2022-08-19T16:07:25+08:00"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2022081915573801022524312506B8B2EA",
    "Action": "GeneratePlayURL",
    "Version": "2020-08-01",
    "Service": "live",
    "Region": "cn-north-1"
  },
  "Result": {
    "URLList": [
      {
        "CDN": "fcdn",
        "Protocol": "hls",
        "Type": "pull",
        "URL": "http://pull.example.com/live/stream001.sdp"
      }
    ]
  }
}

错误码

访问公共错误码获取详细信息。