# 查询默认模板防录屏设置

### 接口描述

```
1、查询防录屏默认模板设置
2、接口支持https协议
```

### 接口URL

```
http://api.polyv.net/live/v4/user/template/marquee/get
```

[在线API调用](https://git.polyv.net/help-center/document-center/-/blob/master/req.html?api=http:/api.polyv.net/live/v4/user/template/marquee/get/README.md)

### 请求方式

```
GET
```

### 接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，[详细请查看](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/limit/README.md)

### 请求参数描述

| 参数名       | 必选   | 类型     | 说明                                                                                                                                                                                                        |
| --------- | ---- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| appId     | true | String | 账号appId【详见[获取密钥](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/getSecretKey/README.md)】                                                                                        |
| sign      | true | String | 签名，为32位大写的MD5值,`生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见[签名生成规则](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/buildSign/README.md)】 |
| timestamp | true | String | 当前13位毫秒级时间戳，3分钟内有效                                                                                                                                                                                        |

### 示例

```requestUrl
http://api.polyv.net/live/v4/user/template/marquee/get?appId=frlr1zazn3&sign=87880969ED4E9887C482704832066F84&timestamp=1677166871700
```

### 响应参数描述

| 参数名       | 类型      | 说明                                       |
| --------- | ------- | ---------------------------------------- |
| code      | Integer | 状态码，与 http 状态码相同，用于确定基本的响应状态             |
| data      | Object  | 模板-跑马灯响应对象【详见[Data参数描述](#Data参数描述)】      |
| error     | Object  | 状态码非200时的错误信息【详见[Error参数描述](#Error参数描述)】 |
| requestId | String  | 请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩 |
| status    | String  | 响应结果，由业务决定，成功返回success，失败返回error         |
| success   | Boolean | 是否成功响应                                   |

### Data参数描述

| 参数名             | 类型      | 说明                                                                                     |
| --------------- | ------- | -------------------------------------------------------------------------------------- |
| enable          | String  | <p>防录屏开关<br>Y：开启<br>N：关闭</p>                                                           |
| antiRecordType  | String  | <p>防录屏方式<br>marquee：跑马灯<br>watermark：水印</p>                                            |
| modelType       | String  | <p>防录屏类型<br>fixed：固定<br>nickname：用户名<br>diyurl：url自定义设置</p>                            |
| autoZoomEnabled | String  | <p>自定义缩放开关<br>Y：开启<br>N：关闭</p>                                                         |
| content         | String  | <p>固定值时为设置内容<br>URL自定义设置时为网址</p>                                                       |
| opacity         | Integer | <p>透明度<br>跑马灯透明度，范围0-99<br>水印透明度，范围0-100</p>                                           |
| doubleEnabled   | String  | <p>双跑马灯开关<br>Y：开启<br>N：关闭</p>                                                          |
| fontColor       | String  | 跑马灯字体颜色，色值，例如：#FFFFFF                                                                  |
| fontSize        | String  | <p>字体大小<br>防录屏方式为跑马灯时：设置数值，范围1-256<br>防录屏方式为水印时：<br>small：小<br>middle：中<br>large：大</p> |
| showMode        | String  | <p>跑马灯显示方式<br>roll：滚动<br>flicker：闪烁</p>                                                |

### Error参数描述

| 参数名  | 类型      | 说明                   |
| ---- | ------- | -------------------- |
| code | Integer | 错误代码，用于确定具体的错误原因     |
| desc | String  | 错误描述，与 error.code 对应 |

### Java请求示例

快速接入基础代码请下载相关依赖源码， [点击下载源代码](https://git.polyv.net/help-center/document-center/-/blob/master/third_res/util.zip) ,下载后加入到自己的源码工程中即可。测试用例中的**HttpUtil.java 和 LiveSignUtil.java** 都包含在下载文件中。

> 强烈建议您使用[直播Java SDK](https://git.polyv.net/help-center/document-center/-/blob/master/live/java/README.md)完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

```java
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

}
```

### 响应示例

系统全局错误说明详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/errorInfo/README.md)

成功示例

```json
{
    "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
}
```

异常示例

```json
{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://polyv.gitbook.io/document/docs/live/api/v-4/user/template/get_marquee.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.