調用AddCasterVideoResource為導播台添加視頻資源-ApsaraVideo for Live-阿里雲

添加視頻源，視頻源數量受限於導播台輸入路數。

介面說明

請先建立導播台，再調用本介面添加導播台視頻源。視頻源數量受限於導播台輸入路數。使用 API 建立導播台，請參見建立導播台。

QPS 限制

本介面的單使用者 QPS 限制為 10 次/秒。超過限制，API 呼叫會被限流，這可能會影響您的業務，請合理調用。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

live:AddCasterVideoResource

create

*Caster

acs:live:*:{#accountId}:caster/{#CasterId}

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	否	地區 ID。	cn-shanghai
CasterId	string	是	導播台 ID。如果您通過 CreateCaster 介面建立導播台，請查看 CreateCaster 介面調用返回的參數 CasterId 值。如果您通過直播控制台建立導播台，請通過直播控制台 > 導播台 > 雲導播台路徑查看導播台名稱。說明直播控制台雲導播台頁面導播台列表中的導播台名稱即導播台 ID。	LIVEPRODUCER_POST-cn-0pp1czt****
ResourceName	string	是	視頻源名稱。	test001
LocationId	string	否	用於標識視頻源位置。本參數必填。定義布局內畫面的引用編號，每個位置至多關聯一個資源，格式需符合“RV01~RV12”，即 RV+數字，數字範圍`[01~99]`。	RV01
LiveStreamUrl	string	否	阿里雲直播流地址。重要當視頻源類型為直播流時，本參數必填。視頻源類型不是直播流時，請求時不要帶這個參數。	rtmp://guide.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201**?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5**
MaterialId	string	否	媒資庫素材 ID。重要當視頻源類型為素材時，本參數才可用且必須傳入。如果您通過 DescribeCasterConfig 介面查詢導播台配置資訊，請查看 DescribeCasterConfig 介面調用返回的參數 UrgentMaterialId 值。說明 UrgentMaterialId 值即為媒資庫素材 ID 值。	f080575eb5f4427684fc0715159a****
VodUrl	string	否	點播檔案地址。重要當視頻源類型為檔案視頻且視頻檔案未匯入素材庫時，本參數才可用。說明點播檔案僅限 MP4、FLV、TS 格式。	http://learn.aliyundoc.com/AppName/StreamName.flv
BeginOffset	integer	否	視頻檔案起始位移值。單位：毫秒。重要當視頻源類型為檔案視頻時，本參數才有用。說明大於 0，表示從相對於首幀的偏差時間作為開始讀取的位置。	1000
EndOffset	integer	否	視頻檔案結束位移值。單位：毫秒。重要當視頻源類型為檔案視頻時，本參數才有用。大於 0 時：從相對於首幀的偏差時間為結束讀取的位置。小於 0 時：相對於最後一幀的偏差時間作為結束讀取的位置。	10000
RepeatNum	integer	否	播放完後重複繼續播放的次數。取值：重要當視頻源類型為檔案視頻時，本參數才有用。 0（預設值）：不重複播放。 -1：一直迴圈重複。	0
PtsCallbackInterval	integer	否	PTS 回調間隔。單位：毫秒。	2000
FixedDelayDuration	integer	否	該欄位對視頻進行固定延遲設定，可用於字幕同步。單位 ms, 預設取值為 0，取值範圍`[0-5000]`。	0
ImageId	string	否	媒資庫圖片素材 ID。說明當視頻源類型為圖片時，本參數才可用且必須傳入。	a089175eb5f4427684fc0715159a****
ImageUrl	string	否	圖片素材 URL。說明當視頻源類型為圖片且圖片檔案未匯入素材庫時，本參數才可用。支援上傳 jpg、png 格式圖片，最大檔案不可超過 10M。	http://learn.aliyundoc.com/AppName/image.jpg

說明

視頻源類型是根據直播流地址裡的資源類型判斷的。

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	CF60DB6A-7FD6-426E-9288-122CC1A52FA7
ResourceId	string	資源 ID。可作為刪除導播台視頻源，修改導播台視頻源的請求參數。	e5542d98-b08c-46bf-83e9-5b09d08c****

樣本

正常返回樣本

JSON格式

{
  "RequestId": "CF60DB6A-7FD6-426E-9288-122CC1A52FA7",
  "ResourceId": "e5542d98-b08c-46bf-83e9-5b09d08c****"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidCasterId.Malformed	%s, please check and try again later.	參數CasterId無效，請檢查後重試。
400	InvalidParameter.Malformed	There are invalid parameters: %s.	存在無效參數：%s。
400	InvalidUserId.Malformed	%s, please check userId.	傳入的userId無效，請檢查。
400	InvalidLiveStreamUrl.Malformed	%s, please check and try again later.	參數LiveStreamUrl無效，請檢查後重試。
400	InvalidMaterialId.Malformed	%s, please check and try again later.	參數MaterialId無效，請檢查後重試。
400	InvalidVodUrl.Malformed	%s, please check and try again later.	參數VodUrl無效，請檢查後重試。
400	ResourceNumberExceed	%s, please check and try again later.	資源數量超限，請檢查後重試。
400	MissingParameter	%s.	參數缺失
400	DuplicateLocationID	%s, please check and try again later.	參數LocationID重複，請檢查後重試。
400	UnexpectedLocationID	%s, please check and try again later.	LocationId無效，請檢查後重試。
401	IllegalOperation	%s, please check and try again later.	不允許的操作，請檢查後重試。
500	InternalError	%s, please try again later.	內部錯誤，請稍後重試。
404	InvalidCaster.NotFound	%s, please check and try again later.	導播台不存在，請檢查後重試。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。