调用 UpdateLiveChannelConfig 接口,更新指定直播间中指定直播频道的配置信息。
说明
更新直播频道配置可能导致该频道的直播推流地址发生变化,因此更新配置后请通过 GetStreamsAPI 接口重新获取新的直播推流地址。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | UpdateLiveChannelConfig | 接口名称。当前 API 的名称为 UpdateLiveChannelConfig。 |
| Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
ActivityId | Long | 是 |
| 直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。 说明 使用子账号调用接口时,确保该直播间对子账号可见。有关如何配置子账号的可见范围,详见子账号管理。 |
LineId | Long | 否 |
| 直播频道 ID。您可以通过 ListLiveChannelConfig 接口查询 ID。 说明
|
LineIndex | Integer | 否 |
| 直播频道的索引值。索引值越小,位置越靠前。取值范围为 [0,19]。 说明
|
| LineName | String | 否 | 默认频道 | 直播频道名称。最多支持输入 100 个字符。 |
| CoverImage | String | 否 | https://p1-live.example.com.webp | 直播频道封面图。需要包含协议头。 |
Resolution | Array of String | 否 |
| 频道的可选清晰度。观众仅可在您选择的范围内切换清晰度。清晰度越高,对网络环境要求越高。支持以下取值,默认选择
|
PCDefaultResolution | String | 否 |
| PC 端观看页的智能清晰度。PC 端观众进入直播间时,将默认按照智能清晰度播放直播内容。支持以下取值:
|
MobileDefaultResolution | String | 否 |
| 移动端观看页的智能清晰度。移动端观众进入直播间时,将默认按照智能清晰度播放直播内容。支持以下取值:
|
MainBackupType | Integer | 否 |
| 是否开启主备流功能。支持以下取值:
|
LlsType | Integer | 否 |
| 是否开启超低延时功能。支持以下取值:
|
TimeShiftType | Integer | 否 |
| 是否开启直播时移功能。支持以下取值:
说明 开启多商品讲解功能期间,无法开启直播时移功能。 |
LineLanguage | String | 否 |
| 频道的页面默认语言。观看页可根据观众的 PC 端浏览器语言或移动端系统语言,判断默认播放哪个频道的直播内容。例如频道 A 的语言是简中,PC 端浏览器语言为简中的观众在进入直播间时,观看页会默认播放频道 A 的直播内容。支持以下取值:
|
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| ActivityId | Long | 1783308668443 | 直播间 ID。 |
| LineId | Long | 341231 | 直播频道 ID。 |
| LineIndex | Integer | 1 | 直播频道索引值。 |
| LineName | String | 默认频道 | 直播频道名称。 |
| CoverImage | String | https://p1-live.example.com.webp | 直播频道封面图。 |
Resolution | Array of String |
| 频道的可选清晰度。支持以下取值:
|
PCDefaultResolution | String |
| PC 端观看页的智能清晰度。支持以下取值:
|
MobileDefaultResolution | String |
| 移动端观看页的智能清晰度。支持以下取值:
|
MainBackupType | Integer |
| 是否开启主备流功能。支持以下取值:
|
LlsType | Integer |
| 是否开启超低延时功能。支持以下取值:
|
TimeShiftType | Integer |
| 是否开启直播时移功能。支持以下取值:
|
LineLanguage | String |
| 频道的页面默认语言。支持以下取值:
|
POST https://livesaas.volcengineapi.com/?Action=UpdateLiveChannelConfig&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, "LineIndex": 1, "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" } }
下表提供了该接口特有的错误码,公共错误码请参见公共错误码和错误码文档。
| 状态码 | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
| 403 | OperationDenied.DeniedByMultiProductExplain | Operation is denied because multi product explain and record product script/time shift cannot be enabled at the same time. | 开启多商品讲解功能期间,无法开启直播时移功能。请在调用 EnableActivityMultiProductExplain 接口将 IsMultiProductExplainEnable 的参数值设置为 0 后重试。 |
| 400 | OperationDenied.ActivityIsLiving | Cannot operate the live channel because the activity is living | 直播期间无法更新直播频道。请等待直播结束后重试。 |