調用UpdateMPUTask更新旁路轉推任務。

使用說明

  • 調用本接口前，您必須已經調用StartMpuTask開始旁路轉推任務。
  • 本接口需要在任務運行正常時調用，任務未開始、已結束或異常狀態調用都無效。您可以調用GetMPUTaskStatus獲取任務運行狀態。

QPS限制

本接口的單用戶QPS限制為4000次/分鐘。超過限制，API調用會被限流，這可能會影響您的業務，請合理調用。更多信息，請參見QPS限制。

調試

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

請求參數

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

系統規定參數。取值：UpdateMPUTask。

AppId String 是 yourAppId

應用ID，僅支持傳單個ID。

可通過控制臺創建和查詢。
TaskId String 是 testId

任務ID，僅支持傳單個ID，和StartMpuTask中入參TaskId一致。

CropMode Integer 否 1

視頻的裁剪模式。取值：

  • 1：保持比例裁剪。
  • 2（默認值）：保持比例留邊。
MediaEncode Integer 否 2

編碼選項，請參見下文中的MediaEncode枚舉值。
MixMode Integer 否 0

混流模式。取值：

  • 0：單路轉推，不混流轉碼，僅轉推原始單路流，無需配置混流轉碼參數。
  • 1：混流轉碼（默認值），支持混流轉碼輸出。
說明
  • 單路轉推模式下有效參數：StreamType、SourceType。
  • 混流轉碼模式下有效參數：MediaEncode、LayoutIds、BackgroundColor、SubSpecUsers、CropMode、UserPanes、Backgrounds、Watermarks。
SourceType String 否 camera

單路轉推模式下用戶視頻輸入流。取值：

  • camera：攝像頭。
  • shareScreen：屏幕共享。
StreamType Integer 否 0

單路轉推模式下轉推音頻流。取值：

  • 0（默認值）：轉推原始流。
  • 1：僅轉推音頻流。
  • 2：僅轉推視頻流。
BackgroundColor Integer 否 0

背景色RGB，默認是0（黑色）。

計算公式為R + G × 256 + B × 65536，R（紅）、G（綠）、B（藍）的取值：0~255。

LayoutIds.N Long 否 1

布局ID數據，用戶可在一次任務中指定多個布局，系統會根據當時channel（頻道）中的人數進行切換。詳情請參見布局。

SubSpecUsers.N String 否 userID

指定該任務訂閱的用戶列表，默認訂閱頻道內全部用戶，數組下標取值范圍：1～16。

說明 數組下標需要從1開始并從小到大，不能中斷，要連續。
SubSpecAudioUsers.N String 否 audioUserID

指定訂閱房間里哪些用戶音頻流（輸入allStream表示混所有人音頻）。數組下標取值范圍：1～64。

說明 數組下標需要從1開始并從小到大，不能中斷，要連續。
SubSpecShareScreenUsers.N String 否 videoUserID

指定訂閱房間里哪些用戶共享視頻流（輸入allStream表示混所有人共享視頻）。數組下標取值范圍：1～64。

說明 數組下標需要從1開始并從小到大，不能中斷，要連續。
SubSpecCameraUsers.N String 否 cameraUserID

指定訂閱房間里哪些用戶攝像頭視頻流（輸入allStream表示混所有人攝像頭視頻）。數組下標取值范圍：1～64。

說明 數組下標需要從1開始并從小到大，不能中斷，要連續。
UnsubSpecAudioUsers.N String 否 audioUserID2

指定不訂閱房間里哪些用戶音頻流（輸入allStream表示不混所有人音頻）。數組下標取值范圍：1～64。

說明 數組下標需要從1開始并從小到大，不能中斷，要連續。
UnsubSpecShareScreenUsers.N String 否 videoUserID2

指定不訂閱房間里哪些用戶共享視頻流（輸入allStream表示不混所有人共享視頻）。數組下標取值范圍：1～64。

說明 數組下標需要從1開始并從小到大，不能中斷，要連續。
UnsubSpecCameraUsers.N String 否 cameraUserID2

指定不訂閱房間里哪些用戶攝像頭視頻流（輸入allStream表示不混所有人攝像頭視頻）。數組下標取值范圍：1～64。

說明 數組下標需要從1開始并從小到大，不能中斷，要連續。
UserPanes.N.Images.N.Width Float 否 0.2456

