查詢使用者帳號下的虛擬演播模板。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
live:DescribeLiveAIStudio |
get |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
否 |
地區 ID。 |
cn-shanghai |
| StudioId |
string |
否 |
選擇性參數，指定篩選模板 Id |
dbe61b87-db9a-448f-8757-a875edb3f944 |
| StudioName |
string |
否 |
虛擬背景模板名稱 |
sub02 |
| PageNumber |
integer |
否 |
當前頁碼。預設值為 1。 |
1 |
| PageSize |
integer |
否 |
單頁顯示應用的數量，預設值：10。取值範圍：1~50。 |
10 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
Schema of Response |
||
| RequestId |
string |
Id of the request |
16A96B9A-F203-4EC5-8E43-CB92E68F4CD8 |
| Total |
integer |
總模板數。 |
100 |
| PageNumber |
integer |
當前頁碼。 |
1 |
| PageSize |
integer |
單頁顯示應用的數量，預設值：10。取值範圍：1~50。 |
10 |
| StudioConfigs |
object |
||
| SubtitleConfig |
array<object> |
虛擬演播廳模板資訊 |
|
|
array<object> |
虛擬演播廳模板資訊 |
||
| MediaType |
string |
多媒體素材類型：VOD,PIC,LIVE 三選一
|
VOD |
| MediaLayout |
string |
多媒體布局資訊 |
"{\"positionY\":\"0.0\",\"positionX\":\"0.0\",\"heightNormalized\":\"0.5\"}" |
| MediaResourceUrl |
string |
多媒體素材連結 url |
https://testbucket.xx.com/2.jpg |
| MediaResourceId |
string |
多媒體素材點播資源 id |
d0eb493192c771efba644531858c0102 |
| BackgroundType |
string |
背景素材類型：VOD,PIC,LIVE 三選一
|
VOD |
| BackgroundResourceUrl |
string |
背景素材外部存取地址，需要保證公網可用，與 BackgroundResourceId 二選一即可。 |
https://testbucket.xx.com/2.jpg |
| BackgroundResourceId |
string |
背景素材資源 ID。 |
d0eb493192c771efba644531858c0102 |
| Description |
string |
自訂規則描述資訊。 |
user defined description |
| TemplateId |
string |
虛擬演播模板 ID。 |
24654384-f5ac-40ea-823b-74e85a61dd9f |
| TemplateName |
string |
虛擬演播模板名稱。與 AddLiveAiStudio 中的 StudioName 參數相同 |
studio1 |
| MattingLayout |
string |
多媒體素材位置布局資訊。 |
"{\"positionY\":\"0.0\",\"positionX\":\"0.0\",\"heightNormalized\":\"0.5\"}" |
| MattingType |
string |
源流摳圖類型，對使用者推流進行摳圖處理
|
complex |
| Height |
string |
預覽畫面高度，單位：px 預覽畫面寬度 x 高度僅支援以下規格：
|
1080 |
| Width |
string |
預覽畫面寬度。 |
1920 |
| RuleIds |
object |
||
| ruleId |
array |
綁定的策略 ID 集合。 |
|
|
string |
規則 ID。 |
2414378f-541a-48d3-be0c-535212f9a6b4 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
"Total": 100,
"PageNumber": 1,
"PageSize": 10,
"StudioConfigs": {
"SubtitleConfig": [
{
"MediaType": "VOD",
"MediaLayout": "\"{\\\"positionY\\\":\\\"0.0\\\",\\\"positionX\\\":\\\"0.0\\\",\\\"heightNormalized\\\":\\\"0.5\\\"}\"",
"MediaResourceUrl": "https://testbucket.xx.com/2.jpg",
"MediaResourceId": "\t\nd0eb493192c771efba644531858c0102\n",
"BackgroundType": "VOD",
"BackgroundResourceUrl": "https://testbucket.xx.com/2.jpg",
"BackgroundResourceId": "d0eb493192c771efba644531858c0102",
"Description": "user defined description",
"TemplateId": "24654384-f5ac-40ea-823b-74e85a61dd9f",
"TemplateName": "studio1",
"MattingLayout": "\"{\\\"positionY\\\":\\\"0.0\\\",\\\"positionX\\\":\\\"0.0\\\",\\\"heightNormalized\\\":\\\"0.5\\\"}\"",
"MattingType": "complex",
"Height": "1080",
"Width": "1920",
"RuleIds": {
"ruleId": [
"2414378f-541a-48d3-be0c-535212f9a6b4"
]
}
}
]
}
}錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | LiveServiceNotFound | %s, please check and try again later. | 直播服務未開通，請檢查後重試。 |
| 400 | InvalidParameter.PurchaseTime | %s, please check and try again later. | 參數PurchaseTime無效，請檢查後重試。 |
| 400 | InvalidParameter.ExpireTime | %s, please check and try again later. | 參數ExpireTime無效，請檢查後重試。 |
| 400 | MissingParameter | %s. | 參數缺失 |
| 400 | InvalidChargeType.Malformed | %s, please check and try again later. | 參數ChargeType無效，請檢查後重試。 |
| 400 | InvalidChargeType.PostSupport | %s, please check and try again later. | ChargeType僅支援後付費，請檢查後重試。 |
| 400 | InvalidCasterTemplate.Malformed | %s, please check and try again later. | 參數CasterTemplate無效，請檢查後重試。 |
| 400 | InvalidParameter.Malformed | There are invalid parameters: %s. | 存在無效參數：%s。 |
| 400 | InvalidParameter.ChargeType | %s, please check and try again later. | 參數ChargeType無效，請檢查後重試。 |
| 400 | InvalidPeriod.Malformed | %s, please check and try again later. | 時間間隔無效，請檢查後重試。 |
| 400 | InvalidUserId.Malformed | %s, please check userId. | 傳入的userId無效，請檢查。 |
| 400 | InvalidClientToken.Malformed | %s, please check and try again later. | 參數ClientToken無效，請檢查後重試。 |
| 400 | IncorrectCasterStatus | %s, please check and try again later. | 導播台狀態有誤，請檢查後重試。 |
| 401 | CasterNumberExceed | %s, please check and try again later. | 導播台數量超限，請檢查後重試。 |
| 403 | PermissionDenied | %s, please check and try again later. | 訪問拒絕，請檢查後重試。 |
| 404 | InvalidParameter.NormType | %s, please check and try again later. | 參數NormType無效，請檢查後重試。 |
| 404 | InvalidConfiguration.NotFound | %s, please check and try again later. | 配置不存在，請檢查後重試。 |
| 408 | DescribeLiveAIStudio.Timeout | %s, please try again later. | 調用DescribeLiveAIStudio逾時，請稍後重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。