You need to enable JavaScript to run this app.
导航
新增直播频道
最近更新时间:2024.07.02 09:25:24首次发布时间:2024.07.02 09:25:24

您可通过此接口在指定直播间新增直播频道。

注意事项

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

请求说明

  • 请求方式:POST
  • 请求地址:https://livesaas.volcengineapi.com/?Action=CreateLiveChannelConfig&Version=2023-08-01

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringCreateLiveChannelConfig接口名称。当前 API 的名称为 CreateLiveChannelConfig
VersionString2023-08-01接口版本。当前 API 的版本为 2023-08-01

Body

参数类型是否必选示例值描述
ActivityIdLong1783308668443直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。
LineNameString默认频道直播频道名称。最多支持输入 100 个字符。
CoverImageStringhttps://p1-live.example.com.webp直播频道封面图。需要包含协议头。不传则为直播封面图。

Resolution

Array of String

["sd","hd"]

频道的可选清晰度。观众仅可在您选择的范围内切换清晰度。清晰度越高,对网络环境要求越高。支持以下取值,默认选择 auto 且不支持删除。

  • origin:原画
  • bd:蓝光
  • uhd:超清
  • hd:高清
  • sd:标清
  • auto:智能

PCDefaultResolution

String

hd

PC 端观看页的智能清晰度。PC 端观众进入直播间时,将默认按照智能清晰度播放直播内容。支持以下取值,如未进行特殊配置,默认取值为 hd

  • origin:原画
  • bd:蓝光
  • uhd:超清
  • hd:高清
  • sd:标清

MobileDefaultResolution

String

hd

移动端观看页的智能清晰度。移动端观众进入直播间时,将默认按照智能清晰度播放直播内容。支持以下取值,如未进行特殊配置,默认取值为 sd

  • origin:原画
  • bd:蓝光
  • uhd:超清
  • hd:高清
  • sd:标清

MainBackupType

Integer

1

是否开启主备流功能。支持以下取值,默认取值为 2

  • 1:开启,则企业直播会推送该频道的两路直播流至主地址和备地址,同时优先播放主地址的直播流。当主地址的推流断流后,可自动切换至备地址,以保证直播的稳定性。
  • 2:关闭

LlsType

Integer

1

是否开启超低延时功能。支持以下取值,默认取值为 2

  • 1:开启,则选择该频道的观众可以 1 秒以内的超低延时观看直播内容。详见超低延时直播
  • 2:关闭

TimeShiftType

Integer

1

是否开启直播时移功能。支持以下取值,默认取值为 2

  • 1:开启,则选择该频道的观众可以拖动进度条跳转至 8 小时内任意过去时间点观看直播内容。详见直播时移
  • 2:关闭

LineLanguage

String

cn

频道的页面默认语言。观看页可根据观众的 PC 端浏览器语言或移动端系统语言,判断默认播放哪个频道的直播内容。例如频道 A 的语言是简中,PC 端浏览器语言为简中的观众在进入直播间时,观看页会默认播放频道 A 的直播内容。支持以下取值:默认取值为 other

  • cn:简中
  • en:英文
  • jp:日文
  • hant:繁中
  • ko:韩文
  • other:其他

返回参数

参数类型示例值描述
ActivityIdLong1783308668443直播间 ID。
LineIdLong341231直播频道 ID。
LineIndexInteger1直播频道索引值。
LineNameString默认频道直播频道名称。
CoverImageStringhttps://p1-live.example.com.webp直播频道封面图。

Resolution

Array of String

["sd","hd"]

频道的可选清晰度。支持以下取值:

  • origin:原画
  • bd:蓝光
  • uhd:超清
  • hd:高清
  • sd:标清
  • auto:智能

PCDefaultResolution

String

hd

PC 端观看页的智能清晰度。支持以下取值:

  • origin:原画
  • bd:蓝光
  • uhd:超清
  • hd:高清
  • sd:标清

MobileDefaultResolution

String

hd

移动端观看页的智能清晰度。支持以下取值:

  • origin:原画
  • bd:蓝光
  • uhd:超清
  • hd:高清
  • sd:标清

MainBackupType

Integer

1

是否开启主备流功能。支持以下取值:

  • 1:开启
  • 2:关闭

LlsType

Integer

1

是否开启超低延时功能。支持以下取值:

  • 1:开启
  • 2:关闭

TimeShiftType

Integer

1

是否开启直播时移功能。支持以下取值:

  • 1:开启
  • 2:关闭

LineLanguage

String

cn

频道的页面默认语言。支持以下取值:

  • cn:简中
  • en:英文
  • jp:日文
  • hant:繁中
  • ko:韩文
  • other:其他

请求示例

POST https://livesaas.volcengineapi.com/?Action=CreateLiveChannelConfig&Version=2023-08-01
{
    "CoverImage": "https://p1-live.example.com.webp",
    "Resolution": [
        "sd",
        "hd"
    ],
    "PCDefaultResolution": "hd",
    "MobileDefaultResolution": "hd",
    "MainBackupType": 1,
    "LlsType": 1,
    "TimeShiftType": 1,
    "ActivityId": 1783308668443,
    "LineName": "默认频道"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateLiveChannelConfig",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1717269866
    },
    "Result": {
        "ActivityId": 1783308668443,
        "CoverImage": "https://p1-live.example.com.webp",
        "Resolution": [
            "sd",
            "hd"
        ],
        "PCDefaultResolution": "hd",
        "MobileDefaultResolution": "hd",
        "MainBackupType": 1,
        "LlsType": 1,
        "TimeShiftType": 1,
        "LineId": 341231,
        "LineIndex": 1,
        "LineName": "默认频道",
        "LineLanguage": "cn"
    }
}

错误码

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