channelAdvanced

1、查询频道字幕配置信息

描述

查询频道字幕配置信息
接口地址（仅做说明使用）：https://api.polyv.net/live/v4/channel/subtitle/config/get

调用约束

1、接口调用有频率限制，详细请查看，调用常见异常，详细请查看

单元测试

    @Test
    public void testGetLiveChannelRealtimeSubtitle() throws IOException, NoSuchAlgorithmException {
        LiveChannelRealtimeSubtitleRequest liveChannelRealtimeSubtitleRequest =
                new LiveChannelRealtimeSubtitleRequest();
        LiveChannelRealtimeSubtitleResponse liveChannelRealtimeSubtitleResponse;
        try {
            liveChannelRealtimeSubtitleRequest.setChannelId(super.getAloneChannelId());
            liveChannelRealtimeSubtitleResponse = new LiveChannelAdvancedServiceImpl().getConfig(
                    liveChannelRealtimeSubtitleRequest);
            Assert.assertNotNull(liveChannelRealtimeSubtitleResponse);
            if (liveChannelRealtimeSubtitleResponse != null) {
                //to do something ......
                log.debug("测试查询频道字幕配置信息成功 {}", JSON.toJSONString(liveChannelRealtimeSubtitleResponse));
            }
        } catch (PloyvSdkException e) {
            //参数校验不合格 或者 请求服务器端500错误，错误信息见PloyvSdkException.getMessage()
            log.error(e.getMessage(), e);
            // 异常返回做B端异常的业务逻辑，记录log 或者 上报到ETL 或者回滚事务
            throw e;
        } catch (Exception e) {
            log.error("SDK调用异常", e);
            throw e;
        }
    }

单元测试说明

1、请求正确，返回LiveChannelRealtimeSubtitleResponse对象，B端依据此对象处理业务逻辑；

2、请求参数校验不合格，抛出PloyvSdkException，错误信息见PloyvSdkException.getMessage()，如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败，失败字段 [pic不能为空 / msg不能为空] ]

3、服务器处理异常，抛出PloyvSdkException，错误信息见PloyvSdkException.getMessage()，如 [ 保利威请求返回数据错误，请求流水号：66e7ad29fd04425a84c2b2b562d2025b，错误原因： invalid signature. ]

请求入参描述

返回对象描述

2、修改频道字幕配置信息

描述

修改频道字幕配置信息
接口地址（仅做说明使用）：https://api.polyv.net/live/v4/channel/subtitle/config/update

调用约束

1、接口调用有频率限制，详细请查看，调用常见异常，详细请查看

单元测试

    @Test
    public void testLiveUpdateChannelRealtimeSubtitle() throws IOException, NoSuchAlgorithmException {
        LiveUpdateChannelRealtimeSubtitleRequest liveUpdateChannelRealtimeSubtitleRequest =
                new LiveUpdateChannelRealtimeSubtitleRequest();
        Boolean liveUpdateChannelRealtimeSubtitleResponse;
        try {
            liveUpdateChannelRealtimeSubtitleRequest.setChannelId(super.getAloneChannelId())
                    .setRealTimeSubtitleEnabled("Y")
                    .setSubtitleTranslationEnabled("Y")
                    .setSourceLanguage("Chinese")
                    .setTranslationLanguage("English")
                    .setRealTimeSubtitleDisplayNumber(20);
            liveUpdateChannelRealtimeSubtitleResponse = new LiveChannelAdvancedServiceImpl().updateConfig(
                    liveUpdateChannelRealtimeSubtitleRequest);
            Assert.assertNotNull(liveUpdateChannelRealtimeSubtitleResponse);
            if (liveUpdateChannelRealtimeSubtitleResponse != null) {
                //to do something ......
                log.debug("测试修改频道字幕配置信息成功 {}", liveUpdateChannelRealtimeSubtitleResponse);
            }
        } catch (PloyvSdkException e) {
            //参数校验不合格 或者 请求服务器端500错误，错误信息见PloyvSdkException.getMessage()
            log.error(e.getMessage(), e);
            // 异常返回做B端异常的业务逻辑，记录log 或者 上报到ETL 或者回滚事务
            throw e;
        } catch (Exception e) {
            log.error("SDK调用异常", e);
            throw e;
        }
    }

单元测试说明

1、请求正确，返回Boolean对象，B端依据此对象处理业务逻辑；

2、请求参数校验不合格，抛出PloyvSdkException，错误信息见PloyvSdkException.getMessage()，如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败，失败字段 [pic不能为空 / msg不能为空] ]

3、服务器处理异常，抛出PloyvSdkException，错误信息见PloyvSdkException.getMessage()，如 [ 保利威请求返回数据错误，请求流水号：66e7ad29fd04425a84c2b2b562d2025b，错误原因： invalid signature. ]

请求入参描述

返回对象描述

修改频道字幕配置信息返回实体

3、查询实时字幕语言类型枚举

描述

查询实时字幕语言类型枚举
接口地址（仅做说明使用）：https://api.polyv.net/live//v4/channel/subtitle/language/list-all

调用约束

1、接口调用有频率限制，详细请查看，调用常见异常，详细请查看

单元测试

    @Test
    public void testGetLiveChannelRealtimeSubtitleLanguage() throws IOException, NoSuchAlgorithmException {
        LiveChannelRealtimeSubtitleLanguageRequest liveChannelRealtimeSubtitleRequest =
                new LiveChannelRealtimeSubtitleLanguageRequest();
        List<LiveChannelRealtimeSubtitleLanguageResponse> liveChannelRealtimeSubtitleLanguageResponse;
        try {
            liveChannelRealtimeSubtitleLanguageResponse = new LiveChannelAdvancedServiceImpl().getLanguage(
                    liveChannelRealtimeSubtitleRequest);
            Assert.assertNotNull(liveChannelRealtimeSubtitleLanguageResponse);
            if (liveChannelRealtimeSubtitleLanguageResponse != null) {
                //to do something ......
                log.debug("查询实时字幕语言类型枚举 {}", JSON.toJSONString(liveChannelRealtimeSubtitleLanguageResponse));
            }
        } catch (PloyvSdkException e) {
            //参数校验不合格 或者 请求服务器端500错误，错误信息见PloyvSdkException.getMessage()
            log.error(e.getMessage(), e);
            // 异常返回做B端异常的业务逻辑，记录log 或者 上报到ETL 或者回滚事务
            throw e;
        } catch (Exception e) {
            log.error("SDK调用异常", e);
            throw e;
        }
    }
}

单元测试说明

1、请求正确，返回LiveChannelRealtimeSubtitleLanguageResponse对象，B端依据此对象处理业务逻辑；

2、请求参数校验不合格，抛出PloyvSdkException，错误信息见PloyvSdkException.getMessage()，如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败，失败字段 [pic不能为空 / msg不能为空] ]

3、服务器处理异常，抛出PloyvSdkException，错误信息见PloyvSdkException.getMessage()，如 [ 保利威请求返回数据错误，请求流水号：66e7ad29fd04425a84c2b2b562d2025b，错误原因： invalid signature. ]

请求入参描述

返回对象描述

返回对象是List<LiveChannelRealtimeSubtitleLanguageResponse>，LiveChannelRealtimeSubtitleLanguageResponse具体元素内容如下：