窗格寬，歸一化百分比。
UserPanes.N.Images.N.Height Float 否 0.2456

窗格高，歸一化百分比。
UserPanes.N.Images.N.Y Float 否 0.7576

坐標Y，歸一化百分比。
UserPanes.N.Images.N.Url String 否 https://www.example.com/image.jpg

圖片的HTTP或HTTPS地址。
UserPanes.N.Images.N.Display Integer 否 1

圖片顯示，取值：

  • 0（None）：不顯示。
  • 1（Always）：總是顯示。
  • 2（Backup）：當前用戶無視頻流時顯示。
UserPanes.N.Images.N.ZOrder Integer 否 0

疊放順序，0為最底層，1層在0層之上，以此類推。
UserPanes.N.Images.N.X Float 否 0.7576

坐標X，歸一化百分比。
UserPanes.N.SegmentType Integer 否 0

人像分割類型。取值：

  • 0：無人像分割（默認值）。
  • 1：人像分割，僅在開啟增強參數（人像分割功能）后有效。
UserPanes.N.UserId String 否 TestUserID

對應布局窗格的用戶ID，取值：1~16。

UserPanes.N.Texts.N.FontType Integer 否 0

字體類型，取值：

  • 0（默認值）：NOTO_SERIF_CJKSC_REGULAR
  • 1：ALIBABA_PUHUITI_REGULAR
  • 2：ALIBABA_PUHUITI_BOLD
  • 3：ALIBABA_PUHUITI_Heavy
  • 4：ALIBABA_PUHUITI_LIGHT
  • 5：ALIBABA_PUHUITI_MEDIUM
UserPanes.N.Texts.N.FontColor Integer 否 0

文字顏色（RGB）。

計算公式為R + G × 256 + B × 65536，R（紅）、G（綠）、B（藍）的取值：0~255。

UserPanes.N.Texts.N.Y Float 否 0.7576

坐標Y，歸一化百分比。
UserPanes.N.Texts.N.Text String 否 text

文本內容。
UserPanes.N.Texts.N.ZOrder Integer 否 0

疊放順序，0為最底層，1層在0層之上，以此類推。
UserPanes.N.Texts.N.X Float 否 0.7576

坐標X，歸一化百分比。
UserPanes.N.Texts.N.FontSize Integer 否 1

字體大小，取值范圍：0~72。

UserPanes.N.Texts.N.BorderWidth Integer 否 1

文字描邊寬度（單位：像素），默認為0。
UserPanes.N.Texts.N.BorderColor Long 否 0

文字描邊顏色。

計算公式為R + G × 256 + B × 65536，R（紅）、G（綠）、B（藍）的取值：0~255。

UserPanes.N.Texts.N.Box Boolean 否 false

是否出現文字框。取值：

  • false（默認值）：不出現。
  • true：出現。
UserPanes.N.Texts.N.BoxColor Long 否 0

文字框顏色。

計算公式為R + G × 256 + B × 65536，R（紅）、G（綠）、B（藍）的取值：0~255。

UserPanes.N.Texts.N.BoxBorderWidth Integer 否 0

文字框寬度（單位：像素），默認為0。
UserPanes.N.Texts.N.Alpha Float 否 0

文字框和文字透明度。0.0表示透明，1.0表示完全不透明。
UserPanes.N.SourceType String 否 camera

對應布局的用戶視頻輸入，取值：

  • camera：相機流。
  • shareScreen：共享屏幕流。
UserPanes.N.PaneId Integer 否 2

窗格ID，取值范圍：0~15。

Backgrounds.N.Width Float 否 0.2456

窗格寬，歸一化百分比。
Backgrounds.N.Height Float 否 0.2456

窗格高，歸一化百分比。
Backgrounds.N.Y Float 否 0.7576

坐標Y，歸一化百分比。
Backgrounds.N.Url String 否 https://www.example.com/image.jpg

圖片的HTTP或HTTPS地址。
Backgrounds.N.Display Integer 否 1

圖片顯示，取值：

  • 0（None）：不顯示。
  • 1（Always）：總是顯示。
Backgrounds.N.ZOrder Integer 否 0

疊放順序，0為最底層，1層在0層之上，以此類推。
Backgrounds.N.X Float 否 0.7576

坐標X，歸一化百分比。
Watermarks.N.Alpha Float 否 0

透明度。0.0表示透明，1.0表示完全不透明。
Watermarks.N.Width Float 否 0.2456

