查询默认模板防录屏设置

接口描述

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

接口URL

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

请求方式

GET

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，

请求参数描述

参数名

必选

类型

说明

appId

true

String

sign

true

String

timestamp

true

String

当前13位毫秒级时间戳，3分钟内有效

示例

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

响应参数描述

参数名

类型

说明

code

Integer

状态码，与 http 状态码相同，用于确定基本的响应状态

data

Object

error

Object

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请求示例

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
}

Previous查询默认模板音频审核 Next查询默认模板回放设置

Last updated 5 months ago

Was this helpful?

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 }