调用 UpdateLoopVideos
接口,更新指定直播间中指定直播频道的伪直播配置信息,包括伪直播类型、伪直播视频名称和 Vid、绑定的互动脚本 ID 等。
请求频率:单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | UpdateLoopVideos | 接口名称。当前 API 的名称为 UpdateLoopVideos 。 |
Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
ActivityId | Long | 是 | 1776****89138 | 直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。 |
LineId | Long | 是 | 123 | 直播频道 ID。您可通过调用 GetStreamsAPI 接口获取 ID。 |
PlayType | Integer | 否 |
| 伪直播类型。默认值为
说明 如果您在控制台的观看页管理 > 基础信息页面打开自动开播开关并选择开始伪直播,或者调用 UpdateActivityBasicConfigAPI 接口并将
|
LoopNumber | Integer | 否 |
| 伪直播次数。默认值为 说明 当 |
AutoStartTime | Long | 否 |
| 伪直播自动开始时间。Unix 时间戳,单位为秒。支持精确到分钟级开播。
说明 当 |
AutoEndTime | Long | 否 |
| 伪直播自动结束时间。Unix 时间戳,单位为秒。支持精确到分钟级开播。 说明 当 |
IsShowProgram | Integer | 否 |
| 是否在观看页展示节目单,即伪直播视频列表。默认值为
|
ProgramName | String | 否 |
| 节目单名称。长度为 1 到 8 个字符。 说明 当 |
LoopVideos | Array of LoopVideos | 否 |
| 伪直播视频列表。 说明
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Index | Long | 是 | 1 | 伪直播视频序号。该参数取值为从 1 开始的连续且不重复的整数,如 1 、2 、3 。取值范围为 [1,50]。取值越小,在伪直播视频列表中的位置越靠前。 |
VideoName | String | 是 | 视频.mp4 | 伪直播视频名称。 |
VideoVid | String | 是 | v02a49370000br****vm75gbiokkno91 | 伪直播视频 Vid。您可通过调用 ListActivityMediaAPI 接口获取 Vid。 |
Offset | Integer | 是 | 10 | 伪直播启动时刻。单位为秒。例如参数取值为 10 ,则从视频的第 10 秒开始播放。 |
InteractionScriptEnabled | Boolean | 否 |
| 是否开启互动脚本。默认值为
|
InteractionScriptId | Long | 否 |
| 伪直播视频绑定的互动脚本 ID。您可通过调用 CreateInteractionScript 接口创建空白互动脚本并将其绑定至该伪直播视频。 注意
|
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
ActivityId | Long | 1776****89138 | 直播间 ID。 |
LineId | Long | 123 | 直播频道 ID。 |
PlayType | Integer |
| 伪直播类型。取值如下:
|
LoopNumber | Integer |
| 伪直播次数。例如,参数取值为 说明 该参数仅在 |
AutoStartTime | Long |
| 伪直播自动开始时间。Unix 时间戳,单位为秒。支持精确到分钟级开播。 说明 该参数仅在 |
AutoEndTime | Long |
| 伪直播自动结束时间。Unix 时间戳,单位为秒。支持精确到分钟级开播。 说明 该参数仅在 |
IsShowProgram | Integer |
| 是否在观看页展示节目单,即伪直播视频列表。取值如下:
|
ProgramName | String |
| 节目单名称。 说明 该参数仅在 |
LoopVideos | Array of LoopVideos | - | 伪直播视频列表。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Index | Integer | 1 | 伪直播视频序号。取值范围为 [1,50]。取值越小,在伪直播视频列表中的位置越靠前。 |
VideoCoverImage | String | https://www.example.com/a.png | 伪直播视频封面图,包含协议头。 |
VideoName | String | 视频.mp4 | 伪直播视频名称。 |
VideoVid | String | v02a49370000br****vm75gbiokkno91 | 伪直播视频 Vid。 |
Offset | Integer | 10 | 伪直播启动时刻。单位为秒。例如参数取值为 10 ,则从视频的第 10 秒开始播放。 |
ReviewStatus | Integer |
| 伪直播视频的审核状态。取值如下:
|
InteractionScriptEnabled | Boolean |
| 是否开启互动脚本。取值如下:
|
InteractionScriptId | Long | 1 | 伪直播视频绑定的互动脚本 ID。取值为 0 表示该伪直播视频未绑定互动脚本。 |
POST https://livesaas.volcengineapi.com/?Action=UpdateLoopVideos&Version=2023-08-01 { "ActivityId": 1776****89138, "LineId": 123, "LoopNumber": 3, "IsShowProgram": 0, "PlayType": 0, "AutoStartTime": 1736823565, "AutoEndTime": 1736923565, "ProgramName": "节目单", "LoopVideos": [ { "Index": 1, "VideoName": "视频.mp4", "VideoVid": "v02a49370000br****vm75gbiokkno91", "Offset": 10, "InteractionScriptId": 1, "InteractionScriptEnabled": true } ] }
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "UpdateLoopVideos", "Version": "2023-08-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1697446406 }, "Result": { "ActivityId": 1776****89138, "LineId": 123, "LoopNumber": 3, "LoopVideos": [ { "Index": 1, "VideoCoverImage": "https://www.example.com/a.png", "VideoName": "视频.mp4", "VideoVid": "v02a49370000br****vm75gbiokkno91", "ReviewStatus": 2, "Offset": 10, "InteractionScriptEnabled": true, "InteractionScriptId": 1 } ], "IsShowProgram": 0, "ProgramName": "节目单", "AutoStartTime": 1736823565, "AutoEndTime": 1736923565, "PlayType": 0 } }