保利威文档中心

幫助中心

channelAdvanced

更新時間:2025-09-11 15:18:09

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. ]

請求入參描述

參數名 必選 類型 說明
channelId true String 頻道號
appId false String POLYV使用者APP_ID,多帳號呼叫時該參數必填(即呼叫了initMultiAccount()設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定)
appSecret false String POLYV使用者APP_SECRET,多帳號呼叫時該參數必填(即呼叫了initMultiAccount()設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定)

回傳物件描述

參數名 類型 說明
realTimeSubtitleEnabled String 即時字幕開關,Y:開啟,N:關閉
sourceLanguage String 原聲字幕語種,Chinese:中文;English:英文
subtitleTranslationEnabled String 字幕翻譯開關,Y:開啟,N:關閉
translationLanguage String 字幕翻譯語種,Chinese:中文;English:英文 等,可透過 new LiveChannelAdvancedServiceImpl().getLanguage() 查詢對照
realTimeSubtitleDisplayNumberLimitEnabled String 即時字幕顯示數量限制開關,Y:開啟,N:關閉
realTimeSubtitleDisplayNumber Integer 即時字幕最多顯示數量






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. ]

請求入參描述

參數名 必選 類型 說明
channelId true String 頻道號
realTimeSubtitleEnabled false String 即時字幕開關,Y:開啟,N:關閉
sourceLanguage false String 原聲字幕語種,Chinese:中文;English:英文
subtitleTranslationEnabled false String 字幕翻譯開關,Y:開啟,N:關閉
translationLanguage false String 字幕翻譯語種,Chinese:中文;English:英文 等,可透過 new LiveChannelAdvancedServiceImpl().getLanguage() 查詢
realTimeSubtitleDisplayNumberLimitEnabled false String 即時字幕顯示數量限制開關,Y:開啟,N:關閉
realTimeSubtitleDisplayNumber false Integer 即時字幕最多顯示數量,不能小於5,不能大於20,建議傳 5、10或20
appId false String POLYV使用者APP_ID,多帳號呼叫時該參數必填(即呼叫了initMultiAccount()設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定)
appSecret false String POLYV使用者APP_SECRET,多帳號呼叫時該參數必填(即呼叫了initMultiAccount()設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定)

回傳物件描述

修改頻道字幕配置資訊回傳實體




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. ]

請求入參描述

參數名 必選 類型 說明
appId false String POLYV使用者APP_ID,多帳號呼叫時該參數必填(即呼叫了initMultiAccount()設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定)
appSecret false String POLYV使用者APP_SECRET,多帳號呼叫時該參數必填(即呼叫了initMultiAccount()設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定)

回傳物件描述

回傳物件是List<LiveChannelRealtimeSubtitleLanguageResponse>,LiveChannelRealtimeSubtitleLanguageResponse具體元素內容如下:

參數名 類型 說明
code String 語言編碼,如:Chinese
text String 語言編碼對應語言中文描述,如:中文

联系客服,在线咨询