You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /企业直播/API 参考/点播播放器/获取点播播放器配置信息
获取点播播放器配置信息
最近更新时间：2024.06.25 12:10:43首次发布时间：2024.04.28 14:37:34
我的收藏

您可通过此接口获取指定点播播放器的播放速度、跑马灯及全屏水印等配置内容。

注意事项

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

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是GetVodPlayerConfig接口名称。当前 API 的名称为 GetVodPlayerConfig。
VersionString是2023-08-01接口版本。当前 API 的版本为 2023-08-01。
VodPlayerConfigIdString是vcid-1795893347583626点播播放器 ID。您可以通过 ListVodPlayerConfig 接口查询 ID。

返回参数

参数类型示例值描述
VodPlayerConfigObject of VodPlayerConfig-点播播放器配置信息。

VodPlayerConfig

参数类型示例值描述
ZoomConfigObject of ZoomConfig-画面缩放配置信息。
SpeedConfigObject of SpeedConfig-倍速挡位配置信息。
TickerConfigObject of TickerConfig-跑马灯配置信息。
WatermarkConfigObject of WatermarkConfig-全屏水印配置信息。
BasicConfigObject of BasicConfig-基础配置信息。

VodPlayerConfigId

String

vcid-1795893347583626

点播播放器 ID。

说明

取值为 vcid-default 时，表示查询的点播播放器不存在。

IsDefaultVodPlayerConfig

Integer

1

是否为默认点播播放器。支持以下取值：

  • 0：否
  • 1：是
LogoConfigObject of LogoConfig-Logo 相关配置。

ZoomConfig

参数类型示例值描述

ZoomMode

Integer

1

画面缩放模式。支持以下取值：

  • 1：等比适配，即保持视频原有宽高比例填充点播播放器，视频的宽高会填满点播播放器的宽高。如果视频宽高比与点播播放器宽高比不同，视频会缩放显示。推荐在 PC 和手机横屏模式时使用该设置。
  • 2：等比填满，即保持视频原有宽高比例填充点播播放器，视频的宽高会填满点播播放器的宽高。如果视频宽高比与点播播放器宽高比不同，会有部分视频内容被裁剪掉。推荐在手机竖屏模式时使用该设置。
  • 3：拉伸填满，即视频内容完全填充点播播放器，但视频宽高比可能发生变化。

SpeedConfig

参数类型示例值描述
SpeedOptionString0.25,1.0,1.5,2.5倍速档位。观众仅可在您设置的范围内切换倍速。

TickerConfig

参数类型示例值描述
ContentString跑马灯内容跑马灯内容。

DisplayType

Integer

1

跑马灯的显示方式。支持以下取值：

  • 1：滚动，即在点播播放器内以碰撞反弹方式展示。
  • 2：闪烁，即在点播播放器内随机出现和消失。
FontColorString#ffffff跑马灯颜色。遵循 RGB 色彩模型。

FontSize

Integer

24

跑马灯字体的大小。支持以下取值：

  • 12
  • 16
  • 20
  • 24
  • 28
  • 32
  • 36
OpacityInteger10跑马灯字体的不透明度。

TickerSpeed

String

Moderate

跑马灯在点播播放器内滚动或闪烁的速度。支持以下取值：

  • Moderate：适中
  • Fast：较快
  • Slow：较慢

IsPlayPageTickerEnable

Integer

1

是否开启跑马灯功能。支持以下取值：

  • 0：关闭
  • 1：开启

WatermarkConfig

参数类型示例值描述
AngleInteger15水印的倾斜角度。取值范围为 [-90,90]。例如 Angle 取值为 15，表示向右上方倾斜 15 度；Angle 取值为 -15，表示向右下方倾斜 15 度。
ContentString水印内容全屏水印内容。
FontColorString#737A87水印字体的颜色。遵循 RGB 色彩模型。

FontSize

Integer

24

水印字体的大小。支持以下取值：

  • 12
  • 16
  • 20
  • 24
  • 28
  • 32
  • 36
OpacityInteger10水印字体的不透明度。

IsPlayPageWatermarkEnable

Integer

1

是否开启全屏水印功能。支持以下取值：

  • 0：关闭
  • 1：开启

BasicConfig

参数类型示例值描述
VodPlayerNameString播放器名称点播播放器名称。
BtnColorString#ffffff点播播放器内进度条、按钮、文字等控件的颜色。遵循 RGB 色彩模型。

LogoConfig

参数类型示例值描述

IsLogoEnable

Integer

1

是否开启 Logo 设置。支持以下取值：

  • 0：关闭
  • 1：开启

LogoPosition

Integer

1

图片在观看页的展示位置。支持以下取值：

  • 0：右上
  • 1：左上
  • 2：左下
  • 3：右下
LogoUrlStringhttp://example.comLogo 图片。

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetVodPlayerConfig&Version=2023-08-01&VodPlayerConfigId=vcid-1795893347583626

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "GetVodPlayerConfig",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1712067132
    },
    "Result": {
        "VodPlayerConfig": {
            "ZoomConfig": {
                "ZoomMode": 1
            },
            "SpeedConfig": {
                "SpeedOption": "0.25,1.0,1.5,2.5"
            },
            "TickerConfig": {
                "Content": "跑马灯内容",
                "DisplayType": 1,
                "FontColor": "#ffffff",
                "FontSize": 24,
                "Opacity": 10,
                "TickerSpeed": "Moderate",
                "IsPlayPageTickerEnable": 1
            },
            "WatermarkConfig": {
                "Angle": 15,
                "Content": "水印内容",
                "FontColor": "#737A87",
                "FontSize": 24,
                "Opacity": 10,
                "IsPlayPageWatermarkEnable": 1
            },
            "BasicConfig": {
                "VodPlayerName": "播放器名称",
                "BtnColor": "#ffffff"
            },
            "VodPlayerConfigId": "vcid-1795893347583626",
            "IsDefaultVodPlayerConfig": 1,
            "LogoConfig": {
                "IsLogoEnable": 1,
                "LogoPosition": 1,
                "LogoUrl": "http://example.com"
            }
        }
    }
}

错误码

下表提供了该接口特有的错误码，公共错误码请参见公共错误码和错误码文档。

状态码错误码错误信息说明
400InvalidParameter.InvalidAccountIdThe specified parameter AccountId is invalid.当前账号的鉴权信息错误。