查询默认模板内容保护(防录屏)设置
更新时间:2026-01-28 18:55:12
接口描述
1、查询内容保护默认模板设置
2、接口支持https协议
接口URL
http://api.polyv.net/live/v4/user/template/marquee/get
请求方式
GET
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | true | String | 账号appId【详见获取密钥】 |
| sign | true | String | 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| timestamp | true | String | 当前13位毫秒级时间戳,3分钟内有效 |
示例
http://api.polyv.net/live/v4/user/template/marquee/get?appId=frlr1zazn3&sign=87880969ED4E9887C482704832066F84×tamp=1677166871700
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 状态码,与 http 状态码相同,用于确定基本的响应状态 |
| data | Object | 模板-跑马灯响应对象【详见Data参数描述】 |
| error | Object | 状态码非200时的错误信息【详见Error参数描述】 |
| requestId | String | 请求ID,每次请求生成的唯一的 UUID,仅可用于排查、调试,不应该和业务挂上钩 |
| status | String | 响应结果,由业务决定,成功返回success,失败返回error |
| success | Boolean | 是否成功响应 |
Data参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| enable | String | 内容保护开关 Y:开启 N:关闭 |
| antiRecordType | String | 内容保护方式 marquee:跑马灯 watermark:水印 |
| modelType | String | 内容保护类型 fixed:固定 nickname:用户名 diyurl:url自定义设置 |
| autoZoomEnabled | String | 自定义缩放开关 Y:开启 N:关闭 |
| content | String | 固定值时为设置内容 URL自定义设置时为网址 |
| opacity | Integer | 透明度 跑马灯透明度,范围0-99 水印透明度,范围0-100 |
| doubleEnabled | String | 双跑马灯开关 Y:开启 N:关闭 |
| fontColor | String | 跑马灯字体颜色,色值,例如:#FFFFFF |
| fontSize | String | 字体大小 内容保护方式为跑马灯时:设置数值,范围1-256 内容保护方式为水印时: small:小 middle:中 large:大 |
| showMode | String | 跑马灯显示方式 roll:滚动 flicker:闪烁 |
Error参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 错误代码,用于确定具体的错误原因 |
| desc | String | 错误描述,与 error.code 对应 |
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。
强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
private static final Logger log = LoggerFactory.getLogger(getClass());
/**
* 查询内容保护默认模板设置
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void getMarqueeTemplateTest() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId = super.appId;
String appSecret = super.appSecret;
String timestamp = String.valueOf(System.currentTimeMillis());
//业务参数
String url = "http://api.polyv.net/live/v4/user/template/marquee/get";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("测试查询内容保护默认模板设置成功:{}", response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"requestId": "a5e9b1d15f544d7a9db6f038156a851d.73.16771668735691381",
"data": {
"enable": "Y",
"antiRecordType": "marquee",
"modelType": "fixed",
"content": "测试跑马灯内容",
"fontSize": "20",
"fontColor": "#ff4d4f",
"opacity": 80,
"showMode": "flicker",
"doubleEnabled": "N",
"autoZoomEnabled": "Y"
},
"success": true
}
异常示例
{
"code": 400,
"status": "error",
"requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
"error": {
"code": 20001,
"desc": "application not found."
},
"success": false
}
