获取直播间回放播放器设置--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

获取直播间回放播放器设置

最近更新时间：2025.01.22 10:45:54首次发布时间：2025.01.22 10:45:54

调用 GetActivityReplayPlayerConfig 接口，获取指定直播间的回放播放器设置，包括是否显示进度条、清晰度选择和倍速选择按钮。

注意事项

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

请求说明

请求方式：GET
请求地址：https://livesaas.volcengineapi.com/?Action=GetActivityReplayPlayerConfig&Version=2023-08-01

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetActivityReplayPlayerConfig`	接口名称。当前 API 的名称为 `GetActivityReplayPlayerConfig`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。
ActivityId	Long	是	`1815****06165`	直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。

返回参数

参数	类型	示例值	描述
ReplayPlayerConfig	Object of ReplayPlayerConfig	`-`	回放播放器设置。

ReplayPlayerConfig

参数类型示例值描述

参数	类型	示例值	描述
IsProgressBarEnable	Integer	`1`	是否显示进度条。取值如下： `0`：不显示 `1`：显示
IsResolutionEnable	Integer	`1`	是否显示清晰度选择按钮。取值如下： `0`：不显示 `1`：显示
IsSpeedControlEnable	Integer	`1`	是否显示倍速选择按钮。取值如下： `0`：不显示 `1`：显示

IsProgressBarEnable

Integer

1

是否显示进度条。取值如下：

0：不显示
1：显示

IsResolutionEnable

Integer

1

是否显示清晰度选择按钮。取值如下：

0：不显示
1：显示

IsSpeedControlEnable

Integer

1

是否显示倍速选择按钮。取值如下：

0：不显示
1：显示

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetActivityReplayPlayerConfig&Version=2023-08-01&ActivityId=1815****06165

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetActivityReplayPlayerConfig",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "ReplayPlayerConfig": {
            "IsResolutionEnable": 1,
            "IsSpeedControlEnable": 1,
            "IsProgressBarEnable": 1
        }
    }
}

错误码

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