本文介紹ApsaraVideo for Live服務端Java SDK的使用方法和範例程式碼。
前提條件
建立RAM使用者並授權。訪問ApsaraVideo for LiveAPI需要RAM使用者擁有對應的許可權,具體授權操作可參見建立RAM使用者並授權。
已擷取存取金鑰(AccessKey)。服務端介面通過存取金鑰進行身分識別驗證,為RAM使用者產生存取金鑰請參見建立AccessKey。
已完成Java 環境配置,需要Java 1.6及以上版本。
使用SDK
安裝
此處以Maven安裝方式進行舉例,在專案pom.xml檔案中引入SDK:
<!-- 阿里雲核心SDK -->
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>aliyun-java-sdk-core</artifactId>
<version>4.6.1</version>
</dependency>
<!-- ApsaraVideo for LiveSDK -->
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>aliyun-java-sdk-live</artifactId>
<version>3.9.59</version>
</dependency>
使用
以下範例程式碼實現了使用SDK查詢直播截圖配置的功能。
import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.IAcsClient;
import com.aliyuncs.exceptions.ClientException;
import com.aliyuncs.live.model.v20161101.DescribeLiveSnapshotConfigRequest;
import com.aliyuncs.live.model.v20161101.DescribeLiveSnapshotConfigResponse;
import com.aliyuncs.profile.DefaultProfile;
public class SdkUseDemo {
public static void main(String[] args) {
DefaultProfile profile = DefaultProfile.getProfile("<regionId>", "<ALIBABA_CLOUD_ACCESS_KEY_ID>", "<ALIBABA_CLOUD_ACCESS_KEY_SECRET>");
IAcsClient client = new DefaultAcsClient(profile);
DescribeLiveSnapshotConfigRequest describeLiveStreamSnapshotInfoRequest=new DescribeLiveSnapshotConfigRequest();
describeLiveStreamSnapshotInfoRequest.setDomainName("<DomainName>");
DescribeLiveSnapshotConfigResponse describeLiveSnapshotConfigResponse = null;
try {
describeLiveSnapshotConfigResponse = client.getAcsResponse(describeLiveStreamSnapshotInfoRequest);
} catch (ClientException e) {
e.printStackTrace();
}
}
}
您可以使用該範例程式碼進行測試,測試時需將“<>”內容替換成實際使用的值。
<regionId>為地區ID,地區ID擷取可參見服務存取點。
<ALIBABA_CLOUD_ACCESS_KEY_ID>與<ALIBABA_CLOUD_ACCESS_KEY_SECRET>為存取金鑰,如果您還未擁有存取金鑰,請參見本文檔前提條件相關內容。
DescribeLiveSnapshotConfigRequest為查詢截圖配置對應請求類。
DescribeLiveSnapshotConfigResponse為查詢截圖配置對應響應類。
請求參數以及響應內容說明可參見APIDescribeLiveSnapshotConfig - 查詢網域名稱下的截圖配置。
調用API有QPS限制,關於API的QPS限制說明請參見流控資訊。
在以上樣本中DescribeLiveSnapshotConfigResponse為還原序列化後的響應對象,某些時候您可能需要直接擷取響應結果HttpResponse,不需要進行還原序列化,在此情況下只需更換調用方法即可。
HttpResponse httpResponse=client.doAction(describeLiveStreamSnapshotInfoRequest);
int status=httpResponse.getStatus();
使用說明:
當HTTP status大於等於200且小於300時,表示API調用成功。
當HTTP status大於等於300且小於500時,服務端SDK會提示ClientException,表示用戶端錯誤。
當HTTP status大於等於500時,服務端SDK會提示ServerException,表示伺服器端錯誤。
client.getAcsResponse與client.doAction兩個方法都可以使用,您可以根據您業務的實際情況採用。
建議您將存取金鑰儲存至設定檔,在使用時進行讀取。如果您的專案基於SpringBoot搭建,可參考以下範例程式碼:
# 用戶端請求的ak、sk,就是應用的密鑰資訊
live.accessKeyId=<yourAccessKeyId>
live.accessKeySecret=<yourAccessKeySecret>
@Value("${live.accessKeyId}")
private String accessKeyId;
@Value("${live.accessKeySecret}")
private String accessKeySecret;
在使用ApsaraVideo for LiveSDK時遵循API
加Request
為API請求類,API
加Response
為API響應類。
此處列舉幾個常用API。
API | 請求類 | 響應類 |
DescribeLiveSnapshotConfig | DescribeLiveSnapshotConfig | |
AddLiveAppRecordConfig | AddLiveAppRecordConfig | |
DescribeLiveRecordConfig | DescribeLiveRecordConfig | |
AddLiveStreamTranscode | AddLiveStreamTranscode | |
DescribeLiveStreamTranscodeInfo | DescribeLiveStreamTranscodeInfo | |
BatchSetLiveDomainConfigs | BatchSetLiveDomainConfigs | |
DescribeLiveDomainConfigs | DescribeLiveDomainConfigs | |
更多API可參見API概覽。 |
資源控制
在您查看API的過程中,可能已留意到API有關授權資訊的說明,比如在AddLiveAppSnapshotConfig - 添加直播截圖配置API中,有以下關於授權資訊的內容。
在為RAM使用者授權的過程中,您已為RAM使用者授予了API的存取權限。但有些時候您可能需要更細的許可權控制,比如調用同一個API,RAM使用者A只能操作DomainA網域名稱,RAM使用者B只能操作DomainB網域名稱。如果您有這樣的業務需求就可以通過資源控制進行實現,實現資源控制授權可參考文檔自訂授權。
各API支援的資源控制說明請參見API授權資訊總覽。