調(diào)用AddCasterLayout添加導(dǎo)播臺布局。

使用說明

先創(chuàng)建導(dǎo)播臺和添加導(dǎo)播臺視頻資源，再調(diào)用本接口添加導(dǎo)播臺布局。使用API創(chuàng)建導(dǎo)播臺，請參見創(chuàng)建導(dǎo)播臺。

QPS限制

本接口的單用戶QPS限制為10次/秒。超過限制，API調(diào)用會被限流，這可能會影響您的業(yè)務(wù)，請合理調(diào)用。更多信息，請參見QPS限制。

調(diào)試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數(shù)

名稱 類型 是否必選 示例值 描述
Action String 是 AddCasterLayout

系統(tǒng)規(guī)定參數(shù)。取值：AddCasterLayout。

BlendList.N RepeatList 是 RV01

元素為視頻資源的位置ID，即LocationId。

LocationId參見添加視頻源，與VideoLayers元素順序?qū)?yīng)。

CasterId String 是 LIVEPRODUCER_POST-cn-0pp1czt****

導(dǎo)播臺ID。

  • 如果您通過CreateCaster接口創(chuàng)建導(dǎo)播臺，請查看CreateCaster接口調(diào)用返回的參數(shù)CasterId值。
  • 如果您通過直播控制臺創(chuàng)建導(dǎo)播臺，請通過直播控制臺 > 導(dǎo)播臺 > 云導(dǎo)播臺路徑查看導(dǎo)播臺名稱。
說明 直播控制臺云導(dǎo)播臺頁面導(dǎo)播臺列表中的導(dǎo)播臺名稱即導(dǎo)播臺ID。
MixList.N RepeatList 是 RV01

元素為音頻資源的位置ID，即LocationId。

LocationId參見添加視頻源，與AudioLayers元素順序?qū)?yīng)。

RegionId String 否 cn-shanghai

地域ID。
VideoLayer.N.FillMode String 否 fit

元素填充方式。 取值：

  • none（默認(rèn)）：不填充。以畫面作為配置目標(biāo)進(jìn)行設(shè)置。
  • fit：自適應(yīng)，以填充區(qū)（框）作為配置目標(biāo)進(jìn)行設(shè)置，此時畫面會按照原始的寬高比縮放，長邊對齊的自適應(yīng)方式在填充區(qū)（框）內(nèi)居中填充。若填充區(qū)寬高比和畫面不一致，則短邊兩側(cè)無填充（顯示為下層元素畫面，若下層未配置，默認(rèn)為底圖黑色）。
VideoLayer.N.HeightNormalized Float 否 1

元素的高度歸一化比例值。

  • 若采用不填充方式，元素的寬度會按照該高度來進(jìn)行等比縮放。默認(rèn)值為0，表示按照畫面的原始尺寸進(jìn)行顯示。
  • 若采用自適應(yīng)方式，該字段必傳且大于0，表示填充區(qū)（框）高度歸一化比例值。
VideoLayer.N.WidthNormalized Float 否 1

元素的寬度歸一化比例值。

  • 若采用不填充方式，元素的高度會按照該寬度來進(jìn)行等比縮放，默認(rèn)值為0，表示按照畫面的原始尺寸進(jìn)行顯示。
  • 若采用自適應(yīng)方式，該字段必傳且大于0，表示填充區(qū)（框）寬度歸一化比例值。
VideoLayer.N.PositionRefer String 否 topLeft

元素的位置參考坐標(biāo)值。 取值：

  • topLeft（默認(rèn)值）：左上。
  • topRight：右上。
  • bottomLeft：左下。
  • bottomRight：右下。
  • center：中間。
  • topCenter：中上。
  • bottomCenter：中下。
  • leftCenter：左中。
  • rightCenter：右中。
VideoLayer.N.PositionNormalized.N RepeatList 否 [0,3]

視頻元素配置列表，元素為視頻畫面的配置信息：位置。

設(shè)置該視頻元素的位置歸一化值[x,y], 默認(rèn)為[0,0]。注意x,y需要進(jìn)行歸一化計算。

VideoLayer.N.FixedDelayDuration Integer 否 5000

該字段對視頻進(jìn)行固定延遲設(shè)置，可用于字幕同步。 單位：毫秒。 默認(rèn)值：0 。取值范圍：0~5000。

AudioLayer.N.VolumeRate Float 否 1.0

調(diào)節(jié)音頻流的音量大小倍數(shù)。 取值范圍為0~10.0。其中：

  • 1.0（默認(rèn)值）：表示保持原有音量。
  • 小于1：表示降低音量的倍數(shù)。
  • 大于1：表示放大的倍數(shù)。
AudioLayer.N.ValidChannel String 否 all

確定哪些聲道可以作為音量輸入。 取值：

  • leftChannel：左聲道。
  • rightChannel：右聲道。
  • all（默認(rèn)值）：雙聲道。
AudioLayer.N.FixedDelayDuration Integer 否 5000

對音頻進(jìn)行固定延遲設(shè)置，可用于字幕同步。 單位：毫秒。 默認(rèn)值：0 。取值范圍：0~5000。

說明 請求參數(shù)中的N表示第幾個的意思。例如：VideoLayer.N.FillMode表示傳入第幾個元素的填充方式。VideoLayer.1.FillMode表示傳入第1個元素的填充方式，VideoLayer.2.FillMode表示傳入第2個元素的填充方式。

返回數(shù)據(jù)

名稱 類型 示例值 描述
RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

請求ID。
LayoutId String 21926b36-7dd2-4fde-ae25-51b5bc8e****

布局ID。可作為刪除導(dǎo)播臺布局，修改導(dǎo)播臺布局，查詢導(dǎo)播臺布局列表，刪除虛擬演播廳布局，修改虛擬演播廳布局，查詢虛擬演播廳布局的請求參數(shù)。

示例

請求示例

http(s)://live.aliyuncs.com/?Action=AddCasterLayout
&BlendList.1=RV01
&CasterId=LIVEPRODUCER_POST-cn-0pp1czt****
&MixList.1=RV01
&<公共請求參數(shù)>

正常返回示例

XML格式 

<AddCasterLayoutResponse>
	  <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
	  <LayoutId>21926b36-7dd2-4fde-ae25-51b5bc8e****</LayoutId>
</AddCasterLayoutResponse>

JSON格式 

{
    "AddCasterLayoutResponse": {
        "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
        "LayoutId": "21926b36-7dd2-4fde-ae25-51b5bc8e****"
    }
}

錯誤碼

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