窗格寬，歸一化百分比。
Watermarks.N.Height Float 否 0.2456

窗格高，歸一化百分比。
Watermarks.N.Y Float 否 0.7576

坐標Y，歸一化百分比。
Watermarks.N.Url String 否 https://www.example.com/image.jpg

圖片的HTTP或HTTPS地址。
Watermarks.N.Display Integer 否 1

圖片顯示，取值：

  • 0（None）：不顯示。
  • 1（Always）：總是顯示。
Watermarks.N.ZOrder Integer 否 0

疊放順序，0為最底層，1層在0層之上，以此類推。
Watermarks.N.X Float 否 0.7576

坐標X，歸一化百分比。
ClockWidgets.N.FontType Integer 否 0

字體類型，取值：

  • 0（默認值）：NOTO_SERIF_CJKSC_REGULAR
  • 1：ALIBABA_PUHUITI_REGULAR
  • 2：ALIBABA_PUHUITI_BOLD
  • 3：ALIBABA_PUHUITI_Heavy
  • 4：ALIBABA_PUHUITI_LIGHT
  • 5：ALIBABA_PUHUITI_MEDIUM
ClockWidgets.N.FontColor Integer 否 0

文字顏色（RGB）。

計算公式為R + G × 256 + B × 65536，R（紅）、G（綠）、B（藍）的取值：0~255。

ClockWidgets.N.Y Float 否 0.7576

坐標Y，歸一化百分比。
ClockWidgets.N.ZOrder Integer 否 0

疊放順序，0為最底層，1層在0層之上，以此類推。
ClockWidgets.N.X Float 否 0.7576

坐標X，歸一化百分比。
ClockWidgets.N.FontSize Integer 否 1

字體大小，取值范圍：0~72。

ClockWidgets.N.BorderWidth Integer 否 1

文字描邊寬度（單位：像素），默認為0。
ClockWidgets.N.BorderColor Long 否 0

文字描邊顏色。

計算公式為R + G × 256 + B × 65536，R（紅）、G（綠）、B（藍）的取值：0~255。

ClockWidgets.N.Box Boolean 否 false

是否出現文字框。取值：

  • false（默認值）：不出現。
  • true：出現。
ClockWidgets.N.BoxColor Long 否 0

文字框顏色。

計算公式為R + G × 256 + B × 65536，R（紅）、G（綠）、B（藍）的取值：0~255。

ClockWidgets.N.BoxBorderWidth Integer 否 0

文字框寬度（單位：像素），默認為0。
ClockWidgets.N.Alpha Float 否 0

文字框和文字透明度。0.0表示透明，1.0表示完全不透明。

MediaEncode枚舉值如下所示。

ID

寬

高

碼流（kps）

幀率（fps）

0

0

0

64

0

1

640

360

500

15

54

360

640

500

30

53

360

640

500

15

52

640

360

500

30

10

960

540

700

24

20

1280

720

1024

25

22

720

1280

1024

30

23

800

600

1024

30

30

1920

1080

2048

30

31

1080

1920

2048

30

24

750

780

1024

30

25

750

540

700

30

26

720

1280

2048

30

27

1280

720

2048

30

28

1280

720

3096

30

32

1024

768

1024

24

33

1280

960

1024

24

34

1024

768

2048

24

35

1280

960

2048

24

36

1280

720

1024

24

37

1280

720

2048

24

38

540

960

750

15

39

540

960

1500

30

40

1280

720

1200

15

41

720

1280

1200

15

42

720

1280

1500

15

43

540

960

1200

15

說明 當用戶使用純音頻直播的時候需要注意的問題，然后直接跳轉常見問題中的純音頻直播。

返回數據

名稱 類型 示例值 描述
RequestId String 760bad53276431c499e30dc36f6b26be

請求ID。

示例

請求示例

https://rtc.aliyuncs.com/?Action=UpdateMPUTask
&AppId=yourAppId
&TaskId=testId
&BackgroundColor=0
&LayoutIds.1=2
&UserPanes.1.PaneId=2
&UserPanes.1.UserId=TestUserID
&UserPanes.1.SourceType=camera
&<公共請求參數>

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateMPUTaskResponse>
    <RequestId>760bad53276431c499e30dc36f6b26be</RequestId>
</UpdateMPUTaskResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "760bad53276431c499e30dc36f6b26be"
}