查询默认模板回放设置

接口描述

1、查询回放默认模板设置
2、接口支持https协议

接口URL

http://api.polyv.net/live/v4/user/template/playback-setting/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/playback-setting/get?appId=frlr1zazn3&sign=82ADECF49C78E5F6399D99A6EDE4EEAD&timestamp=1677167039930

响应参数描述

参数名

类型

说明

code

Integer

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

data

Object

error

Object

requestId

String

请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩

status

String

响应结果，由业务决定，成功返回success，失败返回error

success

Boolean

是否成功响应

Data参数描述

参数名

类型

说明

playbackEnabled

String

回放开关 Y：开启 N：关闭

type

String

观看页回放方式 single：单个视频 list：列表回放

origin

String

回放视频来源 record：暂存 playback：回放列表 vod：点播列表

sectionEnabled

String

章节开关 Y：开启 N：关闭

chatPlaybackEnabled

String

聊天回放开关 Y：开启 N：关闭

playbackMultiplierEnabled

String

倍数播放开关 Y：开启 N：关闭

playbackProgressBarEnabled

String

进度条开关 Y：开启 N：关闭

playbackProgressBarOperationType

String

进度条操作方式 drag 拖动,prohibitDrag 禁止拖动,dragHistoryOnly 只能拖动已观看内容

showPlayButtonEnabled

String

显示播放按钮开关 Y：开启 N：关闭

Error参数描述

参数名

类型

说明

code

Integer

错误代码，用于确定具体的错误原因

desc

String

错误描述，与 error.code 对应

Java请求示例

private static final Logger log = LoggerFactory.getLogger(getClass());
/**
* 查询回放默认模板设置
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void getPlaybackSettingTest() 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/playback-setting/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": "62420aef40254ac2b8b13a9a0895d285.75.16771670417921429",
    "data": {
        "playbackEnabled": "Y",
        "sectionEnabled": "N",
        "type": "single",
        "origin": "record",
        "chatPlaybackEnabled": "Y",
        "playbackMultiplierEnabled": "Y",
        "playbackProgressBarEnabled": "N",
        "playbackProgressBarOperationType": "drag",
        "showPlayButtonEnabled": "N"
    },
    "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 getPlaybackSettingTest() 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/playback-setting/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": "62420aef40254ac2b8b13a9a0895d285.75.16771670417921429", "data": { "playbackEnabled": "Y", "sectionEnabled": "N", "type": "single", "origin": "record", "chatPlaybackEnabled": "Y", "playbackMultiplierEnabled": "Y", "playbackProgressBarEnabled": "N", "playbackProgressBarOperationType": "drag", "showPlayButtonEnabled": "N" }, "success": true }

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