最近更新时间：2024.04.28 14:37:34
首次发布时间：2024.04.28 14:37:34
通过本接口，您可以获取指定点播播放器的播放速度、跑马灯及全屏水印等配置内容。
请求频率：单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | GetVodPlayerConfig | 接口名称。当前 API 的名称为 GetVodPlayerConfig。 |
| Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01。 |
| VodPlayerConfigId | String | 是 | vcid-1795893347583626 | 点播播放器 ID。您可以通过 ListVodPlayerConfig 接口查询 ID。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| VodPlayerConfig | Object of VodPlayerConfig | - | 点播播放器配置信息。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| ZoomConfig | Object of ZoomConfig | - | 画面缩放配置信息。 |
| SpeedConfig | Object of SpeedConfig | - | 倍速挡位配置信息。 |
| TickerConfig | Object of TickerConfig | - | 跑马灯配置信息。 |
| WatermarkConfig | Object of WatermarkConfig | - | 全屏水印配置信息。 |
| BasicConfig | Object of BasicConfig | - | 基础配置信息。 |
VodPlayerConfigId | String |
| 点播播放器 ID。 说明 取值为 |
IsDefaultVodPlayerConfig | Integer |
| 是否为默认点播播放器。支持以下取值：
|
| LogoConfig | Object of LogoConfig | Logo 相关配置。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
ZoomMode | Integer |
| 画面缩放模式。支持以下取值：
|
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| SpeedOption | String | 0.25,1.0,1.5,2.5 | 倍速档位。观众仅可在您设置的范围内切换倍速。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Content | String | 跑马灯内容 | 跑马灯内容。 |
DisplayType | Integer |
| 跑马灯的显示方式。支持以下取值：
|
| FontColor | String | #ffffff | 跑马灯颜色。遵循 RGB 色彩模型。 |
FontSize | Integer |
| 跑马灯字体的大小。支持以下取值：
|
| Opacity | Integer | 10 | 跑马灯字体的不透明度。 |
TickerSpeed | String |
| 跑马灯在点播播放器内滚动或闪烁的速度。支持以下取值：
|
IsPlayPageTickerEnable | Integer |
| 是否开启跑马灯功能。支持以下取值：
|
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Angle | Integer | 15 | 水印的倾斜角度。取值范围为 [-90,90]。例如 Angle 取值为 15，表示向右上方倾斜 15 度；Angle 取值为 -15，表示向右下方倾斜 15 度。 |
| Content | String | 水印内容 | 全屏水印内容。 |
| FontColor | String | #737A87 | 水印字体的颜色。遵循 RGB 色彩模型。 |
FontSize | Integer |
| 水印字体的大小。支持以下取值：
|
| Opacity | Integer | 10 | 水印字体的不透明度。 |
IsPlayPageWatermarkEnable | Integer |
| 是否开启全屏水印功能。支持以下取值：
|
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| VodPlayerName | String | 播放器名称 | 点播播放器名称。 |
| BtnColor | String | #ffffff | 点播播放器内进度条、按钮、文字等控件的颜色。遵循 RGB 色彩模型。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
IsLogoEnable | Integer | 是否开启 Logo 设置。支持以下取值：
| |
LogoPosition | Integer | 图片在观看页的展示位置。支持以下取值：
| |
| LogoUrl | String | Logo 图片。 |
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" } } } }
下表提供了该接口特有的错误码，公共错误码请参见公共错误码和错误码文档。
| 状态码 | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
| 400 | InvalidParameter.InvalidAccountId | The specified parameter AccountId is invalid. | 当前账号的鉴权信息错误。 |